com.algolia.search.saas.places

Class PlacesClient

Object

com.algolia.search.saas.AbstractClient

com.algolia.search.saas.places.PlacesClient

public class PlacesClient
extends AbstractClient

Client for [Algolia Places](https://community.algolia.com/places/).

Nested Class Summary

Nested classes/interfaces inherited from class com.algolia.search.saas.AbstractClient

AbstractClient.LibraryVersion

Constructor Summary

Constructors

Constructor and Description
PlacesClient() Create a new unauthenticated Algolia Places client.
PlacesClient(String applicationID, String apiKey) Create a new authenticated Algolia Places client.

Method Summary

Modifier and Type	Method and Description
JSONObject	getByObjectID(String objectID) Get a place by its objectID.
Request	searchAsync(PlacesQuery params, CompletionHandler completionHandler) Search for places.

Methods inherited from class com.algolia.search.saas.AbstractClient

addUserAgent, getApplicationID, getConnectTimeout, getHeader, getHostDownDelay, getReadHosts, getReadTimeout, getSearchTimeout, getUserAgents, getWriteHosts, hasUserAgent, removeUserAgent, setCompletionExecutor, setConnectTimeout, setHeader, setHostDownDelay, setHosts, setReadHosts, setReadTimeout, setSearchTimeout, setWriteHosts

Methods inherited from class Object

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

Constructor Detail

PlacesClient

public PlacesClient(@NonNull
                    String applicationID,
                    @NonNull
                    String apiKey)

Create a new authenticated Algolia Places client.

Parameters:

applicationID - The application ID (available in your Algolia Dashboard).

apiKey - A valid API key for the service.

PlacesClient

public PlacesClient()

Create a new unauthenticated Algolia Places client. NOTE: The rate limit for the unauthenticated API is significantly lower than for the authenticated API.

Method Detail

searchAsync

public Request searchAsync(@NonNull
                           PlacesQuery params,
                           @NonNull
                           CompletionHandler completionHandler)

Search for places.

Parameters:

params - Search parameters.

completionHandler - The listener that will be notified of the request's outcome.

Returns:

A cancellable request.

getByObjectID

public JSONObject getByObjectID(@NonNull
                                String objectID)
                         throws AlgoliaException

Get a place by its objectID.

Parameters:

objectID - the record's identifier.

Returns:

the corresponding record.

Throws:

AlgoliaException - when the given objectID does not exist.