Class: module:model/RelRef

module:model/RelRef(id, type, theData, obj)

new module:model/RelRef(id, type, theData, obj)

Constructs a new RelRef.

Parameters:
Name Type Description
id String

resource id
type module:model/RelRef.TypeEnum
theData Object

The plain JavaScript object bearing properties of interest.
obj module:model/RelRef

Optional instance to populate.
Implements:
Source:

Members

(static) constructFromObject

Constructs a RelRef from a plain JavaScript object, optionally creating a new instance. Copies all relevant properties from data to obj if supplied or a new instance if not.

Source:

(static, readonly) TypeEnum :String

Allowed values for the type property.

Type:
  • String
Properties:
Name Type Description
folders String

value: "folders"
items String

value: "items"
versions String

value: "versions"
Source:

(inner) attributes :module:model/JsonApiAttributes

Type:
Source:

(inner) id :String

resource id

Type:
  • String
Source:
Type:
Source:

(inner) meta :module:model/RelRefMeta

Type:
Source:

(inner) relationships :module:model/JsonApiRelationships

Type:
Source:

(inner) type :module:model/RelRef.TypeEnum

Type:
Source: