◆ JavaScriptBuilderElementBuilder()
| FiftyOne.Pipeline.JavaScriptBuilder.FlowElement.JavaScriptBuilderElementBuilder.JavaScriptBuilderElementBuilder | ( | ILoggerFactory | loggerFactory | ) |
Constructor.
- Parameters
-
- loggerFactory - The logger factory.
Member Function Documentation
◆ Build()
virtual JavaScriptBuilderElement FiftyOne.Pipeline.JavaScriptBuilder.FlowElement.JavaScriptBuilderElementBuilder.Build ( ) virtualBuild 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 /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
NUglifypackage 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 ) The default name of the object instantiated by the client JavaScript.
- Parameters
-
- objName -
- Returns
◆ 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 protectedLogger 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 protectedIf 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 protectedThe 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 protectedThe host name to use when creating a callback URL.
◆ Logger
ILogger FiftyOne.Pipeline.JavaScriptBuilder.FlowElement.JavaScriptBuilderElementBuilder.Logger get protectedThe logger for this instance.
◆ Minify
bool FiftyOne.Pipeline.JavaScriptBuilder.FlowElement.JavaScriptBuilderElementBuilder.Minify = Constants.BUILDER_DEFAULT_MINIFY get protectedIf set to true, the JavaScript output will be minified
◆ ObjName
string FiftyOne.Pipeline.JavaScriptBuilder.FlowElement.JavaScriptBuilderElementBuilder.ObjName = Constants.BUILDER_DEFAULT_OBJECT_NAME get protectedThe name of the JavaScript object that will be created.
◆ Protocol
string FiftyOne.Pipeline.JavaScriptBuilder.FlowElement.JavaScriptBuilderElementBuilder.Protocol = Constants.BUILDER_DEFAULT_PROTOCOL get protectedThe protocol to use when creating a callback URL.