| Name | Description | Type | Use |
|---|---|---|---|
| onSuccess | A callback function, which receives either the result or the
resultMap JSON object, based on the value of the
getDetails parameter. The result object
contains a list of actions stored in the forwardable storage. The
resultMap object has been described below. |
function |
required |
| onFailure | A callback function, called when actions cannot be listed. Returns an error code, as defined in the Constants table in the Client Store article, and an error message. | function |
required |
| getDetails |
Decides whether the |
boolean |
optional |
| options | A JavaScript object containing optional flags. | object |
optional |
As its call parameter, the onSuccess callback can receive the
resultMap JSON object, structured as follows:
{
1 : {
metadata,
data,
forwarded,
rejected
},
2 : {
metadata,
data,
forwarded,
rejected
},
...
}| Name | Description | Type |
|---|---|---|
| metadata | Action metadata data, passed to the server. | string |
| data | Action data passed to the server. | string |
| forwarded | Informs of the status of the forwarding operation. | boolean |
| rejected | Informs of the status of the rejection operation. | boolean |
The options object is structured as follows. It contains flags that enable
action filtering in the getQueuedActionsCount
and listActions methods.
{
silent,
lax,
negligible
}| Name | Description | Type | Use |
|---|---|---|---|
| silent |
By setting this flag to "true" you can filter out actions from the results of the getQueuedActionsCount and listActions methods. |
boolean |
optional |
| lax | By setting this flag to "true" you prevent the ongoing data sync from restarting when a new action is added. | boolean |
optional |
| negligible | By setting this flag to "true" for all actions in the action queue you prevent the prompt for an old password from displaying when a new password is set. All actions are discarded. | boolean |
optional |