This is a basic store for RESTful communicating with a server through JSON formatted data. It implements dojo/store/api/Store.
| Parameter | Type | Description |
|---|---|---|
| options | dojo/store/JsonRest | This provides any configuration information that will be mixed into the store |
See the dojo/store/JsonRest reference documentation for more information.
The prefix to apply to sort attribute names that are ascending
The prefix to apply to sort attribute names that are ascending
Additional headers to pass in all requests to the server. These can be overridden by passing additional headers to calls to the store.
Indicates the property to use as the identity property. The values of this property should be unique.
If the store can be queried locally (on the client side in JS), this defines the query engine to use for querying the data store. This takes a query and query options and returns a function that can execute the provided query on a JavaScript array. The queryEngine may be replace to provide more sophisticated querying capabilities. For example:
var query = store.queryEngine({foo:"bar"}, {count:10});
query(someArray) -> filtered array
The returned query function may have a "matches" property that can be
used to determine if an object matches the query. For example:
query.matches({id:"some-object", foo:"bar"}) -> true
query.matches({id:"some-object", foo:"something else"}) -> false
The target base URL to use for all requests to the server. This string will be prepended to the id to generate the URL (relative or absolute) for requests sent to the server
If the target has no trailing '/', then append it.
| Parameter | Type | Description |
|---|---|---|
| id | Number | The identity of the requested target |
Adds an object. This will trigger a PUT request to the server if the object has an id, otherwise it will trigger a POST request.
| Parameter | Type | Description |
|---|---|---|
| object | Object | The object to store. |
| options | Object |
Optional Additional metadata for storing the data. Includes an "id" property if a specific id is to be used. |
Retrieves an object by its identity. This will trigger a GET request to the server using
the url this.target + id.
| Parameter | Type | Description |
|---|---|---|
| id | Number | The identity to use to lookup the object |
| options | Object |
Optional HTTP headers. For consistency with other methods, if a |
The object in the store that matches the given id.
Retrieves the children of an object.
| Parameter | Type | Description |
|---|---|---|
| parent | Object | The object to find the children of. |
| options | dojo/store/api/Store.QueryOptions |
Optional Additional options to apply to the retrieval of the children. |
A result set of the children of the parent object.
Returns an object's identity
| Parameter | Type | Description |
|---|---|---|
| object | Object | The object to get the identity from |
Returns any metadata about the object. This may include attribution, cache directives, history, or version information.
| Parameter | Type | Description |
|---|---|---|
| object | Object | The object to return metadata for. |
An object containing metadata.
Stores an object. This will trigger a PUT request to the server if the object has an id, otherwise it will trigger a POST request.
| Parameter | Type | Description |
|---|---|---|
| object | Object | The object to store. |
| options | Object |
Optional Additional metadata for storing the data. Includes an "id" property if a specific id is to be used. |
Queries the store for objects. This will trigger a GET request to the server, with the query added as a query string.
| Parameter | Type | Description |
|---|---|---|
| query | Object | The query to use for retrieving objects from the store. |
| options | Object |
Optional The optional arguments to apply to the resultset. |
The results of the query, extended with iterative methods.
Deletes an object by its identity. This will trigger a DELETE request to the server.
| Parameter | Type | Description |
|---|---|---|
| id | Number | The identity to use to delete the object |
| options | Object |
Optional HTTP headers. |
Starts a new transaction. Note that a store user might not call transaction() prior to using put, delete, etc. in which case these operations effectively could be thought of as "auto-commit" style actions.
This represents the new current transaction.