Defined in: | addon/-private/adapters/build-url-mixin.js:5 |
---|---|
Module: | ember-data |
Defined in 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.
Defined in 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); } });
Defined in 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'; } });
Defined in 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'; } });
Defined in 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'; } });
Defined in 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`; } });
Defined in 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`; } });
Defined in 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`; } });
Defined in 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}`; } });
Defined in 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); } } });
Defined in 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)}`; } });
Defined in 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.BuildURLMixin/methods