Class Action
The Action class represents the Action runtime environment.
Defined in: action.js.
Constructor Attributes | Constructor Name and Description |
---|---|
Action()
Creates an instance of the Action class.
|
Field Attributes | Field Name and Description |
---|---|
Stores various runtime configuration options for the Action.
|
|
Flag which indicates that the Action should be executed after initial setup.
|
Method Attributes | Method Name and Description |
---|---|
cleanup()
Cleans up the execution environment once the Action is complete.
|
|
The initialize() method should be used to initialize the Action that is about to
be performed, including opening any connections to external services, like
Integrators, or other preliminary setup steps.
|
|
sleep(sec)
Pauses the Action's execution for some number of seconds.
|
Field Detail
CONFIG
Stores various runtime configuration options for the Action.
- instance.CONFIG.params
- Parameters configured via the Sentinel UI
DO_ACTION
Flag which indicates that the Action should be executed after initial setup.
You must set this once you've performed whatever initialization and setup
necessary and are sure that you have the correct data to trigger the action.
Method Detail
{void}
cleanup()
Cleans up the execution environment once the Action is complete.
Defined in: release.js.
Defined in: release.js.
- Returns:
- {void}
{Boolean}
initialize()
The initialize() method should be used to initialize the Action that is about to
be performed, including opening any connections to external services, like
Integrators, or other preliminary setup steps.
Defined in: release.js.
Defined in: release.js.
- Returns:
- {Boolean} Action will halt if this method returns false.
{void}
sleep(sec)
Pauses the Action's execution for some number of seconds.
- Parameters:
- {Number} sec
- Number of seconds to pause
- Returns:
- {void}