Class: PlaceReference

Extends

• ExtensibleData

Methods

---

addField(field)

Add a field

Parameters:

Name	Type	Description
field	Field

Inherited From:

• ExtensibleData#addField

Returns:

this

Type

ExtensibleData

---

addLink(link)

Add a link

Parameters:

Name	Type	Description
link	Link

Inherited From:

• ExtensibleData#addLink

Returns:

this

Type

ExtensibleData

---

addNormalized(normalized)

Add a normalized value

Parameters:

Name	Type	Description
normalized	TextValue

Returns:

this

Type

PlaceReference

---

getDescription()

Get the description

Returns:

Type

String

---

getFields()

Get the fields

Inherited From:

• ExtensibleData#getFields

Returns:

Type

Array.<Field>

---

getId()

Get the object's id.

Inherited From:

• ExtensibleData#getId

Returns:

Id

Type

String

---

getLink(rel)

Get a link

Parameters:

Name	Type	Description
rel	String

Inherited From:

• ExtensibleData#getLink

Returns:

Type

Link

---

getLinks()

Get the links

Inherited From:

• ExtensibleData#getLinks

Returns:

Type

Array.<Link>

---

getNormalized()

Get the normalized values

Returns:

Type

Array.<TextValue>

---

getOriginal()

Get the original text

Returns:

original

Type

String

---

init(json)

Initialize from JSON

Parameters:

Name	Type	Description
json	Object

Overrides:

• ExtensibleData#init

Returns:

this

Type

PlaceReference

---

<static> isInstance(obj)

Check whether the given object is an instance of this class.

Parameters:

Name	Type	Description
obj	Object

Returns:

Type

Boolean

---

setDescription(description)

Set the description

Parameters:

Name	Type	Description
description	String

Returns:

This instance.

Type

PlaceReference

---

setFields(fields)

Set the fields

Parameters:

Name	Type	Description
fields	Array.<Field>

Inherited From:

• ExtensibleData#setFields

Returns:

this

Type

ExtensibleData

---

setId(id)

Set the object's id.

Parameters:

Name	Type	Description
id	String

Inherited From:

• ExtensibleData#setId

Returns:

This object, for chaining.

Type

ExtensibleData

---

setLinks(links)

Set the links

Parameters:

Name	Type	Description
links	Links

Inherited From:

• ExtensibleData#setLinks

Returns:

this

Type

ExtensibleData

---

setNormalized(normalized)

Set the normalized values

Parameters:

Name	Type	Description
normalized	Array.<TextValue>

Returns:

this

Type

PlaceReference

---

setOriginal(original)

Set the original text

Parameters:

Name	Type	Description
original	String

Returns:

This instance.

Type

PlaceReference

---

toJSON()

Export the object as JSON

Overrides:

• ExtensibleData#toJSON

Returns:

JSON object

Type

Object