getQueuedActionsCount


Purpose

Retrieves a number of actions in the actions queue.

Signature

getQueuedActionsCount( onSuccess, onFailure, options )

Returns

This method does not return anything.

Parameters

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 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

Related topics

Client Store
Legal notice | Copyright © 2016 and Confidential to Pegasystems Inc. All rights reserved
PDN | Hybrid Container | Feedback
Advanced...