import ConnectorFunctions from 'opengate-js/src/connectorsFunctions/configuration/ConnectorFunctions.js'

public class | source

ConnectorFunctions

Extends:

BaseProvision → ConnectorFunctions

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

Constructor Summary

Public Constructor
public	constructor(Reference: InternalOpenGateAPI) Constructor

Method Summary

Public Methods
public	addSouthCriteria(criteria: ):
public	create(): Promise Create a new Connector Function
public	delete(): Promise Deletes the selected connector function
public	update(): Promise Updates a connector function
public	withChannel(channel: string): ConnectorFunctions Set the channel attribute
public	withDescription(description: string): ConnectorFunctions Set the description attribute
public	withIdentifier(identifier: string): ConnectorFunctions Set the identifier attribute
public	withJavascript(javascript: string): ConnectorFunctions Set the javascript attribute
public	withName(name: string): ConnectorFunctions Set the name attribute
public	withNorthCriterias(criterias: array): ConnectorFunctions Set the north criterias attribute
public	withOperationName(operationName: string): ConnectorFunctions Set the operation name attribute
public	withOperationalStatus(operationalStatus: boolean): ConnectorFunctions Set the operational status attribute
public	withOrganization(organization: string): ConnectorFunctions Set the organization attribute
public	withPayloadType(payloadType: string): ConnectorFunctions Set the payload type attribute
public	withSouthCriterias(criterias: array): ConnectorFunctions Set the south criterias attribute
public	withType(type: string): ConnectorFunctions Set the type attribute

Inherited Summary

From class BaseProvision
public	create(): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function create a entity of provision
public	delete(body: *): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function deletes a entity of provision
public	update(): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function updates a entity of provision

Public Constructors

public constructor(Reference: InternalOpenGateAPI) source

Constructor

Override:

BaseProvision#constructor

Params:

Name	Type	Attribute	Description
Reference	InternalOpenGateAPI		to the API object.

Public Methods

public addSouthCriteria(criteria: ): source

Params:

Name	Type	Attribute	Description
criteria	*

Return:

public create(): Promise source

Create a new Connector Function

public delete(): Promise source

Deletes the selected connector function

Override:

BaseProvision#delete

Return:

Promise

Throw:

Error

public update(): Promise source

Updates a connector function

Override:

BaseProvision#update

Return:

Promise

Throw:

Error

public withChannel(channel: string): ConnectorFunctions source

Set the channel attribute

Params:

Name	Type	Attribute	Description
channel	string		required field

Return:

ConnectorFunctions

public withDescription(description: string): ConnectorFunctions source

Set the description attribute

Params:

Name	Type	Attribute	Description
description	string

Return:

ConnectorFunctions

public withIdentifier(identifier: string): ConnectorFunctions source

Set the identifier attribute

Params:

Name	Type	Attribute	Description
identifier	string		required field

Return:

ConnectorFunctions

public withJavascript(javascript: string): ConnectorFunctions source

Set the javascript attribute

Params:

Name	Type	Attribute	Description
javascript	string

Return:

ConnectorFunctions

public withName(name: string): ConnectorFunctions source

Set the name attribute

Params:

Name	Type	Attribute	Description
name	string		required field

Return:

ConnectorFunctions

public withNorthCriterias(criterias: array): ConnectorFunctions source

Set the north criterias attribute

Params:

Name	Type	Attribute	Description
criterias	array

Return:

ConnectorFunctions

public withOperationName(operationName: string): ConnectorFunctions source

Set the operation name attribute

Params:

Name	Type	Attribute	Description
operationName	string		required field

Return:

ConnectorFunctions

public withOperationalStatus(operationalStatus: boolean): ConnectorFunctions source

Set the operational status attribute

Params:

Name	Type	Attribute	Description
operationalStatus	boolean

Return:

ConnectorFunctions

public withOrganization(organization: string): ConnectorFunctions source

Set the organization attribute

Params:

Name	Type	Attribute	Description
organization	string		required field

Return:

ConnectorFunctions

public withPayloadType(payloadType: string): ConnectorFunctions source

Set the payload type attribute

Params:

Name	Type	Attribute	Description
payloadType	string

Return:

ConnectorFunctions

public withSouthCriterias(criterias: array): ConnectorFunctions source

Set the south criterias attribute

Params:

Name	Type	Attribute	Description
criterias	array

Return:

ConnectorFunctions

public withType(type: string): ConnectorFunctions source

Set the type attribute

Params:

Name	Type	Attribute	Description
type	string

Return:

ConnectorFunctions

ConnectorFunctions

Extends:

Constructor Summary

Method Summary

Inherited Summary

Public Constructors

public constructor(Reference: InternalOpenGateAPI) source

Override:

Params:

Public Methods

public addSouthCriteria(criteria: *): * source

Params:

Return:

public create(): Promise source

Override:

Return:

Throw:

public delete(): Promise source

Override:

Return:

Throw:

public update(): Promise source

Override:

Return:

Throw:

public withChannel(channel: string): ConnectorFunctions source

Params:

Return:

public withDescription(description: string): ConnectorFunctions source

Params:

Return:

public withIdentifier(identifier: string): ConnectorFunctions source

Params:

Return:

public withJavascript(javascript: string): ConnectorFunctions source

Params:

Return:

public withName(name: string): ConnectorFunctions source

Params:

Return:

public withNorthCriterias(criterias: array): ConnectorFunctions source

Params:

Return:

public withOperationName(operationName: string): ConnectorFunctions source

Params:

Return:

public withOperationalStatus(operationalStatus: boolean): ConnectorFunctions source

Params:

Return:

public withOrganization(organization: string): ConnectorFunctions source

Params:

Return:

public withPayloadType(payloadType: string): ConnectorFunctions source

Params:

Return:

public withSouthCriterias(criterias: array): ConnectorFunctions source

Params:

Return:

public withType(type: string): ConnectorFunctions source

Params:

Return:

public addSouthCriteria(criteria: ): source