DS.RecordReference Class addon/-private/system/references/record.js:4


An RecordReference is a low level API that allows users and addon author to perform meta-operations on a record.

Show:

Methods

Show:

(UNKNOWN)

This API allows you to provide a reference with new data. The simplest usage of this API is similar to store.push: you provide a normalized hash of data and the object represented by the reference will update.

If you pass a promise to push, Ember Data will not ask the adapter for the data if another attempt to fetch it is made in the interim. When the promise resolves, the underlying object is updated with the new data, and the promise returned by this function is resolved with that object.

For example, recordReference.push(promise) will be resolved with a record.

Example

1
2
3
4
5
6
 var userRef = store.getReference('user', 1);

 // provide data for reference
 userRef.push({ data: { id: 1, username: "@user" }}).then(function(user) {
   userRef.value() === user;
 });

Parameters:

UNKNOWN Promise|Object

Returns:

Promise a promise for the value (record or relationship)

id

String

The id of the record that this reference refers to.

Together, the type and id properties form a composite key for the identity map.

Example

1
2
3
var userRef = store.getReference('user', 1);

userRef.id(); // '1'

Returns:

String
The id of the record.

load

Promise

Triggers a fetch for the backing entity based on its remoteType (see remoteType definitions per reference type).

Example

1
2
3
4
var userRef = store.getReference('user', 1);

// load user (via store.find)
userRef.load().then(...)

Returns:

Promise
the record for this RecordReference

reload

Promise

Reloads the record if it is already loaded. If the record is not loaded it will load the record via store.findRecord

Example

1
2
3
4
var userRef = store.getReference('user', 1);

// or trigger a reload
userRef.reload().then(...)

Returns:

Promise
the record for this RecordReference

remoteType

String

How the reference will be looked up when it is loaded: Currently this always return identity to signifying that a record will be loaded by the type and id.

Example

1
2
3
var userRef = store.getReference('user', 1);

userRef.remoteType(); // 'identity'

Returns:

String
'identity'

value

DS.Model

If the entity referred to by the reference is already loaded, it is present as reference.value. Otherwise the value returned by this function is null.

Example

1
2
3
 var userRef = store.getReference('user', 1);

 userRef.value(); // user

Returns:

DS.Model
the record for this RecordReference