Class DS.BuildURLMixin

buildURL (modelName, id, snapshot, requestType, query) String

Defined in addon/-private/adapters/build-url-mixin.js:34

modelName

String

id

(String|Array|Object)

single id or array of ids or query

snapshot

(DS.Snapshot|Array)

single snapshot or array of snapshots

requestType

String

query

Object

object of query parameters to send for query requests.

returns

String

url

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.

pathForType (modelName) String

Defined in addon/-private/adapters/build-url-mixin.js:411

modelName

String

returns

String

path

Determines the pathname for a given type.

By default, it pluralizes the type's name (for example, 'post' becomes 'posts' and 'person' becomes 'people').

Pathname customization

For example if you have an object LineItem with an endpoint of "/line_items/".

import DS from 'ember-data';
import { decamelize } from '@ember/string';
import { pluralize } from 'ember-inflector';

export default DS.RESTAdapter.extend({
  pathForType: function(modelName) {
    var decamelized = decamelize(modelName);
    return pluralize(decamelized);
  }
});

urlForCreateRecord (modelName, snapshot) String

Defined in addon/-private/adapters/build-url-mixin.js:299

modelName

String

snapshot

DS.Snapshot

returns

String

url

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';
  }
});

urlForDeleteRecord (id, modelName, snapshot) String

Defined in addon/-private/adapters/build-url-mixin.js:349

id

String

modelName

String

snapshot

DS.Snapshot

returns

String

url

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';
  }
});

urlForFindAll (modelName, snapshot) String

Defined in addon/-private/adapters/build-url-mixin.js:138

modelName

String

snapshot

DS.SnapshotRecordArray

returns

String

url

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';
  }
});

urlForFindBelongsTo (id, modelName, snapshot) String

Defined in addon/-private/adapters/build-url-mixin.js:272

id

String

modelName

String

snapshot

DS.Snapshot

returns

String

url

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`;
  }
});

urlForFindHasMany (id, modelName, snapshot) String

Defined in addon/-private/adapters/build-url-mixin.js:245

id

String

modelName

String

snapshot

DS.Snapshot

returns

String

url

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`;
  }
});

urlForFindMany (ids, modelName, snapshots) String

Defined in addon/-private/adapters/build-url-mixin.js:217

ids

Array

modelName

String

snapshots

Array

returns

String

url

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`;
  }
});

urlForFindRecord (id, modelName, snapshot) String

Defined in addon/-private/adapters/build-url-mixin.js:111

id

String

modelName

String

snapshot

DS.Snapshot

returns

String

url

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(modelName, id, snapshot);
    return `${baseUrl}/users/${snapshot.adapterOptions.user_id}/playlists/${id}`;
  }
});

urlForQuery (query, modelName) String

Defined in addon/-private/adapters/build-url-mixin.js:162

query

Object

modelName

String

returns

String

url

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);
    }
  }
});

urlForQueryRecord (query, modelName) String

Defined in addon/-private/adapters/build-url-mixin.js:192

query

Object

modelName

String

returns

String

url

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)}`;
  }
});

urlForUpdateRecord (id, modelName, snapshot) String

Defined in addon/-private/adapters/build-url-mixin.js:324

id

String

modelName

String

snapshot

DS.Snapshot

returns

String

url

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}`;
  }
});