build-url-mixin.js:5

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

WARNING: This interface is likely to change in order to accomodate https://github.com/emberjs/rfcs/pull/4

Using BuildURLMixin

To use url building, include the mixin when extending an adapter, and call buildURL where needed. The default behaviour is designed for RESTAdapter.

Example

  
    export default DS.Adapter.extend(BuildURLMixin, {
    findRecord: function(store, type, id, snapshot) {
      var url = this.buildURL(type.modelName, id, snapshot, 'findRecord');
      return this.ajax(url, 'GET');
    }
  });

Attributes

The host and namespace attributes will be used if defined, and are optional.

Index
Methods

Show: Inherited Protected Private Deprecated

Show: Inherited Protected Private Deprecated

`_buildURL`

(modelName, id) String private

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

Parameters:

modelName String
id String

Returns:

String: url

`buildURL`

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

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.

Parameters:

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

`pathForType`

(modelName) String

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

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/".

  
      app/adapters/application.js
    
  import DS from 'ember-data';

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

app/adapters/application.js
1 2 3 4 5 6 7 8	import DS from 'ember-data'; export default DS.RESTAdapter.extend({ pathForType: function(modelName) { var decamelized = Ember.String.decamelize(modelName); return Ember.String.pluralize(decamelized); } });

Parameters:

modelName String

Returns:

String: path

`urlForCreateRecord`

(modelName, snapshot) String

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

Parameters:

modelName String
snapshot DS.Snapshot

Returns:

String: url

`urlForDeleteRecord`

(id, modelName, snapshot) String

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

Parameters:

id String
modelName String
snapshot DS.Snapshot

Returns:

String: url

`urlForFindAll`

(modelName, snapshot) String

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

Parameters:

modelName String
snapshot DS.SnapshotRecordArray

Returns:

String: url

`urlForFindBelongTo`

(id, modelName, snapshot) String

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

Parameters:

id String
modelName String
snapshot DS.Snapshot

Returns:

String: url

`urlForFindHasMany`

(id, modelName, snapshot) String

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

Parameters:

id String
modelName String
snapshot DS.Snapshot

Returns:

String: url

`urlForFindMany`

(ids, modelName, snapshots) String

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

Parameters:

ids Array
modelName String
snapshots Array

Returns:

String: url

`urlForFindRecord`

(id, modelName, snapshot) String

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

Parameters:

id String
modelName String
snapshot DS.Snapshot

Returns:

String: url

`urlForQuery`

(query, modelName) String

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

Parameters:

query Object
modelName String

Returns:

String: url

`urlForQueryRecord`

(query, modelName) String

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

Parameters:

query Object
modelName String

Returns:

String: url

`urlForUpdateRecord`

(id, modelName, snapshot) String

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

Parameters:

id String
modelName String
snapshot DS.Snapshot

Returns:

String: url

`urlPrefix`

(path, parentURL) String private

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

Parameters:

path String
parentURL String

Returns:

String: urlPrefix