Periodicity Actions

PeriodicityActions

PeriodicityActions Objects

class PeriodicityActions()

constructor

function constructor()

Constructor

Arguments:

• ogapi InternalOpenGateAPI - this is configuration about Opengate North API.
• taskId string - Identifier of the periodicity on which the action will be carried out

activate

function activate() -> '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.newPeriodicityActions("xxxxx-xxx-xxxx-xxxxx").activate()

cancel

function cancel() -> 'Promise'

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

Returns:

• Promise

Example:

ogapi.periodicityActions("xxxxx-xxx-xxxx-xxxxx").cancelPeriodicity();

pause

function pause() -> 'Promise'

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

Returns:

• Promise

Example:

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