Name | Description | Type | Use |
---|---|---|---|
type | Denotes the type of action to be written. | string |
optional |
handle | Action's handle, used in data synchronization. | string |
optional |
metadata | Action's meta data. | string |
required |
data | The action's data string. | string |
required |
onSuccess | A callback function, informs that the operation completed successfully. The onSuccess
function takes an id parameter that is used to identify the action that was just
added. |
function |
required |
onFailure | A callback function, called when the operation fails. Returns an error code, as defined in the Constants table in the Client Store article. | function |
required |
For the synchronization process to execute as designed, both metadata
and data
strings must contain a proper JSON object.