import ConnectorFunctions from 'opengate-js/src/connectorsFunctions/catalog/ConnectorFunctions.js'ConnectorFunctions
Extends:
This is a base object than contains all you can about connector functions catalog
Constructor Summary
| Public Constructor | ||
| public |
constructor(ogapi: InternalOpenGateAPI, identifier: String, connectorFunction: Object) Constructor |
|
Method Summary
| Public Methods | ||
| public |
addNorthCriteria(northCriteria: Object): ConnectorFunctionsCatalog Add northCriteria to parameter northCriterias. |
|
| public |
addSouthCriteria(southCriteria: String): * Add southCriteria to parameter southCriterias. |
|
| public |
Create a new connector function catalog |
|
| public |
withCloneable(cloneable: Boolean): ConnectorFunctionsCatalog Indicates whether or not the Connector Function is cloneable. |
|
| public |
withDescription(description: String): ConnectorFunctionsCatalog Description of the connector function. |
|
| public |
withIdentifier(identifier: String): ConnectorFunctionsCatalog Set the identifier |
|
| public |
withJavascript(javascript: String): ConnectorFunctionsCatalog Connector function javascript code |
|
| public |
withName(name: String): ConnectorFunctionsCatalog Descriptive and unique name |
|
| public |
withNorthCriterias(northCriterias: Array): ConnectorFunctionsCatalog Connector Function selection criteria for operation requests. |
|
| public |
withOperationName(operationName: String): ConnectorFunctionsCatalog Used to filter connector functions by operation name. |
|
| public |
withOperationalStatus(operationalStatus: String): ConnectorFunctionsCatalog Connector Function status Allowed: DISABLED┃PRODUCTION┃TEST |
|
| public |
withPayloadType(payloadType: String): ConnectorFunctionsCatalog Enum of allowed types for connector function's payload data. Request Connector Functions only accept JSON. Allowed: TEXT┃JSON┃BINARY |
|
| public |
withSouthCriterias(southCriterias: Array): ConnectorFunctionsCatalog Connector Function selection criteria for operation responses and data collection. |
|
| public |
withType(type: String): ConnectorFunctionsCatalog Type of connector function, this is mandatory. |
|
Inherited Summary
| From class BaseProvision | ||
| public |
This invoke a request to OpenGate North API and the callback is managed by promises This function create a entity of provision |
|
| public |
This invoke a request to OpenGate North API and the callback is managed by promises This function deletes a entity of provision |
|
| public |
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(ogapi: InternalOpenGateAPI, identifier: String, connectorFunction: Object) source
Constructor
Override:
BaseProvision#constructorParams:
| Name | Type | Attribute | Description |
| ogapi | InternalOpenGateAPI | ||
| identifier | String | ||
| connectorFunction | Object |
Public Methods
public addNorthCriteria(northCriteria: Object): ConnectorFunctionsCatalog source
Add northCriteria to parameter northCriterias. Each element is defined by path and value
Params:
| Name | Type | Attribute | Description |
| northCriteria | Object |
public addSouthCriteria(southCriteria: String): * source
Add southCriteria to parameter southCriterias. Each string can represent an URI, topic, OID...
Params:
| Name | Type | Attribute | Description |
| southCriteria | String |
Return:
| * |
public create(): Promise source
Create a new connector function catalog
Override:
BaseProvision#createThrow:
public withCloneable(cloneable: Boolean): ConnectorFunctionsCatalog source
Indicates whether or not the Connector Function is cloneable.
Params:
| Name | Type | Attribute | Description |
| cloneable | Boolean |
public withDescription(description: String): ConnectorFunctionsCatalog source
Description of the connector function. This field is optional.
Params:
| Name | Type | Attribute | Description |
| description | String |
public withIdentifier(identifier: String): ConnectorFunctionsCatalog source
Set the identifier
Params:
| Name | Type | Attribute | Description |
| identifier | String |
public withJavascript(javascript: String): ConnectorFunctionsCatalog source
Connector function javascript code
Params:
| Name | Type | Attribute | Description |
| javascript | String |
public withName(name: String): ConnectorFunctionsCatalog source
Descriptive and unique name
Params:
| Name | Type | Attribute | Description |
| name | String |
public withNorthCriterias(northCriterias: Array): ConnectorFunctionsCatalog source
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 ]
Params:
| Name | Type | Attribute | Description |
| northCriterias | Array |
public withOperationName(operationName: String): ConnectorFunctionsCatalog source
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.
Params:
| Name | Type | Attribute | Description |
| operationName | String |
public withOperationalStatus(operationalStatus: String): ConnectorFunctionsCatalog source
Connector Function status Allowed: DISABLED┃PRODUCTION┃TEST
Params:
| Name | Type | Attribute | Description |
| operationalStatus | String |
public withPayloadType(payloadType: String): ConnectorFunctionsCatalog source
Enum of allowed types for connector function's payload data. Request Connector Functions only accept JSON. Allowed: TEXT┃JSON┃BINARY
Params:
| Name | Type | Attribute | Description |
| payloadType | String |
public withSouthCriterias(southCriterias: Array): ConnectorFunctionsCatalog source
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...
Params:
| Name | Type | Attribute | Description |
| southCriterias | Array |
public withType(type: String): ConnectorFunctionsCatalog source
Type of connector function, this is mandatory. Keep in mind that you will be not allowed to modify it. Allowed: COLLECTION┃REQUEST┃RESPONSE
Params:
| Name | Type | Attribute | Description |
| type | String |