Class AppAction
Extends
CompositionItem.
Constructor Attributes | Constructor Name and Description |
---|---|
Represents an AppAction within the Composition.
|
Field Attributes | Field Name and Description |
---|---|
{boolean} |
True if this App Action had any validation failures.
|
<constant> {integer} |
A constant that can be passed in calls to the "getRequest" and
"setRequest" methods.
|
<constant> {integer} |
A constant that can be passed in calls to the "getResponse" method.
|
{Target} |
The Target object for this App Action.
|
{String} |
The value "App Action".
|
- Fields borrowed from class CompositionItem:
- children, completionType, failureText, forEachValue, hasErrorEvents, index, name, nextItem, parent, path, playNumber, playNumberBeforeRenewal, playNumberWithinRenewal, previousItem, propertyList, REPEAT_DISTRIBUTION_CONSTANT, REPEAT_TIMING_PARALLEL, REPEAT_TIMING_SERIAL, REPEAT_TYPE_COUNT_CONSTANT, repeatIndex, systemPropertyList
Method Attributes | Method Name and Description |
---|---|
Clears any current response from memory.
|
|
{String[]} |
getRequest(responseFieldIndicator)
Returns the "parameter" values for the App Action.
|
{Object} |
getResponse(responseFieldIndicator)
Returns a JavaScript associative array containing the "output" values from
the App Action.
|
setRequest(value, responseFieldIndicator)
Sets the "parameter" values for the App Action.
|
- Methods borrowed from class CompositionItem:
- clearRepeat, end, endRepeat, getChild, getItemViaPath, setRepeat
False until the App Action plays. If the App Action never plays, remains false.
Read only.
- Since:
- Build 5618
Read only.
Read only.
Read only.
Can be used after the App Action plays to free up the memory used to hold the response if the App Action does not have scope "private".
If the App Action has scope private, this call is not necessary, since the memory will be freed automatically by the system when it goes out of scope.
- Parameters:
- {integer} responseFieldIndicator
The only "indicator" value currently supported is the "REQUEST_OPERATION_PARAMS" property value.
- Returns:
- {String[]}
Array of parameter values.
If the App Action did not return any "output" values, null is returned.
- Parameters:
- {integer} responseFieldIndicator
The only "indicator" value currently supported is the "RESPONSE_OUTPUTS" property value.
- Returns:
- {Object}
The "output" values from the App Action.
- Parameters:
- {integer} value
An array of up to four String values, representing up to four "parameter" values to be placed into the request. Any and all existing parameters in the request will be removed and replaced with these new values.
- {integer} responseFieldIndicator
The only "indicator" value currently supported is the "REQUEST_OPERATION_PARAMS" property value.