目录

Site

Class Info

public class Site

Represents a place object.

Public Constructor Summary

Constructor Name

Site()

Default constructor.

Public Method Summary

Qualifier and Type

Method Name and Description

AddressDetail

getAddress()

Obtains place details.

Double

getDistance()

Obtains the linear distance between the predicted place and the place specified in the input parameter location.

String

getFormatAddress()

Obtains the formatted detailed address of a place.

Coordinate

getLocation()

Obtains the longitude and latitude of a place.

String

getName()

Obtains the name of a place.

Poi

getPoi()

Obtains the POI of a place.

AutoCompletePrediction

getPrediction()

Obtains description of the autocomplete place.

String

getSiteId()

Obtains the unique ID of a place.

Integer

getUtcOffset()

Obtains the difference between the time zone of a place and the UTC time zone.

CoordinateBounds

getViewport()

Obtains the viewport of a place.

void

setAddress(AddressDetail address)

Sets place details.

void

setDistance(Double distance)

Sets the linear distance between a predicted place and the location specified by the input parameter location.

void

setFormatAddress(String formatAddress)

Sets the formatted detailed address of a place.

void

setLocation(Coordinate location)

Sets the longitude and latitude of a place.

void

setName(String name)

Sets the name of a place.

void

setPoi(Poi poi)

Sets the POI of a place.

void

setPrediction(AutoCompletePrediction prediction)

Sets the autocomplete place description.

void

setSiteId(String siteId)

Sets the unique ID of a place.

void

setUtcOffset(Integer utcOffset)

Sets the difference between the time zone of a place and the UTC time zone.

void

setViewport(CoordinateBounds viewport)

Sets the viewport of a place.

Public Methods

[h2]getAddress

Method

public AddressDetail getAddress()

Obtains place details.

Returns

Type

Description

AddressDetail

Place details.

[h2]getDistance

Method

public Double getDistance()

Obtains the linear distance between a predicted place and the location specified by the input parameter location.

Returns

Type

Description

Double

Linear distance between a predicted place and the location specified by the input parameter location, in meters.

[h2]getFormatAddress

Method

public String getFormatAddress()

Obtains the formatted detailed address of a place.

Returns

Type

Description

String

Formatted detailed address of a place.

[h2]getLocation

Method

public Coordinate getLocation()

Obtains the longitude and latitude of a place.

Returns

Type

Description

Coordinate

Longitude and latitude of a place.

[h2]getName

Method

public String getName()

Obtains the name of a place.

Returns

Type

Description

String

Name of a place.

[h2]getPoi

Method

public Poi getPoi()

Obtains the POI of a place.

Returns

Type

Description

Poi

POI of a place.

[h2]getPrediction

Method

public AutoCompletePrediction getPrediction()

Obtains the autocomplete place description.

Returns

Type

Description

AutoCompletePrediction

Autocomplete place description.

NOTE:

This parameter is returned only by the search suggestion and autocomplete APIs.

[h2]getSiteId

Method

public String getSiteId()

Obtains the unique ID of a place.

Returns

Type

Description

String

Unique ID of a place.

[h2]getUtcOffset

Method

public Integer getUtcOffset()

Obtains the difference between the time zone of a place and the UTC time zone.

Returns

Type

Description

Integer

Difference between the time zone of a place and the UTC time zone, in minutes.

NOTE:

This parameter is returned only by the place detail search API.

[h2]getViewport

Method

public CoordinateBounds getViewport()

Obtains the viewport of a place.

Returns

Type

Description

CoordinateBounds

Viewport of a place.

[h2]setAddress

Method

public void setAddress(AddressDetail address)

Sets place details.

Parameters

Name

Description

address

Place details.

[h2]setDistance

Method

public void setDistance(Double distance)

Sets the linear distance between a predicted place and the location specified by the input parameter location.

Parameters

Name

Description

distance

Linear distance between a predicted place and the location specified by the input parameter location, in meters.

[h2]setFormatAddress

Method

public void setFormatAddress(String formatAddress)

Sets the formatted detailed address of a place.

Parameters

Name

Description

formatAddress

Formatted detailed address of a place.

[h2]setLocation

Method

public void setLocation(Coordinate location)

Sets the longitude and latitude of a place.

Parameters

Name

Description

location

Longitude and latitude of a place.

[h2]setName

Method

public void setName(String name)

Sets the name of a place.

Parameters

Name

Description

name

Name of a place.

[h2]setPoi

Method

public void setPoi(Poi poi)

Sets the POI of a place.

Parameters

Name

Description

poi

POI of a place.

[h2]setPrediction

Method

public void setPrediction(AutoCompletePrediction prediction)

Sets the autocomplete place description.

Parameters

Name

Description

prediction

Autocomplete place description.

[h2]setSiteId

Method

public void setSiteId(String siteId)

Sets the unique ID of a place.

Parameters

Name

Description

siteId

Unique ID of a place.

[h2]setUtcOffset

Method

public void setUtcOffset(Integer utcOffset)

Sets the difference between the time zone of a place and the UTC time zone.

Parameters

Name

Description

utcOffset

Difference between the time zone of a place and the UTC time zone, in minutes.

[h2]setViewport

Method

public void setViewport(CoordinateBounds viewport)

Sets the viewport of a place.

Parameters

Name

Description

viewport

Viewport of a place.