Detailed Description

Builder for the JavaScriptBuilderElement

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...

Properties

ILogger	Logger `[get]` The logger for this instance. More...
string	Host = string.Empty `[get]` The host name to use when creating a callback URL. More...
string	Endpoint = string.Empty `[get]` The end point (i.e. More...
string	Protocol = string.Empty `[get]` The protocol to use when creating a callback URL. More...
string	ObjName = string.Empty `[get]` The name of the JavaScript object that will be created. More...
bool	EnableCookies `[get]` If set to false, the JavaScript will automatically delete any cookies prefixed with 51D_ More...
bool	Minify = true `[get]` If set to true, the JavaScript output will be minified More...

Constructor & Destructor Documentation

◆ 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

(

)

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.

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

)

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

Property Documentation

◆ EnableCookies

bool FiftyOne.Pipeline.JavaScriptBuilder.FlowElement.JavaScriptBuilderElementBuilder.EnableCookies

get protected

If set to false, the JavaScript will automatically delete any cookies prefixed with 51D_

◆ Endpoint

string FiftyOne.Pipeline.JavaScriptBuilder.FlowElement.JavaScriptBuilderElementBuilder.Endpoint = string.Empty

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 = string.Empty

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 = true

get protected

If set to true, the JavaScript output will be minified

◆ ObjName

string FiftyOne.Pipeline.JavaScriptBuilder.FlowElement.JavaScriptBuilderElementBuilder.ObjName = string.Empty

get protected

The name of the JavaScript object that will be created.

◆ Protocol

string FiftyOne.Pipeline.JavaScriptBuilder.FlowElement.JavaScriptBuilderElementBuilder.Protocol = string.Empty

get protected

The protocol to use when creating a callback URL.

51Degrees Pipeline .NET 4.2

FiftyOne.Pipeline.JavaScriptBuilder.FlowElement.JavaScriptBuilderElementBuilder Class Reference

Detailed Description

Public Member Functions

Properties

Constructor & Destructor Documentation

◆ JavaScriptBuilderElementBuilder()

Member Function Documentation

◆ Build()

◆ SetEnableCookies()

◆ SetEndpoint()

◆ SetHost()

◆ SetMinify()

◆ SetObjectName()

◆ SetProtocol()

Property Documentation

◆ EnableCookies

◆ Endpoint

◆ Host

◆ Logger

◆ Minify

◆ ObjName

◆ Protocol

On This Page