Entity


id

Returns the id of this entity

Syntax

string id

type

Returns the type of this entity

Syntax

string type

to_s

(Ruby method) Returns a string that represents the entity.

Syntax

string to_s

has_preview?

Returns whether this entity has cached content, which can be previewed.

Syntax

boolean has_preview?

property_names

Returns an array of the field names in this entity.

Syntax

array property_names

field_names

Returns an array of the field names in this entity.

Syntax

array field_names

field_value

Returns the first field value that corresponds to the field name. Returns nil if no value is found.

Syntax

FieldValue field_value(string name)

field_values

Returns all the values that correspond to the field name. Returns an empty array if no value is found.

Syntax

array field_values(string name)

title

Returns the title field of this entity.

Syntax

FieldValue title

url

Returns the URL that represents this entity.

Syntax

string url

exists?

Returns whether or not this entity exists.

Syntax

boolean exists?

to_xml

(Ruby method) Returns an XML string representing the entity.

Syntax

string to_xml

display_url

Returns a URL with the important parts included. Maximum length is 70 characters.

Syntax

string display_url