Detailed Description
Builder for the JavaScriptBuilderElement See the Specification
.
Public Member Functions | |
| JavaScriptBuilderElementBuilder (ILoggerFactory loggerFactory) | |
| Constructor. | |
| JavaScriptBuilderElementBuilder | SetEnableCookies (bool enableCookies) |
| Set whether the client JavaScript stored results of client side processing in cookies. | |
| JavaScriptBuilderElementBuilder | SetHost (string host) |
| Set the host that the client JavaScript should query for updates. | |
| JavaScriptBuilderElementBuilder | SetEndpoint (string endpoint) |
| Set the endpoint which will be queried on the host. | |
| JavaScriptBuilderElementBuilder | SetProtocol (string protocol) |
| The protocol that the client JavaScript will use when querying for updates. | |
| JavaScriptBuilderElementBuilder | SetObjectName (string objName) |
| The default name of the object instantiated by the client JavaScript. | |
| JavaScriptBuilderElementBuilder | SetMinify (bool minify) |
| Enable or disable minification of the JavaScript that is produced by the JavaScriptBuilderElement. | |
| virtual JavaScriptBuilderElement | Build () |
| Build the element. | |
Protected Attributes | |
| ILoggerFactory | _loggerFactory |
| Logger factory that may be reused in descendants to produce a distinct logger. | |
Properties | |
| ILogger | Logger [get] |
| The logger for this instance. | |
| string | Host = Constants.BUILDER_DEFAULT_HOST [get] |
| The host name to use when creating a callback URL. | |
| string | Endpoint = Constants.BUILDER_DEFAULT_ENDPOINT [get] |
| The end point (i.e. | |
| string | Protocol = Constants.BUILDER_DEFAULT_PROTOCOL [get] |
| The protocol to use when creating a callback URL. | |
| string | ObjName = Constants.BUILDER_DEFAULT_OBJECT_NAME [get] |
| The name of the JavaScript object that will be created. | |
| bool | EnableCookies = Constants.BUILDER_DEFAULT_ENABLE_COOKIES [get] |
| If set to false, the JavaScript will not populateany cookies, and will instead use session storage. | |
| bool | Minify = Constants.BUILDER_DEFAULT_MINIFY [get] |
| If set to true, the JavaScript output will be minified. | |
Constructor & Destructor Documentation
◆ JavaScriptBuilderElementBuilder()
| FiftyOne.Pipeline.JavaScriptBuilder.FlowElement.JavaScriptBuilderElementBuilder.JavaScriptBuilderElementBuilder | ( | ILoggerFactory | loggerFactory | ) |
Constructor.
- Parameters
-
loggerFactory The logger factory.
Member Function Documentation
◆ 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 /terms/client-services-privacy-policy/?utm_source=code&utm_medium=comment&utm_campaign=pipeline-dotnet&utm_content=fiftyone.pipeline.elements-fiftyone.pipeline.javascriptbuilderelement-flowelement-javascriptbuilderelementbuilder.cs&utm_term=setenablecookies
- 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
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
Property Documentation
◆ Endpoint
|
getprotected |
The end point (i.e.
the relative URL) to use when creating a callback URL.