| Name | Description | Type | Use |
|---|---|---|---|
| onSuccess | A callback function, which receives an integer value specifying a number of actions in the actions queue. | function |
required |
| onFailure | A callback function, called when the number of actions cannot be returned. Returns an error code, as defined in the Constants table in the Client Store article, and an error message. | function |
required |
| options | A JavaScript object containing optional flags. | object |
optional |
The options object contains flags that enable action filtering. It is
structured as follows:
{
silent,
lax,
negligible
}| Name | Description | Type | Use |
|---|---|---|---|
| silent |
When this flag is set to "true" or "false" only actions that have the "silent" setting set to "true" or "false" are counted. If you do not provide a value, the actions are not filtered based on this property. |
boolean |
optional |
| lax | When this flag is set to "true" or "false" only actions that have the "lax" setting set to "true" or "false" are counted. If you do not provide a value, the actions are not filtered based on this property. | boolean |
optional |
| negligible | When this flag is set to "true" or "false" only actions that have the "negligible" setting set to "true" or "false" are counted. If you do not provide a value, the actions are not filtered based on this property. | boolean |
optional |