com.google.maps

Class NearbySearchRequest

java.lang.Object

com.google.maps.NearbySearchRequest

All Implemented Interfaces:

PendingResult<PlacesSearchResponse>

public class NearbySearchRequest
extends java.lang.Object

A Nearby Search request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NearbySearchRequest.Response

Nested classes/interfaces inherited from interface com.google.maps.PendingResult

PendingResult.Callback<T>

Constructor Summary

Constructors

Constructor and Description
NearbySearchRequest(GeoApiContext context)

Method Summary

Modifier and Type	Method and Description
T	await() Performs the GET request synchronously.
T	awaitIgnoreError() Performs the request synchronously, ignoring exceptions while performing the request and errors returned by the server.
void	cancel() Attempt to cancel the request.
A	channel(java.lang.String channel) A channel to pass with the request.
A	custom(java.lang.String parameter, java.lang.String value) Custom parameter.
NearbySearchRequest	keyword(java.lang.String keyword) keyword is a term to be matched against all content that Google has indexed for this place, including but not limited to name, type, and address, as well as customer reviews and other third-party content.
A	language(java.lang.String language) The language in which to return results.
NearbySearchRequest	location(LatLng location) location is the latitude/longitude around which to retrieve place information.
NearbySearchRequest	maxPrice(PriceLevel priceLevel) maxPrice restricts to places that are at most this price level.
NearbySearchRequest	minPrice(PriceLevel priceLevel) minPrice restricts to places that are at least this price level.
NearbySearchRequest	name(java.lang.String name) name is one or more terms to be matched against the names of places, separated with a space character.
NearbySearchRequest	openNow(boolean openNow) openNow returns only those places that are open for business at the time the query is sent.
NearbySearchRequest	pageToken(java.lang.String nextPageToken) pageToken returns the next 20 results from a previously run search.
protected A	param(java.lang.String key, java.lang.String val)
protected A	param(java.lang.String key, com.google.maps.internal.StringJoin.UrlValue val)
protected java.util.Map<java.lang.String,java.lang.String>	params()
NearbySearchRequest	radius(int distance) radius defines the distance (in meters) within which to return place results.
NearbySearchRequest	rankby(RankBy ranking) rankby specifies the order in which results are listed.
void	setCallback(PendingResult.Callback<T> callback) Performs the request asynchronously, calling onResult or onFailure after the request has been completed.
NearbySearchRequest	type(PlaceType... types) type restricts the results to places matching the specified type.
NearbySearchRequest	type(PlaceType type) type restricts the results to places matching the specified type.
protected void	validateRequest()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NearbySearchRequest

public NearbySearchRequest(GeoApiContext context)

Method Detail

location

public NearbySearchRequest location(LatLng location)

location is the latitude/longitude around which to retrieve place information.

radius

public NearbySearchRequest radius(int distance)

radius defines the distance (in meters) within which to return place results. The maximum allowed radius is 50,000 meters. Note that radius must not be included if rankby=DISTANCE is specified.

rankby

public NearbySearchRequest rankby(RankBy ranking)

rankby specifies the order in which results are listed.

keyword

public NearbySearchRequest keyword(java.lang.String keyword)

keyword is a term to be matched against all content that Google has indexed for this place, including but not limited to name, type, and address, as well as customer reviews and other third-party content.

minPrice

public NearbySearchRequest minPrice(PriceLevel priceLevel)

minPrice restricts to places that are at least this price level.

maxPrice

public NearbySearchRequest maxPrice(PriceLevel priceLevel)

maxPrice restricts to places that are at most this price level.

name

public NearbySearchRequest name(java.lang.String name)

name is one or more terms to be matched against the names of places, separated with a space character.

openNow

public NearbySearchRequest openNow(boolean openNow)

openNow returns only those places that are open for business at the time the query is sent.

pageToken

public NearbySearchRequest pageToken(java.lang.String nextPageToken)

pageToken returns the next 20 results from a previously run search. Setting a pageToken parameter will execute a search with the same parameters used previously — all parameters other than pageToken will be ignored.

type

public NearbySearchRequest type(PlaceType type)

type restricts the results to places matching the specified type.

type

public NearbySearchRequest type(PlaceType... types)

type restricts the results to places matching the specified type. Provide support of multiples types.

validateRequest

protected void validateRequest()

setCallback

public final void setCallback(PendingResult.Callback<T> callback)

Description copied from interface: PendingResult

Performs the request asynchronously, calling onResult or onFailure after the request has been completed.

Specified by:

setCallback in interface PendingResult<T>

await

public final T await()
              throws ApiException,
                     java.lang.InterruptedException,
                     java.io.IOException

Description copied from interface: PendingResult

Performs the GET request synchronously.

Specified by:

await in interface PendingResult<T>

Returns:

The result.

Throws:

ApiException

java.lang.InterruptedException

java.io.IOException

awaitIgnoreError

public final T awaitIgnoreError()

Description copied from interface: PendingResult

Performs the request synchronously, ignoring exceptions while performing the request and errors returned by the server.

Specified by:

awaitIgnoreError in interface PendingResult<T>

Returns:

The result, or null if there was any error or exception ignored.

cancel

public final void cancel()

Description copied from interface: PendingResult

Attempt to cancel the request.

Specified by:

cancel in interface PendingResult<T>

param

protected A param(java.lang.String key,
                  java.lang.String val)

param

protected A param(java.lang.String key,
                  com.google.maps.internal.StringJoin.UrlValue val)

params

protected java.util.Map<java.lang.String,java.lang.String> params()

language

public final A language(java.lang.String language)

The language in which to return results. Note that we often update supported languages so this list may not be exhaustive.

Parameters:

language - The language code, e.g. "en-AU" or "es"

See Also:

List of supported domain languages

channel

public A channel(java.lang.String channel)

A channel to pass with the request. channel is used by Google Maps API for Work users to be able to track usage across different applications with the same clientID. See: https://developers.google.com/maps/documentation/business/clientside/quota

Parameters:

channel - String to pass with the request for analytics

custom

public A custom(java.lang.String parameter,
                java.lang.String value)

Custom parameter. For advanced usage only. Note: Using this escape hatch parameter pass though voids all warranties, only use in extreme circumstances.