Extends: | DS.RESTAdapter |
---|---|
Defined in: | addon/adapters/json-api.js:11 |
Module: | ember-data |
Inherited from DS.BuildURLMixin addon/-private/adapters/build-url-mixin.js:33
Builds a URL for a given type and optional ID.
By default, it pluralizes the type's name (for example, 'post' becomes 'posts' and 'person' becomes 'people'). To override the pluralization see pathForType.
If an ID is specified, it adds the ID to the path generated for the type, separated by a /
.
When called by RESTAdapter.findMany() the id
and snapshot
parameters will be arrays of ids and snapshots.
Inherited from DS.RESTAdapter addon/adapters/rest.js:747
Called by the store when a newly created record is saved via the save
method on a model record instance.
The createRecord
method serializes the record and makes an Ajax (HTTP POST) request to a URL computed by buildURL
.
See serialize
for information on how to customize the serialized form of a record.
Inherited from DS.RESTAdapter addon/adapters/rest.js:1243
Get the data (body or query params) for a request.
Inherited from DS.RESTAdapter addon/adapters/rest.js:819
Called by the store when a record is deleted.
The deleteRecord
method makes an Ajax (HTTP DELETE) request to a URL computed by buildURL
.
Inherited from DS.RESTAdapter addon/adapters/rest.js:485
Called by the store in order to fetch a JSON array for all of the records for a given type.
The findAll
method makes an Ajax (HTTP GET) request to a URL computed by buildURL
, and returns a promise for the resulting payload.
Inherited from DS.RESTAdapter addon/adapters/rest.js:695
Called by the store in order to fetch the JSON for the unloaded record in a belongs-to relationship that was originally specified as a URL (inside of links
).
For example, if your original payload looks like this:
{ "person": { "id": 1, "name": "Tom Dale", "links": { "group": "/people/1/group" } } }
This method will be called with the parent record and /people/1/group
.
The findBelongsTo
method will make an Ajax (HTTP GET) request to the originally specified URL.
The format of your links
value will influence the final request URL via the urlPrefix
method:
Links beginning with //
, http://
, https://
, will be used as is, with no further manipulation.
Links beginning with a single /
will have the current adapter's host
value prepended to it.
Links with no beginning /
will have a parentURL prepended to it, via the current adapter's buildURL
.
Inherited from DS.RESTAdapter addon/adapters/rest.js:641
Called by the store in order to fetch a JSON array for the unloaded records in a has-many relationship that were originally specified as a URL (inside of links
).
For example, if your original payload looks like this:
{ "post": { "id": 1, "title": "Rails is omakase", "links": { "comments": "/posts/1/comments" } } }
This method will be called with the parent record and /posts/1/comments
.
The findHasMany
method will make an Ajax (HTTP GET) request to the originally specified URL.
The format of your links
value will influence the final request URL via the urlPrefix
method:
Links beginning with //
, http://
, https://
, will be used as is, with no further manipulation.
Links beginning with a single /
will have the current adapter's host
value prepended to it.
Links with no beginning /
will have a parentURL prepended to it, via the current adapter's buildURL
.
Inherited from DS.RESTAdapter addon/adapters/rest.js:594
Called by the store in order to fetch several records together if coalesceFindRequests
is true
For example, if the original payload looks like:
{ "id": 1, "title": "Rails is omakase", "comments": [ 1, 2, 3 ] }
The IDs will be passed as a URL-encoded Array of IDs, in this form:
ids[]=1&ids[]=2&ids[]=3
Many servers, such as Rails and PHP, will automatically convert this URL-encoded array into an Array for you on the server-side. If you want to encode the IDs, differently, just override this (one-line) method.
The findMany
method makes an Ajax (HTTP GET) request to a URL computed by buildURL
, and returns a promise for the resulting payload.
Inherited from DS.RESTAdapter addon/adapters/rest.js:452
Called by the store in order to fetch the JSON for a given type and ID.
The findRecord
method makes an Ajax request to a URL computed by buildURL
, and returns a promise for the resulting payload.
This method performs an HTTP GET
request with the id provided as part of the query string.
Inherited from DS.Adapter addon/adapter.js:223
If the globally unique IDs for your records should be generated on the client, implement the generateIdForRecord()
method. This method will be invoked each time you create a new record, and the value returned from it will be assigned to the record's primaryKey
.
Most traditional REST-like HTTP APIs will not use this method. Instead, the ID of the record will be set by the server, and your adapter will update the store with the new ID when it calls didCreateRecord()
. Only implement this method if you intend to generate record IDs on the client-side.
The generateIdForRecord()
method will be invoked with the requesting store as the first parameter and the newly created record as the second parameter:
import DS from 'ember-data'; import { v4 } from 'uuid'; export default DS.Adapter.extend({ generateIdForRecord(store, inputProperties) { return v4(); } });
Inherited from DS.RESTAdapter addon/adapters/rest.js:869
Organize records into groups, each of which is to be passed to separate calls to findMany
.
This implementation groups together records that have the same base URL but differing ids. For example /comments/1
and /comments/2
will be grouped together because we know findMany can coalesce them together as /comments?ids[]=1&ids[]=2
It also supports urls where ids are passed as a query param, such as /comments?id=1
but not those where there is more than 1 query param such as /comments?id=2&name=David
Currently only the query param of id
is supported. If you need to support others, please override this or the _stripIDFromURL
method.
It does not group records that have differing base urls, such as for example: /posts/1/comments/2
and /posts/2/comments/3
Inherited from DS.RESTAdapter addon/adapters/rest.js:933
Takes an ajax response, and returns the json payload or an error.
By default this hook just returns the json payload passed to it. You might want to override it in two cases:
Your API might return useful results in the response headers. Response headers are passed in as the second argument.
Your API might return errors as successful responses with status code 200 and an Errors text or object. You can return a DS.InvalidError
or a DS.AdapterError
(or a sub class) from this hook and it will automatically reject the promise and put your record into the invalid or error state.
Returning a DS.InvalidError
from this method will cause the record to transition into the invalid
state and make the errors
object available on the record. When returning an DS.InvalidError
the store will attempt to normalize the error data returned from the server using the serializer's extractErrors
method.
Inherited from DS.RESTAdapter addon/adapters/rest.js:1358
Get the headers for a request.
By default the value of the headers
property of the adapter is returned.
Inherited from DS.RESTAdapter addon/adapters/rest.js:1007
Default handleResponse
implementation uses this hook to decide if the response is an invalid error.
Inherited from DS.RESTAdapter addon/adapters/rest.js:992
Default handleResponse
implementation uses this hook to decide if the response is a success.
Inherited from DS.RESTAdapter addon/adapters/rest.js:1301
Get the HTTP method for a request.
Inherited from DS.BuildURLMixin addon/-private/adapters/build-url-mixin.js:410
Determines the pathname for a given type.
By default, it pluralizes the type's name (for example, 'post' becomes 'posts' and 'person' becomes 'people').
For example if you have an object LineItem with an endpoint of "/line_items/".
import DS from 'ember-data'; export default DS.RESTAdapter.extend({ pathForType: function(modelName) { var decamelized = Ember.String.decamelize(modelName); return Ember.String.pluralize(decamelized); } });
Inherited from DS.RESTAdapter addon/adapters/rest.js:521
Called by the store in order to fetch a JSON array for the records that match a particular query.
The query
method makes an Ajax (HTTP GET) request to a URL computed by buildURL
, and returns a promise for the resulting payload.
The query
argument is a simple JavaScript object that will be passed directly to the server as parameters.
Inherited from DS.RESTAdapter addon/adapters/rest.js:557
Called by the store in order to fetch a JSON object for the record that matches a particular query.
The queryRecord
method makes an Ajax (HTTP GET) request to a URL computed by buildURL
, and returns a promise for the resulting payload.
The query
argument is a simple JavaScript object that will be passed directly to the server as parameters.
Inherited from DS.Adapter addon/adapter.js:257
Proxies to the serializer's serialize
method.
Example
import DS from 'ember-data'; export default DS.Adapter.extend({ createRecord(store, type, snapshot) { let data = this.serialize(snapshot, { includeId: true }); let url = `/${type.modelName}`; // ... } });
Inherited from DS.Adapter addon/adapter.js:630
This method is used by the store to determine if the store should reload a record array after the store.findAll
method resolves with a cached record array.
This method is only checked by the store when the store is returning a cached record array.
If this method returns true
the store will re-fetch all records from the adapter.
For example, if you do not want to fetch complex data over a mobile connection, or if the network is down, you can implement shouldBackgroundReloadAll
as follows:
shouldBackgroundReloadAll(store, snapshotArray) { let connection = window.navigator.connection; if (connection === 'cellular' || connection === 'none') { return false; } else { return true; } }
By default this method returns true
, indicating that a background reload should always be triggered.
Inherited from DS.Adapter addon/adapter.js:590
This method is used by the store to determine if the store should reload a record after the store.findRecord
method resolves a cached record.
This method is only checked by the store when the store is returning a cached record.
If this method returns true
the store will re-fetch a record from the adapter.
For example, if you do not want to fetch complex data over a mobile connection, or if the network is down, you can implement shouldBackgroundReloadRecord
as follows:
shouldBackgroundReloadRecord(store, snapshot) { let connection = window.navigator.connection; if (connection === 'cellular' || connection === 'none') { return false; } else { return true; } }
By default this hook returns true
so the data for the record is updated in the background.
Inherited from DS.Adapter addon/adapter.js:535
This method is used by the store to determine if the store should reload all records from the adapter when records are requested by store.findAll
.
If this method returns true
, the store will re-fetch all records from the adapter. If this method returns false
, the store will resolve immediately using the cached records.
For example, if you are building an events ticketing system, in which users can only reserve tickets for 20 minutes at a time, and want to ensure that in each route you have data that is no more than 20 minutes old you could write:
shouldReloadAll(store, snapshotArray) { let snapshots = snapshotArray.snapshots(); return snapshots.any((ticketSnapshot) => { let lastAccessedAt = ticketSnapshot.attr('lastAccessedAt'); let timeDiff = moment().diff(lastAccessedAt, 'minutes'); if (timeDiff > 20) { return true; } else { return false; } }); }
This method would ensure that whenever you do store.findAll('ticket')
you will always get a list of tickets that are no more than 20 minutes old. In case a cached version is more than 20 minutes old, findAll
will not resolve until you fetched the latest versions.
By default this methods returns true
if the passed snapshotRecordArray
is empty (meaning that there are no records locally available yet), otherwise it returns false
.
Note that, with default settings, shouldBackgroundReloadAll
will always re-fetch all the records in the background even if shouldReloadAll
returns false
. You can override shouldBackgroundReloadAll
if this does not suit your use case.
Inherited from DS.Adapter addon/adapter.js:485
This method is used by the store to determine if the store should reload a record from the adapter when a record is requested by store.findRecord
.
If this method returns true
, the store will re-fetch a record from the adapter. If this method returns false
, the store will resolve immediately using the cached record.
For example, if you are building an events ticketing system, in which users can only reserve tickets for 20 minutes at a time, and want to ensure that in each route you have data that is no more than 20 minutes old you could write:
shouldReloadRecord(store, ticketSnapshot) { let lastAccessedAt = ticketSnapshot.attr('lastAccessedAt'); let timeDiff = moment().diff(lastAccessedAt, 'minutes'); if (timeDiff > 20) { return true; } else { return false; } }
This method would ensure that whenever you do store.findRecord('ticket',
id)
you will always get a ticket that is no more than 20 minutes old. In case the cached version is more than 20 minutes old, findRecord
will not resolve until you fetched the latest version.
By default this hook returns false
, as most UIs should not block user interactions while waiting on data update.
Note that, with default settings, shouldBackgroundReloadRecord
will always re-fetch the records in the background even if shouldReloadRecord
returns false
. You can override shouldBackgroundReloadRecord
if this does not suit your use case.
Inherited from DS.RESTAdapter addon/adapters/rest.js:289
By default, the RESTAdapter will send the query params sorted alphabetically to the server.
For example:
store.query('posts', { sort: 'price', category: 'pets' });
will generate a requests like this /posts?category=pets&sort=price
, even if the parameters were specified in a different order.
That way the generated URL will be deterministic and that simplifies caching mechanisms in the backend.
Setting sortQueryParams
to a falsey value will respect the original order.
In case you want to sort the query parameters with a different criteria, set sortQueryParams
to your custom sort function.
import DS from 'ember-data'; export default DS.RESTAdapter.extend({ sortQueryParams(params) { let sortedKeys = Object.keys(params).sort().reverse(); let len = sortedKeys.length, newParams = {}; for (let i = 0; i < len; i++) { newParams[sortedKeys[i]] = params[sortedKeys[i]]; } return newParams; } });
Inherited from DS.RESTAdapter addon/adapters/rest.js:782
Called by the store when an existing record is saved via the save
method on a model record instance.
The updateRecord
method serializes the record and makes an Ajax (HTTP PUT) request to a URL computed by buildURL
.
See serialize
for information on how to customize the serialized form of a record.
Inherited from DS.BuildURLMixin addon/-private/adapters/build-url-mixin.js:298
Builds a URL for a record.save()
call when the record was created locally using store.createRecord()
.
Example:
import DS from 'ember-data'; export default DS.RESTAdapter.extend({ urlForCreateRecord(modelName, snapshot) { return this._super(...arguments) + '/new'; } });
Inherited from DS.BuildURLMixin addon/-private/adapters/build-url-mixin.js:348
Builds a URL for a record.save()
call when the record has been deleted locally.
Example:
import DS from 'ember-data'; export default DS.RESTAdapter.extend({ urlForDeleteRecord(id, modelName, snapshot) { return this._super(...arguments) + '/destroy'; } });
Inherited from DS.BuildURLMixin addon/-private/adapters/build-url-mixin.js:137
Builds a URL for a store.findAll(type)
call.
Example:
import DS from 'ember-data'; export default DS.JSONAPIAdapter.extend({ urlForFindAll(modelName, snapshot) { return 'data/comments.json'; } });
Inherited from DS.BuildURLMixin addon/-private/adapters/build-url-mixin.js:271
Builds a URL for fetching a async belongsTo relationship when a url is not provided by the server.
Example:
import DS from 'ember-data'; export default DS.JSONAPIAdapter.extend({ urlForFindBelongsTo(id, modelName, snapshot) { let baseUrl = this.buildURL(id, modelName); return `${baseUrl}/relationships`; } });
Inherited from DS.BuildURLMixin addon/-private/adapters/build-url-mixin.js:244
Builds a URL for fetching a async hasMany relationship when a url is not provided by the server.
Example:
import DS from 'ember-data'; export default DS.JSONAPIAdapter.extend({ urlForFindHasMany(id, modelName, snapshot) { let baseUrl = this.buildURL(id, modelName); return `${baseUrl}/relationships`; } });
Inherited from DS.BuildURLMixin addon/-private/adapters/build-url-mixin.js:216
Builds a URL for coalesceing multiple store.findRecord(type, id)
records into 1 request when the adapter's coalesceFindRequests
property is true.
Example:
import DS from 'ember-data'; export default DS.RESTAdapter.extend({ urlForFindMany(ids, modelName) { let baseUrl = this.buildURL(); return `${baseUrl}/coalesce`; } });
Inherited from DS.BuildURLMixin addon/-private/adapters/build-url-mixin.js:110
Builds a URL for a store.findRecord(type, id)
call.
Example:
import DS from 'ember-data'; export default DS.JSONAPIAdapter.extend({ urlForFindRecord(id, modelName, snapshot) { let baseUrl = this.buildURL(); return `${baseUrl}/users/${snapshot.adapterOptions.user_id}/playlists/${id}`; } });
Inherited from DS.BuildURLMixin addon/-private/adapters/build-url-mixin.js:161
Builds a URL for a store.query(type, query)
call.
Example:
import DS from 'ember-data'; export default DS.RESTAdapter.extend({ host: 'https://api.github.com', urlForQuery (query, modelName) { switch(modelName) { case 'repo': return `https://api.github.com/orgs/${query.orgId}/repos`; default: return this._super(...arguments); } } });
Inherited from DS.BuildURLMixin addon/-private/adapters/build-url-mixin.js:191
Builds a URL for a store.queryRecord(type, query)
call.
Example:
import DS from 'ember-data'; export default DS.RESTAdapter.extend({ urlForQueryRecord({ slug }, modelName) { let baseUrl = this.buildURL(); return `${baseUrl}/${encodeURIComponent(slug)}`; } });
Inherited from DS.RESTAdapter addon/adapters/rest.js:1321
Get the URL for a request.
Inherited from DS.BuildURLMixin addon/-private/adapters/build-url-mixin.js:323
Builds a URL for a record.save()
call when the record has been update locally.
Example:
import DS from 'ember-data'; export default DS.RESTAdapter.extend({ urlForUpdateRecord(id, modelName, snapshot) { return `/${id}/feed?access_token=${snapshot.adapterOptions.token}`; } });
© 2017 Yehuda Katz, Tom Dale and Ember.js contributors
Licensed under the MIT License.
https://emberjs.com/api/ember-data/2.14/classes/DS.JSONAPIAdapter/methods