Operation Actions

OperationActions

OperationActions Objects

class OperationActions()
constructor
function constructor()

Constructor

Arguments:

  • ogapi InternalOpenGateAPI - this is configuration about Opengate North API.
  • operationId string - Identifier of the operation on which the action will be carried out
active
function active() -> 'Promise'

This invoke a request to OpenGate North API and the callback is managed by promises This function active an operation

Returns:

  • Promise

Example:

ogapi.newOperationActions("xxxxx-xxx-xxxx-xxxxx").active()
activePeriodicity
function activePeriodicity() -> 'Promise'

This invoke a request to OpenGate North API and the callback is managed by promises This function active periodicity of an operation

Returns:

  • Promise

Example:

ogapi.newOperationActions("xxxxx-xxx-xxxx-xxxxx").activePeriodicity()
cancel
function cancel() -> 'Promise'

This invoke a request to OpenGate North API and the callback is managed by promises This function cancela operation

Returns:

  • Promise

Example:

Actions("xxxxx-xxx-xxxx-xxxxx").cancel();
cancelPeriodicity
function cancelPeriodicity() -> 'Promise'

This invoke a request to OpenGate North API and the callback is managed by promises This function cancel the periodicity of an operation

Returns:

  • Promise

Example:

ogapi.OperationActions("xxxxx-xxx-xxxx-xxxxx").cancelPeriodicity();
changeCallback
function changeCallback(url: string) -> 'promise'

This invoke a request to OpenGate North API and the callback is managed by promises This function pauses (if it was active), updates the callback and passes the operation to the initial state (if activated, activated again)

Arguments:

  • url string

Returns:

  • promise

Example:

ogapi.OperationActions("xxxxx-xxx-xxxx-xxxxx").changeCallback("http://[your_application_address]/[your_URI]")
executeLater
function executeLater(minutes: number) -> 'promise'

This invoke a request to OpenGate North API and the callback is managed by promises This function pauses (if it was active), updates the delay and passes the operation to the initial state (if activated, activated again)

Arguments:

  • minutes number

Returns:

  • promise

Example:

ogapi.OperationActions("xxxxx-xxx-xxxx-xxxxx").executeLater(10)
executeNow
function executeNow() -> 'Promise'

This invoke a request to OpenGate North API and the callback is managed by promises This function pause, update its delay and active an operation for execute immediately

Returns:

  • Promise

Example:

ogapi.OperationActions("xxxxx-xxx-xxxx-xxxxx").executeNow()
pause
function pause() -> 'Promise'

This invoke a request to OpenGate North API and the callback is managed by promises This function pause an operation

Returns:

  • Promise

Example:

ogapi.OperationActions("xxxxx-xxx-xxxx-xxxxx").pause()
pausePeriodicity
function pausePeriodicity() -> 'Promise'

This invoke a request to OpenGate North API and the callback is managed by promises This function pause periodicity of an operation

Returns:

  • Promise

Example:

ogapi.OperationActions("xxxxx-xxx-xxxx-xxxxx").pausePeriodicity()