◆ JavaScriptBuilderElementBuilder()
| FiftyOne.Pipeline.JavaScriptBuilder.FlowElement.JavaScriptBuilderElementBuilder.JavaScriptBuilderElementBuilder | ( | ILoggerFactory | loggerFactory | ) |
Constructor.
- Parameters
-
- loggerFactory - The logger factory.
Detailed Description
Builder for the JavaScriptBuilderElement See the Specification
Public Member Functions
| JavaScriptBuilderElementBuilder (ILoggerFactory loggerFactory)
Constructor. More...
| |
| JavaScriptBuilderElementBuilder | SetEnableCookies (bool enableCookies)
Set whether the client JavaScript stored results of client side processing in cookies. More...
|
| JavaScriptBuilderElementBuilder | SetHost (string host)
Set the host that the client JavaScript should query for updates. More...
|
| JavaScriptBuilderElementBuilder | SetEndpoint (string endpoint)
Set the endpoint which will be queried on the host. More...
|
| JavaScriptBuilderElementBuilder | SetProtocol (string protocol)
The protocol that the client JavaScript will use when querying for updates. More...
|
| JavaScriptBuilderElementBuilder | SetObjectName (string objName)
The default name of the object instantiated by the client JavaScript. More...
|
| JavaScriptBuilderElementBuilder | SetMinify (bool minify)
Enable or disable minification of the JavaScript that is produced by the JavaScriptBuilderElement. More...
|
| virtual JavaScriptBuilderElement | Build ()
Build the element. More...
|
Protected Attributes
| ILoggerFactory | _loggerFactory
Logger factory that may be reused in descendants to produce a distinct logger. More...
|
Properties
| ILogger | Logger [get]
The logger for this instance. More...
|
| string | Host = Constants.BUILDER_DEFAULT_HOST [get]
The host name to use when creating a callback URL. More...
|
| string | Endpoint = Constants.BUILDER_DEFAULT_ENDPOINT [get]
The end point (i.e. More...
|
| string | Protocol = Constants.BUILDER_DEFAULT_PROTOCOL [get]
The protocol to use when creating a callback URL. More...
|
| string | ObjName = Constants.BUILDER_DEFAULT_OBJECT_NAME [get]
The name of the JavaScript object that will be created. More...
|
| bool | EnableCookies = Constants.BUILDER_DEFAULT_ENABLE_COOKIES [get]
If set to false, the JavaScript will not populateany cookies, and will instead use session storage. More...
|
| bool | Minify = Constants.BUILDER_DEFAULT_MINIFY [get]
If set to true, the JavaScript output will be minified More...
|
Constructor & Destructor Documentation
Member Function Documentation
◆ Build()
| virtual JavaScriptBuilderElement FiftyOne.Pipeline.JavaScriptBuilder.FlowElement.JavaScriptBuilderElementBuilder.Build | ( | ) |
virtual
Build the element.
- Returns
◆ SetEnableCookies()
| JavaScriptBuilderElementBuilder FiftyOne.Pipeline.JavaScriptBuilder.FlowElement.JavaScriptBuilderElementBuilder.SetEnableCookies | ( | bool | enableCookies | ) |
Set whether the client JavaScript stored results of client side processing in cookies.
This can also be set per request, using the "query.fod-js-enable-cookies" evidence key. For more details on personal data policy, see http://51degrees.com/terms/client-services-privacy-policy/
- Parameters
-
- enableCookies - Should enable cookies?
- Returns
◆ SetEndpoint()
| JavaScriptBuilderElementBuilder FiftyOne.Pipeline.JavaScriptBuilder.FlowElement.JavaScriptBuilderElementBuilder.SetEndpoint | ( | string | endpoint | ) |
Set the endpoint which will be queried on the host.
e.g /api/v4/json
- Parameters
-
- endpoint - The endpoint.
- Returns
◆ SetHost()
| JavaScriptBuilderElementBuilder FiftyOne.Pipeline.JavaScriptBuilder.FlowElement.JavaScriptBuilderElementBuilder.SetHost | ( | string | host | ) |
Set the host that the client JavaScript should query for updates.
By default, the host from the request will be used.
- Parameters
-
- host - The host name.
- Returns
◆ SetMinify()
| JavaScriptBuilderElementBuilder FiftyOne.Pipeline.JavaScriptBuilder.FlowElement.JavaScriptBuilderElementBuilder.SetMinify | ( | bool | minify | ) |
Enable or disable minification of the JavaScript that is produced by the JavaScriptBuilderElement.
The
NUglify
package is used to minify the output.
- Parameters
-
- minify - True to minify the output. False to not.
- Returns
- This builder.
◆ SetObjectName()
| JavaScriptBuilderElementBuilder FiftyOne.Pipeline.JavaScriptBuilder.FlowElement.JavaScriptBuilderElementBuilder.SetObjectName | ( | string | objName | ) |
◆ SetProtocol()
| JavaScriptBuilderElementBuilder FiftyOne.Pipeline.JavaScriptBuilder.FlowElement.JavaScriptBuilderElementBuilder.SetProtocol | ( | string | protocol | ) |
The protocol that the client JavaScript will use when querying for updates.
By default, the protocol from the request will be used.
- Parameters
-
- protocol - The protocol to use (http / https)
- Returns
Member Data Documentation
◆ _loggerFactory
| ILoggerFactory FiftyOne.Pipeline.JavaScriptBuilder.FlowElement.JavaScriptBuilderElementBuilder._loggerFactory |
protected
Logger factory that may be reused in descendants to produce a distinct logger.
Property Documentation
◆ EnableCookies
| bool FiftyOne.Pipeline.JavaScriptBuilder.FlowElement.JavaScriptBuilderElementBuilder.EnableCookies = Constants.BUILDER_DEFAULT_ENABLE_COOKIES |
get
protected
If set to false, the JavaScript will not populateany cookies, and will instead use session storage.
◆ Endpoint
| string FiftyOne.Pipeline.JavaScriptBuilder.FlowElement.JavaScriptBuilderElementBuilder.Endpoint = Constants.BUILDER_DEFAULT_ENDPOINT |
get
protected
The end point (i.e.
the relative URL) to use when creating a callback URL.
◆ Host
| string FiftyOne.Pipeline.JavaScriptBuilder.FlowElement.JavaScriptBuilderElementBuilder.Host = Constants.BUILDER_DEFAULT_HOST |
get
protected
The host name to use when creating a callback URL.
◆ Logger
| ILogger FiftyOne.Pipeline.JavaScriptBuilder.FlowElement.JavaScriptBuilderElementBuilder.Logger |
get
protected
The logger for this instance.
◆ Minify
| bool FiftyOne.Pipeline.JavaScriptBuilder.FlowElement.JavaScriptBuilderElementBuilder.Minify = Constants.BUILDER_DEFAULT_MINIFY |
get
protected
If set to true, the JavaScript output will be minified
◆ ObjName
| string FiftyOne.Pipeline.JavaScriptBuilder.FlowElement.JavaScriptBuilderElementBuilder.ObjName = Constants.BUILDER_DEFAULT_OBJECT_NAME |
get
protected
The name of the JavaScript object that will be created.
◆ Protocol
| string FiftyOne.Pipeline.JavaScriptBuilder.FlowElement.JavaScriptBuilderElementBuilder.Protocol = Constants.BUILDER_DEFAULT_PROTOCOL |
get
protected
The protocol to use when creating a callback URL.