Class finesse.containerservices.WorkflowActionEvent
JavaScript representation of a WorkflowActionEvent object.
The WorkflowActionEvent object is delivered as the payload of
a WorkflowAction callback. This can be subscribed to by using
finesse.containerservices.ContainerServices#addHandler with a
topic of finesse.containerservices.ContainerServices.Topics#WORKFLOW_ACTION_EVENT.
Gadgets should key on events with a handleBy value of "OTHER".
Defined in: finesse.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
| Method Attributes | Method Name and Description |
|---|---|
|
Getter for the WorkflowActionEvent ActionVariables map
|
|
|
Getter for the WorkflowActionEvent handledBy value.
|
|
|
getName()
Getter for the WorkflowActionEvent name.
|
|
|
Getter for the WorkflowActionEvent Params map.
|
|
|
getType()
Getter for the WorkflowActionEvent type.
|
Method Detail
{Object}
getActionVariables()
Getter for the WorkflowActionEvent ActionVariables map
- Returns:
- {Object} key = action variable name, value = Object{name, type, node, testValue, actualValue}
{String}
getHandledBy()
Getter for the WorkflowActionEvent handledBy value. Gadgets should look for
events with a handleBy of "OTHER".
- Returns:
- {String} The handledBy value of the WorkflowAction that is a value of finesse.containerservices.WorkflowActionEvent.HandledBy.
{String}
getName()
Getter for the WorkflowActionEvent name.
- Returns:
- {String} The name of the WorkflowAction.
{Object}
getParams()
Getter for the WorkflowActionEvent Params map.
- Returns:
- {Object} key = param name, value = Object{name, value, expandedValue}
BROWSER_POP
- windowName : Name of window to pop into, or blank to always open new window.
- path : URL to open.
- method : "PUT" or "POST".
- location : "FINESSE" or "OTHER".
- contentType : MIME type of request body, if applicable, e.g. "text/plain".
- path : Request URL.
- body : Request content for POST requests.
{String}
getType()
Getter for the WorkflowActionEvent type.
- Returns:
- {String} The type of the WorkflowAction (BROWSER_POP, HTTP_REQUEST).