getItemsStats


Purpose

Returns statistics for all currently stored data items which are not being sychronized at this time.

Signature

getItemsStats( onSuccess, onFailure )

Returns

This method does not return anything.

Parameters

Name Description Type Use
onSuccess A callback function, which passes an array of JSON objects containing identifiers of data items stored in the replicated storage and their length. An empty list is returned if no items are found. function required
onFailure A callback function, called when item types cannot be listed. Passes an error code, as defined in the Constants table in the Client Store article, and an error message. function required

As its call parameter, the onSuccess callback receives an array of the result JSON objects, structured as follows:

{
  type,
  handle,
  length,
  syncstatus
}
Name Description Type
type The type of data in a retrieved data item. string
handle Data item identifier. string
length The length of a retrieved data item. integer
syncstatus Informs of the status of a sychronization operation. By default it passes "0", which denotes the "current" status. The other posssible value is: "1" for "modified". Items with status "2" (synching) are never included in the results. integer

Related topics

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