listActions

Purpose

Retrieves a map of currently stored actions.

listActions( onSuccess, onFailure )

This method does not return anything.

Name	Description	Type	Use
onSuccess	A callback function, which receives either the `result` or the `resultMap` JSON object, based on the value of the `getDetails` parameter. The `result` object contains a list of actions stored in the forwardable storage. The `resultMap` object has been described below.	`function`	required
onFailure	A callback function, called when actions cannot be listed. Returns an error code, as defined in the Constants table in the Client Store article, and an error message.	`function`	required
Decides whether the `onSuccess` callback receives action data only. If set to true, the object contains metadata, data, and the status of the forwarding operation.	`boolean`	optional

As its call parameter, the onSuccess callback can receive the resultMap JSON object, structured as follows:

{
  id1 : {
        metadata,
        data,
        forwarded
  },
  id2 : {
        metadata,
        data,
        forwarded
  },
  ...
}

Name	Description	Type
id	An identifier of an action, assigned when the `onSuccess` function is called to confirm that the addAction method completed successfully.	`number`
metadata	Action metadata data, passed to the server.	`string`
data	Action data passed to the server.	`string`
forwarded	Informs of the status of the forwarding operation.	`boolean`