Class BelongsToReference

public

A BelongsToReference is a low-level API that allows users and addon authors to perform meta-operations on a belongs-to relationship.

Show:

returns
String

The id of the record in this belongsTo relationship.

The id of the record that this reference refers to. Together, the type() and id() methods form a composite key for the identity map. This can be used to access the id of an async relationship without triggering a fetch that would normally happen if you attempted to use record.relationship.id.

Example

```javascript // models/blog.js import Model, { belongsTo } from '@ember-data/model';

export default class BlogModel extends Model {

returns
String

The link Ember Data will use to fetch or reload this belongs-to relationship.

The link Ember Data will use to fetch or reload this belongs-to relationship. By default it uses only the "related" resource linkage.

Example

// models/blog.js
import Model, { belongsTo } from '@ember-data/model';
export default Model.extend({
   user: belongsTo('user', { async: true, inverse: null })
 });

let blog = store.push({
   data: {
     type: 'blog',
     id: 1,
     relationships: {
       user: {
         links: {
           related: '/articles/1/author'
         }
       }
     }
   }
 });
let userRef = blog.belongsTo('user');

// get the identifier of the reference
if (userRef.remoteType() === "link") {
   let link = userRef.link();
 }
returns

any links that have been received for this relationship

options
Object

the options to pass in.

returns
Promise

a promise that resolves with the record in this belongs-to relationship.

Loads a record in a belongs-to relationship if it is not already loaded. If the relationship is already loaded this method does not trigger a new load.

Example

```javascript // models/blog.js import Model, { belongsTo } from '@ember-data/model';

export default class BlogModel extends Model {

returns
Object

The meta information for the belongs-to relationship.

The meta data for the belongs-to relationship.

Example

// models/blog.js
import Model, { belongsTo } from '@ember-data/model';
export default Model.extend({
   user: belongsTo('user', { async: true, inverse: null })
 });

let blog = store.push({
   data: {
     type: 'blog',
     id: 1,
     relationships: {
       user: {
         links: {
           related: {
             href: '/articles/1/author'
           },
         },
         meta: {
           lastUpdated: 1458014400000
         }
       }
     }
   }
 });

let userRef = blog.belongsTo('user');

userRef.meta() // { lastUpdated: 1458014400000 }
objectOrPromise
Object|Promise

a promise that resolves to a JSONAPI document object describing the new value of this relationship.

returns
Promise<record>

A promise that resolves with the new value in this belongs-to relationship.

push can be used to update the data in the relationship and Ember Data will treat the new data as the canonical value of this relationship on the backend.

Example

```js {data-filename=app/models/blog.js} import Model, { belongsTo } from '@ember-data/model';

export default class BlogModel extends Model {

options
Object

the options to pass in.

returns
Promise

a promise that resolves with the record in this belongs-to relationship after the reload has completed.

Triggers a reload of the value in this relationship. If the remoteType is "link" Ember Data will use the relationship link to reload the relationship. Otherwise it will reload the record by its id.

Example

```javascript // models/blog.js import Model, { belongsTo } from '@ember-data/model';

export default class BlogModel extends Model {

returns
String

The name of the remote type. This should either be link or id

This returns a string that represents how the reference will be looked up when it is loaded. If the relationship has a link it will use the "link" otherwise it defaults to "id".

Example

```js {data-filename=app/models/post.js} import Model, { hasMany } from '@ember-data/model';

export default class PostModel extends Model {

returns
Model

the record in this relationship

value() synchronously returns the current value of the belongs-to relationship. Unlike record.relationshipName, calling value() on a reference does not trigger a fetch if the async relationship is not yet loaded. If the relationship is not loaded it will always return null.

Example

```javascript // models/blog.js import Model, { belongsTo } from '@ember-data/model';

export default class BlogModel extends Model {