Connector Functions

ConnectorFunctions

ConnectorFunctions Objects

class ConnectorFunctions()

This is a base object than contains all you can about connector functions catalog

constructor
function constructor()

Constructor

Arguments:

  • ogapi InternalOpenGateAPI
  • identifier String
  • connectorFunction Object
addNorthCriteria
function addNorthCriteria(northCriteria: Object) -> 'ConnectorFunctionsCatalog'

Add northCriteria to parameter northCriterias. Each element is defined by path and value

Arguments:

  • northCriteria Object

Returns:

  • ConnectorFunctionsCatalog
addSouthCriteria
function addSouthCriteria(southCriteria: String) -> '*'

Add southCriteria to parameter southCriterias. Each string can represent an URI, topic, OID…

Arguments:

  • southCriteria String

Returns:

  • *
create
function create() -> 'Promise'

Create a new connector function catalog

Returns:

  • Promise
withCloneable
function withCloneable(cloneable: Boolean) -> 'ConnectorFunctionsCatalog'

Indicates whether or not the Connector Function is cloneable.

Arguments:

  • cloneable Boolean

Returns:

  • ConnectorFunctionsCatalog
withDescription
function withDescription(description: String) -> 'ConnectorFunctionsCatalog'

Description of the connector function. This field is optional.

Arguments:

  • description String

Returns:

  • ConnectorFunctionsCatalog
withIdentifier
function withIdentifier(identifier: String) -> 'ConnectorFunctionsCatalog'

Set the identifier

Arguments:

  • identifier String

Returns:

  • ConnectorFunctionsCatalog
withJavascript
function withJavascript(javascript: String) -> 'ConnectorFunctionsCatalog'

Connector function javascript code

Arguments:

  • javascript String

Returns:

  • ConnectorFunctionsCatalog
withName
function withName(name: String) -> 'ConnectorFunctionsCatalog'

Descriptive and unique name

Arguments:

  • name String

Returns:

  • ConnectorFunctionsCatalog
withNorthCriterias
function withNorthCriterias(northCriterias: Array) -> 'ConnectorFunctionsCatalog'

Connector Function selection criteria for operation requests. This field is mandatory if Connector Function type is REQUEST. ⮕ [ each element is defined by path and value ]

Arguments:

  • northCriterias Array

Returns:

  • ConnectorFunctionsCatalog
withOperationalStatus
function withOperationalStatus(operationalStatus: String) -> 'ConnectorFunctionsCatalog'

Connector Function status Allowed: DISABLED┃PRODUCTION┃TEST

Arguments:

  • operationalStatus String

Returns:

  • ConnectorFunctionsCatalog
withOperationName
function withOperationName(operationName: String) -> 'ConnectorFunctionsCatalog'

Used to filter connector functions by operation name. If Connector Function type is REQUEST, this field is mandatory and defined name must be an operation name available for specified Api Key. If the type is COLLECTION or RESPONSE, this field must be null.

Arguments:

  • operationName String

Returns:

  • ConnectorFunctionsCatalog
withPayloadType
function withPayloadType(payloadType: String) -> 'ConnectorFunctionsCatalog'

Enum of allowed types for connector function's payload data. Request Connector Functions only accept JSON. Allowed: TEXT┃JSON┃BINARY

Arguments:

  • payloadType String

Returns:

  • ConnectorFunctionsCatalog
withSouthCriterias
function withSouthCriterias(southCriterias: Array) -> 'ConnectorFunctionsCatalog'

Connector Function selection criteria for operation responses and data collection. This field is mandatory if Connector Function type is COLLECTION or RESPONSE. ⮕ [ each string can represent an URI, topic, OID… ]. Each string can represent an URI, topic, OID…

Arguments:

  • southCriterias Array

Returns:

  • ConnectorFunctionsCatalog
withType
function withType(type: String) -> 'ConnectorFunctionsCatalog'

Type of connector function, this is mandatory. Keep in mind that you will be not allowed to modify it. Allowed: COLLECTION┃REQUEST┃RESPONSE

Arguments:

  • type String

Returns:

  • ConnectorFunctionsCatalog