A simple key/value JSON store for sharing common nodes among applications. Creating, updating, and deleting Data API nodes persists to the Data APIs endpoint by default. This api allows for resources to be persisted for reference in future sessions.
The Data API is accessed by accessing the data property of a connected IWC Client.
var client = new ozpIwc.Client({ peerUrl: "http://localhost:13000});
var dataApi = client.data;
The IWC uses the concept of references when accessing resources. References are objects with auto-generated functionality to perform actions on a given resource.
To create a reference to a resource, use the Reference constructor of the
desired api, data in this case, with a string of the resource path:
var ballRef = new client.data.Reference("/ball");
The following actions can be performed on a data api resource:
| Action | has Callback? | Description |
|---|---|---|
| get | no | gathers the node with the specific key |
| bulkGet | no | gathers all nodes who's key matches the given partial-key |
| list | no | gathers all node keys who match the given partial-key |
| set | no | stores the given value to the specified node |
| delete | no | deletes the node with the specific key |
| watch | yes | gathers the node with the specific key and calls the registered callback on updates to the node |
| unwatch | no | unregisters the callback for the node |
| addChild | no | creates a node pathed under the specified node and updates the specified nodes collection |
| removeChild | no | DEPRECATED: Use delete action. removes the specified child node. |