Class Index | File Index

Classes


Class Action

The Action class represents the Action runtime environment.
Defined in: action.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Action()
Creates an instance of the Action class.
Field Summary
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 Summary
Method Attributes Method Name and Description
 
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.
Class Detail
Action()
Creates an instance of the Action class.
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.
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.
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}

©2008
Documentation generated by JsDoc Toolkit 2.0.2 on Thu Oct 07 2010 07:23:17 GMT-0400 (EDT)