GeocodeRequest2
instead.@Deprecated public class GeocodeRequest extends Request<java.util.List<Location>>
GeocodeRequest
represents an extended Request
used to retrieve Location
data by way of Geocoder
search services.
Note: The response to a GeocodeRequest
is a list of Location
objects.
BUILDING_ID_REFERENCE_NAME, PLACE_CONTENT_WIKIPEDIA, PVID_ID_REFERENCE_NAME, VENUES_CONTENT_ID_REFERENCE_NAME, VENUES_DESTINATION_ID_REFERENCE_NAME, VENUES_ID_REFERENCE_NAME, VENUES_VENUE_ID_REFERENCE_NAME
Constructor and Description |
---|
GeocodeRequest(java.lang.String query)
Deprecated.
Creates a geocoder request that resolves a free text query into a
Location . |
Modifier and Type | Method and Description |
---|---|
ErrorCode |
execute(ResultListener<java.util.List<Location>> listener)
Deprecated.
Executes an asynchronous request.
|
int |
getCollectionSize()
Deprecated.
Gets the current collection size being used for request responses.
|
GeocodeRequest |
setCollectionSize(int value)
Deprecated.
Sets a collection size to be used for request responses.
|
GeocodeRequest |
setMapViewport(GeoBoundingBox mapViewport)
Deprecated.
The map viewport is a bounding box of the map area currently visible to the user.
|
GeocodeRequest |
setSearchArea(GeoBoundingBox boundingArea)
Deprecated.
Sets the search area using a
GeoBoundingBox . |
GeocodeRequest |
setSearchArea(GeoCoordinate center,
int radius)
Deprecated.
Sets the search area using a center location and radius.
|
public GeocodeRequest(java.lang.String query) throws java.lang.IllegalArgumentException
Location
.query
- Query text specifying the address to locatejava.lang.IllegalArgumentException
- Upon a failure to handle a passed argument.public GeocodeRequest setSearchArea(GeoCoordinate center, int radius)
center
- TheGeoCoordinate
representing the search area center location.radius
- The search area circle radius in meters.GeocodeRequest
.public GeocodeRequest setSearchArea(GeoBoundingBox boundingArea)
GeoBoundingBox
.boundingArea
- TheGeoBoundingBox
representing the search area.GeocodeRequest
.public int getCollectionSize()
public GeocodeRequest setCollectionSize(int value)
value
- Desired response collection size per request.GeocodeRequest
objectpublic GeocodeRequest setMapViewport(GeoBoundingBox mapViewport)
mapViewport
- The bounding box of the map area currently visible.GeocodeRequest
object.public ErrorCode execute(ResultListener<java.util.List<Location>> listener)
listener
- A ResultListener
passed along with the request to monitor progressErrorCode
representing an appropriate result