Connector Functions

ConnectorFunctions

ConnectorFunctions Objects

class ConnectorFunctions()

This is a base object that contains all you can do about ConnectorFunctions.

constructor

function constructor()

Constructor

Arguments:

• Reference InternalOpenGateAPI - to the API object.

addSouthCriteria

function addSouthCriteria(criteria: *) -> '*'

Arguments:

• criteria *

Returns:

• *

create

function create() -> 'Promise'

Create a new Connector Function

Returns:

• Promise

delete

function delete() -> 'Promise'

Deletes the selected connector function

Returns:

• Promise

update

function update() -> 'Promise'

Updates a connector function

Returns:

• Promise

withChannel

function withChannel(channel: string) -> 'ConnectorFunctions'

Set the channel attribute

Arguments:

• channel string - required field

Returns:

• ConnectorFunctions

withDescription

function withDescription(description: string) -> 'ConnectorFunctions'

Set the description attribute

Arguments:

• description string

Returns:

• ConnectorFunctions

withIdentifier

function withIdentifier(identifier: string) -> 'ConnectorFunctions'

Set the identifier attribute

Arguments:

• identifier string - required field

Returns:

• ConnectorFunctions

withJavascript

function withJavascript(javascript: string) -> 'ConnectorFunctions'

Set the javascript attribute

Arguments:

• javascript string

Returns:

• ConnectorFunctions

withName

function withName(name: string) -> 'ConnectorFunctions'

Set the name attribute

Arguments:

• name string - required field

Returns:

• ConnectorFunctions

withNorthCriterias

function withNorthCriterias(criterias: array) -> 'ConnectorFunctions'

Set the north criterias attribute

Arguments:

• criterias array

Returns:

• ConnectorFunctions

withOperationalStatus

function withOperationalStatus(operationalStatus: boolean) -> 'ConnectorFunctions'

Set the operational status attribute

Arguments:

• operationalStatus boolean

Returns:

• ConnectorFunctions

withOperationName

function withOperationName(operationName: string) -> 'ConnectorFunctions'

Set the operation name attribute

Arguments:

• operationName string - required field

Returns:

• ConnectorFunctions

withOrganization

function withOrganization(organization: string) -> 'ConnectorFunctions'

Set the organization attribute

Arguments:

• organization string - required field

Returns:

• ConnectorFunctions

withPayloadType

function withPayloadType(payloadType: string) -> 'ConnectorFunctions'

Set the payload type attribute

Arguments:

• payloadType string

Returns:

• ConnectorFunctions

withSouthCriterias

function withSouthCriterias(criterias: array) -> 'ConnectorFunctions'

Set the south criterias attribute

Arguments:

• criterias array

Returns:

• ConnectorFunctions

withType

function withType(type: string) -> 'ConnectorFunctions'

Set the type attribute

Arguments:

• type string

Returns:

• ConnectorFunctions