deleteItemWithAction


Purpose

Deletes a specific item from storage, and adds a corresponding action to the queue. This method is not supported on Android.

Signature

deleteItemWithAction( type, handle, metadata, data, options, onSuccess, onFailure )

Returns

This method does not return anything.

Parameters

Name Description Type Use
type The type of data to be deleted. string required
handle The handle of data to be deleted. string required
metadata Metadata of the action added in relation to the deleted data. string required
data Data of the action added in relation to the deleted data. string required
options A JavaScript object containing optional flags of the action added in relation to the deleted data. As defined in the addAction article. object required
onSuccess A callback function, called after the data item is successfully deleted. function required
onFailure A callback function, called when the operation fails. Passes a JSON object that consists of an error code, as defined in the Constants table in the Client Store article, and an error message. function required

Caution

For the synchronization process to execute as designed, both metadata and data strings must contain a proper JSON object.

Related topics

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