Olympe SDK

Class: Reference

olympe.dc. Reference

A Reference is similar to a pointer to an instance.

new Reference(tag)

Creates a Reference.

Parameters:
Name Type Description
tag string | olympe.dc.HasTag

The tag of the instance to reference.
Implements:

Methods

<static> fromJSON(json)

Deserializes an Reference from a JSON object or string.

Parameters:
Name Type Description
json string | Object
Returns:
Type
olympe.dc.Reference

equals(other)

Checks if two References are identical.

Parameters:
Name Type Description
other Object

The Object to test against.
Returns:

true if this Reference is identical to other.

Type
boolean

getSync()

Gets the referenced instance.

Returns:

The instance.

Type
olympe.dc.CloudObject

getTag()

Gets the references object's tag.

Implements:
Returns:

The tag.

Type
string

toJSON()

Converts this Reference into a JSON string.

Returns:
Type
string