Class: module:model/RelRefMeta

module:model/RelRefMeta(refType, direction, fromId, fromType, toId, toType, extension, theData, obj)

new module:model/RelRefMeta(refType, direction, fromId, fromType, toId, toType, extension, theData, obj)

Constructs a new RelRefMeta.

Parameters:
Name Type Description
refType module:model/RelRefMeta.RefTypeEnum
direction module:model/RelRefMeta.DirectionEnum

describes the direction of the reference relative to the resource the refs are queried for

fromId String
fromType module:model/RelRefMeta.FromTypeEnum
toId String
toType module:model/RelRefMeta.ToTypeEnum
extension module:model/BaseAttributesExtensionObject
theData Object

The plain JavaScript object bearing properties of interest.

obj module:model/RelRefMeta

Optional instance to populate.

Source:

Members

(static) constructFromObject

Constructs a RelRefMeta 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) DirectionEnum :String

Allowed values for the direction property.

Type:
  • String
Properties:
Name Type Description
from String

value: "from"

to String

value: "to"

Source:

(static, readonly) FromTypeEnum :String

Allowed values for the fromType property.

Type:
  • String
Properties:
Name Type Description
folders String

value: "folders"

items String

value: "items"

versions String

value: "versions"

Source:

(static, readonly) RefTypeEnum :String

Allowed values for the refType property.

Type:
  • String
Properties:
Name Type Description
derived String

value: "derived"

dependencies String

value: "dependencies"

auxiliary String

value: "auxiliary"

xrefs String

value: "xrefs"

Source:

(static, readonly) ToTypeEnum :String

Allowed values for the toType property.

Type:
  • String
Properties:
Name Type Description
folders String

value: "folders"

items String

value: "items"

versions String

value: "versions"

Source:

(inner) direction :module:model/RelRefMeta.DirectionEnum

describes the direction of the reference relative to the resource the refs are queried for

Type:
Source:

(inner) extension :module:model/BaseAttributesExtensionObject

Type:
Source:

(inner) fromId :String

Type:
  • String
Source:

(inner) fromType :module:model/RelRefMeta.FromTypeEnum

Type:
Source:

(inner) refType :module:model/RelRefMeta.RefTypeEnum

Type:
Source:

(inner) toId :String

Type:
  • String
Source:

(inner) toType :module:model/RelRefMeta.ToTypeEnum

Type:
Source: