A B C D E G H I L M N P Q R S T V W

A

AbstractClient - Class in com.algolia.search.saas

An abstract API client.

AbstractClient.LibraryVersion - Class in com.algolia.search.saas

A version of a software library.

AbstractQuery - Class in com.algolia.search.saas

An abstract search query.

AbstractQuery.LatLng - Class in com.algolia.search.saas

A pair of (latitude, longitude).

addObjectAsync(JSONObject, CompletionHandler) - Method in class com.algolia.search.saas.Index

Add an object to this index (asynchronously).

addObjectAsync(JSONObject, String, CompletionHandler) - Method in class com.algolia.search.saas.Index

Add an object to this index, assigning it the specified object ID (asynchronously).

addObjectsAsync(JSONArray, CompletionHandler) - Method in class com.algolia.search.saas.Index

Add several objects to this index (asynchronously).

addUserAgent(AbstractClient.LibraryVersion) - Method in class com.algolia.search.saas.AbstractClient

Add a software library to the list of user agents.

AlgoliaException - Exception in com.algolia.search.saas

Any error that was encountered during the processing of a request.

AlgoliaException(String) - Constructor for exception com.algolia.search.saas.AlgoliaException

AlgoliaException(String, Throwable) - Constructor for exception com.algolia.search.saas.AlgoliaException

AlgoliaException(String, int) - Constructor for exception com.algolia.search.saas.AlgoliaException

B

batchAsync(JSONArray, CompletionHandler) - Method in class com.algolia.search.saas.Client

Batch operations.

browseAsync(Query, CompletionHandler) - Method in class com.algolia.search.saas.Index

Browse all index content (initial call).

browseFromAsync(String, CompletionHandler) - Method in class com.algolia.search.saas.Index

Browse the index from a cursor.

BrowseIterator - Class in com.algolia.search.saas.helpers

Iterator to browse all index content.

BrowseIterator(Index, Query, BrowseIterator.BrowseIteratorHandler) - Constructor for class com.algolia.search.saas.helpers.BrowseIterator

Construct a new browse iterator.

BrowseIterator.BrowseIteratorHandler - Interface in com.algolia.search.saas.helpers

Listener for BrowseIterator.

build() - Method in class com.algolia.search.saas.AbstractQuery

Build the URL query parameter string representing this object.

C

cancel() - Method in class com.algolia.search.saas.helpers.BrowseIterator

Cancel the iteration.

cancel() - Method in interface com.algolia.search.saas.Request

Cancel this request.

clearIndexAsync(CompletionHandler) - Method in class com.algolia.search.saas.Index

Clear this index.

clearSearchCache() - Method in class com.algolia.search.saas.Index

Remove all entries from cache

Client - Class in com.algolia.search.saas

Entry point to the Android API.

Client(String, String) - Constructor for class com.algolia.search.saas.Client

Create a new Algolia Search client targeting the default hosts.

Client(String, String, String[]) - Constructor for class com.algolia.search.saas.Client

Create a new Algolia Search client with explicit hosts to target.

Client.MultipleQueriesStrategy - Enum in com.algolia.search.saas

Strategy when running multiple queries.

com.algolia.search.saas - package com.algolia.search.saas

com.algolia.search.saas.helpers - package com.algolia.search.saas.helpers

com.algolia.search.saas.places - package com.algolia.search.saas.places

CompletionHandler - Interface in com.algolia.search.saas

Handles completion of an API request.

copyIndexAsync(String, String, CompletionHandler) - Method in class com.algolia.search.saas.Client

Copy an existing index.

D

DEFAULT_SETTINGS_VERSION - Static variable in class com.algolia.search.saas.Index

deleteByQueryAsync(Query, CompletionHandler) - Method in class com.algolia.search.saas.Index

Delete all objects matching a query (helper).

deleteIndexAsync(String, CompletionHandler) - Method in class com.algolia.search.saas.Client

Delete an index.

deleteObjectAsync(String, CompletionHandler) - Method in class com.algolia.search.saas.Index

Delete an object from this index (asynchronously).

deleteObjectsAsync(List<String>, CompletionHandler) - Method in class com.algolia.search.saas.Index

Delete several objects from this index (asynchronously).

disableSearchCache() - Method in class com.algolia.search.saas.Index

Disable and reset cache

DisjunctiveFaceting - Class in com.algolia.search.saas.helpers

Disjunctive faceting helper.

DisjunctiveFaceting() - Constructor for class com.algolia.search.saas.helpers.DisjunctiveFaceting

E

enabled - Variable in class com.algolia.search.saas.Query.IgnorePlurals

Whether plurals are ignored.

enableSearchCache() - Method in class com.algolia.search.saas.Index

Enable search cache with default parameters

enableSearchCache(int, int) - Method in class com.algolia.search.saas.Index

Enable search cache with custom parameters

equals(Object) - Method in class com.algolia.search.saas.AbstractClient.LibraryVersion

equals(Object) - Method in class com.algolia.search.saas.AbstractQuery

equals(Object) - Method in class com.algolia.search.saas.AbstractQuery.LatLng

equals(Object) - Method in class com.algolia.search.saas.Query.GeoRect

equals(Object) - Method in class com.algolia.search.saas.Query.IgnorePlurals

equals(Object) - Method in class com.algolia.search.saas.Query.Polygon

G

GeoRect(AbstractQuery.LatLng, AbstractQuery.LatLng) - Constructor for class com.algolia.search.saas.Query.GeoRect

get(String) - Method in class com.algolia.search.saas.AbstractQuery

Get a parameter in an untyped fashion.

getAdvancedSyntax() - Method in class com.algolia.search.saas.Query

getAllowTyposOnNumericTokens() - Method in class com.algolia.search.saas.Query

getAlternativesAsExact() - Method in class com.algolia.search.saas.Query

getAnalytics() - Method in class com.algolia.search.saas.Query

getAnalyticsTags() - Method in class com.algolia.search.saas.Query

getApplicationID() - Method in class com.algolia.search.saas.AbstractClient

getApplicationID() - Method in class com.algolia.search.saas.Client

getAroundLatLng() - Method in class com.algolia.search.saas.places.PlacesQuery

getAroundLatLng() - Method in class com.algolia.search.saas.Query

getAroundLatLngViaIP() - Method in class com.algolia.search.saas.places.PlacesQuery

getAroundLatLngViaIP() - Method in class com.algolia.search.saas.Query

getAroundPrecision() - Method in class com.algolia.search.saas.Query

getAroundRadius() - Method in class com.algolia.search.saas.places.PlacesQuery

Get the current radius for around latitude/longitude queries.

getAroundRadius() - Method in class com.algolia.search.saas.Query

Get the current radius for around latitude/longitude queries.

getAttributesToHighlight() - Method in class com.algolia.search.saas.Query

getAttributesToRetrieve() - Method in class com.algolia.search.saas.Query

getAttributesToSnippet() - Method in class com.algolia.search.saas.Query

getClient() - Method in class com.algolia.search.saas.Index

getConnectTimeout() - Method in class com.algolia.search.saas.AbstractClient

Get the connection timeout.

getCountries() - Method in class com.algolia.search.saas.places.PlacesQuery

getDisableExactOnAttributes() - Method in class com.algolia.search.saas.Query

getDisableTypoToleranceOnAttributes() - Method in class com.algolia.search.saas.Query

getDistinct() - Method in class com.algolia.search.saas.Query

getExactOnSingleWordQuery() - Method in class com.algolia.search.saas.Query

getFacetFilters() - Method in class com.algolia.search.saas.Query

Deprecated.

Use Query.getFilters() instead.

getFacetingAfterDistinct() - Method in class com.algolia.search.saas.Query

getFacets() - Method in class com.algolia.search.saas.Query

getFilters() - Method in class com.algolia.search.saas.Query

Get the numeric, facet or/and tag filters for this Query.

getGetRankingInfo() - Method in class com.algolia.search.saas.Query

getHeader(String) - Method in class com.algolia.search.saas.AbstractClient

Get an HTTP header.

getHighlightPostTag() - Method in class com.algolia.search.saas.places.PlacesQuery

getHighlightPostTag() - Method in class com.algolia.search.saas.Query

getHighlightPreTag() - Method in class com.algolia.search.saas.places.PlacesQuery

getHighlightPreTag() - Method in class com.algolia.search.saas.Query

getHitsPerPage() - Method in class com.algolia.search.saas.places.PlacesQuery

getHitsPerPage() - Method in class com.algolia.search.saas.Query

getHostDownDelay() - Method in class com.algolia.search.saas.AbstractClient

Get the timeout for retrying connection to a down host.

getIgnorePlurals() - Method in class com.algolia.search.saas.Query

getIndex(String) - Method in class com.algolia.search.saas.Client

Obtain a proxy to an Algolia index (no server call required by this method).

getIndexName() - Method in class com.algolia.search.saas.Index

getIndexName() - Method in class com.algolia.search.saas.IndexQuery

getInsideBoundingBox() - Method in class com.algolia.search.saas.Query

getInsidePolygon() - Method in class com.algolia.search.saas.Query

getLanguage() - Method in class com.algolia.search.saas.places.PlacesQuery

getLength() - Method in class com.algolia.search.saas.Query

getMaxFacetHits() - Method in class com.algolia.search.saas.Query

getMaxValuesPerFacet() - Method in class com.algolia.search.saas.Query

getMinimumAroundRadius() - Method in class com.algolia.search.saas.Query

getMinProximity() - Method in class com.algolia.search.saas.Query

getMinWordSizefor1Typo() - Method in class com.algolia.search.saas.Query

getMinWordSizefor2Typos() - Method in class com.algolia.search.saas.Query

getNumericFilters() - Method in class com.algolia.search.saas.Query

Deprecated.

Use Query.getFilters() instead.

getObjectAsync(String, CompletionHandler) - Method in class com.algolia.search.saas.Index

Get an object from this index (asynchronously).

getObjectAsync(String, List<String>, CompletionHandler) - Method in class com.algolia.search.saas.Index

Get an object from this index, optionally restricting the retrieved content (asynchronously).

getObjectsAsync(List<String>, CompletionHandler) - Method in class com.algolia.search.saas.Index

Get several objects from this index (asynchronously).

getObjectsAsync(List<String>, List<String>, CompletionHandler) - Method in class com.algolia.search.saas.Index

Get several objects from this index (asynchronously), optionally restricting the retrieved content (asynchronously).

getOffset() - Method in class com.algolia.search.saas.Query

getOptionalWords() - Method in class com.algolia.search.saas.Query

getPage() - Method in class com.algolia.search.saas.Query

getPercentileComputation() - Method in class com.algolia.search.saas.Query

getQuery() - Method in class com.algolia.search.saas.IndexQuery

getQuery() - Method in class com.algolia.search.saas.places.PlacesQuery

getQuery() - Method in class com.algolia.search.saas.Query

getQueryType() - Method in class com.algolia.search.saas.Query

getReadHosts() - Method in class com.algolia.search.saas.AbstractClient

getReadTimeout() - Method in class com.algolia.search.saas.AbstractClient

Get the default read timeout.

getRemoveStopWords() - Method in class com.algolia.search.saas.Query

getRemoveWordsIfNoResults() - Method in class com.algolia.search.saas.Query

getReplaceSynonymsInHighlight() - Method in class com.algolia.search.saas.Query

getResponseFields() - Method in class com.algolia.search.saas.Query

Get the fields the response will contain.

getRestrictHighlightAndSnippetArrays() - Method in class com.algolia.search.saas.Query

getRestrictSearchableAttributes() - Method in class com.algolia.search.saas.Query

getSearchTimeout() - Method in class com.algolia.search.saas.AbstractClient

Get the read timeout for search requests.

getSettingsAsync(CompletionHandler) - Method in class com.algolia.search.saas.Index

Get this index’s settings (asynchronously).

getSnippetEllipsisText() - Method in class com.algolia.search.saas.Query

getStatusCode() - Method in exception com.algolia.search.saas.AlgoliaException

Get the error’s HTTP status code (if any).

getSynonyms() - Method in class com.algolia.search.saas.Query

getTagFilters() - Method in class com.algolia.search.saas.Query

getType() - Method in class com.algolia.search.saas.places.PlacesQuery

getTypoTolerance() - Method in class com.algolia.search.saas.Query

getUserAgents() - Method in class com.algolia.search.saas.AbstractClient

Retrieve the list of declared user agents.

getWriteHosts() - Method in class com.algolia.search.saas.AbstractClient

H

handleBatch(BrowseIterator, JSONObject, AlgoliaException) - Method in interface com.algolia.search.saas.helpers.BrowseIterator.BrowseIteratorHandler

Called at each batch of results.

hashCode() - Method in class com.algolia.search.saas.AbstractClient.LibraryVersion

hashCode() - Method in class com.algolia.search.saas.AbstractQuery

hashCode() - Method in class com.algolia.search.saas.AbstractQuery.LatLng

hashCode() - Method in class com.algolia.search.saas.Query.GeoRect

hashCode() - Method in class com.algolia.search.saas.Query.IgnorePlurals

hashCode() - Method in class com.algolia.search.saas.Query.Polygon

hasNext() - Method in class com.algolia.search.saas.helpers.BrowseIterator

Determine if there is more content to be browsed.

hasUserAgent(AbstractClient.LibraryVersion) - Method in class com.algolia.search.saas.AbstractClient

Test whether a user agent is declared.

I

IgnorePlurals(boolean) - Constructor for class com.algolia.search.saas.Query.IgnorePlurals

Construct an IgnorePlurals object for a boolean value.

IgnorePlurals(Collection<String>) - Constructor for class com.algolia.search.saas.Query.IgnorePlurals

Construct an IgnorePlurals object for a Collection of language codes.

IgnorePlurals(String...) - Constructor for class com.algolia.search.saas.Query.IgnorePlurals

Construct an IgnorePlurals object for some language codes.

Index - Class in com.algolia.search.saas

A proxy to an Algolia index.

IndexQuery - Class in com.algolia.search.saas

A search query targeting a specific index.

IndexQuery(String, Query) - Constructor for class com.algolia.search.saas.IndexQuery

IndexQuery(Index, Query) - Constructor for class com.algolia.search.saas.IndexQuery

initIndex(String) - Method in class com.algolia.search.saas.Client

Deprecated.

You should now use Client.getIndex(String), which re-uses instances with the same name.

isCancelled() - Method in interface com.algolia.search.saas.Request

Test if this request has been cancelled.

isFinished() - Method in interface com.algolia.search.saas.Request

Test if this request is still running.

isTransient() - Method in exception com.algolia.search.saas.AlgoliaException

Test whether this error is transient.

L

languageCodes - Variable in class com.algolia.search.saas.Query.IgnorePlurals

A list containing every active language’s code.

lat - Variable in class com.algolia.search.saas.AbstractQuery.LatLng

LatLng(double, double) - Constructor for class com.algolia.search.saas.AbstractQuery.LatLng

LibraryVersion(String, String) - Constructor for class com.algolia.search.saas.AbstractClient.LibraryVersion

listIndexesAsync(CompletionHandler) - Method in class com.algolia.search.saas.Client

List existing indexes.

lng - Variable in class com.algolia.search.saas.AbstractQuery.LatLng

M

moveIndexAsync(String, String, CompletionHandler) - Method in class com.algolia.search.saas.Client

Move an existing index.

multipleQueriesAsync(List<IndexQuery>, Client.MultipleQueriesStrategy, CompletionHandler) - Method in class com.algolia.search.saas.Client

Run multiple queries, potentially targeting multiple indexes, with one API call.

multipleQueriesAsync(List<Query>, Client.MultipleQueriesStrategy, CompletionHandler) - Method in class com.algolia.search.saas.Index

Run multiple queries on this index with one API call.

N

name - Variable in class com.algolia.search.saas.AbstractClient.LibraryVersion

P

p1 - Variable in class com.algolia.search.saas.Query.GeoRect

p2 - Variable in class com.algolia.search.saas.Query.GeoRect

parse(String) - Static method in class com.algolia.search.saas.AbstractQuery.LatLng

Parse a LatLng from its string representation.

parse(String) - Static method in class com.algolia.search.saas.Query.Polygon

parseLatLng(String) - Static method in class com.algolia.search.saas.AbstractQuery

Deprecated.

Please use AbstractQuery.LatLng.parse(String) instead.

partialUpdateObjectAsync(JSONObject, String, CompletionHandler) - Method in class com.algolia.search.saas.Index

Partially update an object (asynchronously).

partialUpdateObjectAsync(JSONObject, String, boolean, CompletionHandler) - Method in class com.algolia.search.saas.Index

Partially update an object (asynchronously).

partialUpdateObjectsAsync(JSONArray, CompletionHandler) - Method in class com.algolia.search.saas.Index

Partially update several objects (asynchronously).

partialUpdateObjectsAsync(JSONArray, boolean, CompletionHandler) - Method in class com.algolia.search.saas.Index

Partially update several objects (asynchronously).

PlacesClient - Class in com.algolia.search.saas.places

Client for Algolia Places.

PlacesClient(String, String) - Constructor for class com.algolia.search.saas.places.PlacesClient

Create a new authenticated Algolia Places client.

PlacesClient() - Constructor for class com.algolia.search.saas.places.PlacesClient

Create a new unauthenticated Algolia Places client.

PlacesQuery - Class in com.algolia.search.saas.places

Search parameters for Algolia Places.

PlacesQuery() - Constructor for class com.algolia.search.saas.places.PlacesQuery

Construct an empty query.

PlacesQuery(String) - Constructor for class com.algolia.search.saas.places.PlacesQuery

Construct a query with the specified full text query.

PlacesQuery(PlacesQuery) - Constructor for class com.algolia.search.saas.places.PlacesQuery

Clone an existing query.

PlacesQuery.Type - Enum in com.algolia.search.saas.places

Types of places that can be searched for.

points - Variable in class com.algolia.search.saas.Query.Polygon

Polygon(AbstractQuery.LatLng...) - Constructor for class com.algolia.search.saas.Query.Polygon

Polygon(String) - Constructor for class com.algolia.search.saas.Query.Polygon

Polygon(Query.Polygon) - Constructor for class com.algolia.search.saas.Query.Polygon

Q

Query - Class in com.algolia.search.saas

Describes all parameters of a search query.

Query() - Constructor for class com.algolia.search.saas.Query

Construct an empty query.

Query(String) - Constructor for class com.algolia.search.saas.Query

Construct a query with the specified query text.

Query(Query) - Constructor for class com.algolia.search.saas.Query

Clone an existing query.

Query.AlternativesAsExact - Enum in com.algolia.search.saas

Query.ExactOnSingleWordQuery - Enum in com.algolia.search.saas

Query.GeoRect - Class in com.algolia.search.saas

A rectangle in geo coordinates.

Query.IgnorePlurals - Class in com.algolia.search.saas

A value of the ignorePlurals setting.

Query.Polygon - Class in com.algolia.search.saas

A polygon in geo coordinates.

Query.QueryType - Enum in com.algolia.search.saas

Query.RemoveWordsIfNoResults - Enum in com.algolia.search.saas

Query.TypoTolerance - Enum in com.algolia.search.saas

R

RADIUS_ALL - Static variable in class com.algolia.search.saas.places.PlacesQuery

RADIUS_ALL - Static variable in class com.algolia.search.saas.Query

removeUserAgent(AbstractClient.LibraryVersion) - Method in class com.algolia.search.saas.AbstractClient

Remove a software library from the list of user agents.

Request - Interface in com.algolia.search.saas

An API request.

requestCompleted(JSONObject, AlgoliaException) - Method in interface com.algolia.search.saas.CompletionHandler

Called when the request has completed, either successfully or failing.

S

saveObjectAsync(JSONObject, String, CompletionHandler) - Method in class com.algolia.search.saas.Index

Update an object (asynchronously).

saveObjectsAsync(JSONArray, CompletionHandler) - Method in class com.algolia.search.saas.Index

Update several objects (asynchronously).

searchAsync(Query, CompletionHandler) - Method in class com.algolia.search.saas.Index

Search inside this index (asynchronously).

searchAsync(PlacesQuery, CompletionHandler) - Method in class com.algolia.search.saas.places.PlacesClient

Search for places.

searchDisjunctiveFacetingAsync(Query, List<String>, Map<String, List<String>>, CompletionHandler) - Method in class com.algolia.search.saas.helpers.DisjunctiveFaceting

Perform a search with disjunctive facets, generating as many queries as number of disjunctive facets.

searchDisjunctiveFacetingAsync(Query, List<String>, Map<String, List<String>>, CompletionHandler) - Method in class com.algolia.search.saas.Index

Perform a search with disjunctive facets, generating as many queries as number of disjunctive facets (helper).

searchForFacetValues(String, String, CompletionHandler) - Method in class com.algolia.search.saas.Index

Search (asynchronously) for some text in a facet values.

searchForFacetValues(String, String, Query, CompletionHandler) - Method in class com.algolia.search.saas.Index

Search (asynchronously) for some text in a facet values, optionally restricting the returned values to those contained in objects matching other (regular) search criteria.

searchForFacetValuesAsync(String, String, CompletionHandler) - Method in class com.algolia.search.saas.Index

Search (asynchronously) for some text in a facet values.

searchForFacetValuesAsync(String, String, Query, CompletionHandler) - Method in class com.algolia.search.saas.Index

Search for some text in a facet values, optionally restricting the returned values to those contained in objects matching other (regular) search criteria.

searchSync(Query) - Method in class com.algolia.search.saas.Index

Search inside this index (synchronously).

set(String, Object) - Method in class com.algolia.search.saas.AbstractQuery

Set a parameter in an untyped fashion.

set(String, Object) - Method in class com.algolia.search.saas.places.PlacesQuery

Set a parameter in an untyped fashion.

set(String, Object) - Method in class com.algolia.search.saas.Query

Set a parameter in an untyped fashion.

setAdvancedSyntax(Boolean) - Method in class com.algolia.search.saas.Query

Enable the advanced query syntax.

setAllowTyposOnNumericTokens(Boolean) - Method in class com.algolia.search.saas.Query

setAlternativesAsExact(Query.AlternativesAsExact[]) - Method in class com.algolia.search.saas.Query

setAnalytics(Boolean) - Method in class com.algolia.search.saas.Query

setAnalyticsTags(String...) - Method in class com.algolia.search.saas.Query

setAroundLatLng(AbstractQuery.LatLng) - Method in class com.algolia.search.saas.places.PlacesQuery

Force to first search around a specific latitude/longitude.

setAroundLatLng(AbstractQuery.LatLng) - Method in class com.algolia.search.saas.Query

Search for entries around a given latitude/longitude.

setAroundLatLngViaIP(Boolean) - Method in class com.algolia.search.saas.places.PlacesQuery

Search first around the geolocation of the user found via his IP address.

setAroundLatLngViaIP(Boolean) - Method in class com.algolia.search.saas.Query

Search for entries around the latitude/longitude of user (using IP geolocation)

setAroundPrecision(Integer) - Method in class com.algolia.search.saas.Query

Change the radius or around latitude/longitude query

setAroundRadius(Integer) - Method in class com.algolia.search.saas.places.PlacesQuery

Change the radius for around latitude/longitude queries.

setAroundRadius(Integer) - Method in class com.algolia.search.saas.Query

Change the radius for around latitude/longitude queries.

setAttributesToHighlight(String...) - Method in class com.algolia.search.saas.Query

Specify the list of attribute names to highlight.

setAttributesToRetrieve(String...) - Method in class com.algolia.search.saas.Query

Specify the list of attribute names to retrieve.

setAttributesToSnippet(String...) - Method in class com.algolia.search.saas.Query

Specify the list of attribute names to Snippet alongside the number of words to return (syntax is ‘attributeName:nbWords’).

setConnectTimeout(int) - Method in class com.algolia.search.saas.AbstractClient

Set the connection timeout.

setCountries(String...) - Method in class com.algolia.search.saas.places.PlacesQuery

Restrict the search results to a specific list of countries.

setDisableExactOnAttributes(String...) - Method in class com.algolia.search.saas.Query

List of attributes on which you want to disable computation of the exact ranking criterion (must be a subset of the searchableAttributes index setting).

setDisableTypoToleranceOnAttributes(String...) - Method in class com.algolia.search.saas.Query

List of attributes on which you want to disable typo tolerance (must be a subset of the searchableAttributes index setting).

setDistinct(Integer) - Method in class com.algolia.search.saas.Query

This feature is similar to the distinct just before but instead of keeping the best value per value of attributeForDistinct, it allows to keep N values.

setExactOnSingleWordQuery(Query.ExactOnSingleWordQuery) - Method in class com.algolia.search.saas.Query

setFacetFilters(JSONArray) - Method in class com.algolia.search.saas.Query

Deprecated.

Use Query.setFilters(String) instead.

setFacetingAfterDistinct(Boolean) - Method in class com.algolia.search.saas.Query

Force faceting to be applied after de-duplication.

setFacets(String...) - Method in class com.algolia.search.saas.Query

List of object attributes that you want to use for faceting.

setFilters(String) - Method in class com.algolia.search.saas.Query

Filter the query with numeric, facet or/and tag filters.

setGetRankingInfo(Boolean) - Method in class com.algolia.search.saas.Query

if set, the result hits will contain ranking information in _rankingInfo attribute.

setHeader(String, String) - Method in class com.algolia.search.saas.AbstractClient

Set an HTTP header that will be sent with every request.

setHighlightPostTag(String) - Method in class com.algolia.search.saas.places.PlacesQuery

setHighlightPostTag(String) - Method in class com.algolia.search.saas.Query

setHighlightPreTag(String) - Method in class com.algolia.search.saas.places.PlacesQuery

setHighlightPreTag(String) - Method in class com.algolia.search.saas.Query

setHitsPerPage(Integer) - Method in class com.algolia.search.saas.places.PlacesQuery

Set how many results you want to retrieve per search.

setHitsPerPage(Integer) - Method in class com.algolia.search.saas.Query

Set the number of hits per page.

setHostDownDelay(int) - Method in class com.algolia.search.saas.AbstractClient

Set the timeout for retrying connection to a down host.

setHosts(String...) - Method in class com.algolia.search.saas.AbstractClient

Set read and write hosts to the same value (convenience method).

setIgnorePlurals(boolean) - Method in class com.algolia.search.saas.Query

If set to true, plural won’t be considered as a typo (for example car/cars will be considered as equals).

setIgnorePlurals(Collection<String>) - Method in class com.algolia.search.saas.Query

A list of language codes for which plural won’t be considered as a typo (for example car/cars will be considered as equals).

setIgnorePlurals(String...) - Method in class com.algolia.search.saas.Query

One or several language codes for which plural won’t be considered as a typo (for example car/cars will be considered as equals).

setInsideBoundingBox(Query.GeoRect...) - Method in class com.algolia.search.saas.Query

Search for entries inside one area or the union of several areas defined by the two extreme points of a rectangle.

setInsidePolygon(AbstractQuery.LatLng...) - Method in class com.algolia.search.saas.Query

Search for entries inside a given area defined by the points of a polygon.

setInsidePolygon(Query.Polygon...) - Method in class com.algolia.search.saas.Query

Search for entries inside a given area defined by several polygons.

setLanguage(String) - Method in class com.algolia.search.saas.places.PlacesQuery

Restrict the search results to a single language.

setLength(Integer) - Method in class com.algolia.search.saas.Query

Maximum number of hits to return.

setMaxFacetHits(Integer) - Method in class com.algolia.search.saas.Query

Limit the number of facet values returned for each facet.

setMaxValuesPerFacet(Integer) - Method in class com.algolia.search.saas.Query

Limit the number of facet values returned for each facet.

setMinimumAroundRadius(Integer) - Method in class com.algolia.search.saas.Query

Specify the minimum number of characters in a query word to accept one typo in this word.

setMinProximity(Integer) - Method in class com.algolia.search.saas.Query

Specify the minimum number of characters in a query word to accept one typo in this word.

setMinWordSizefor1Typo(Integer) - Method in class com.algolia.search.saas.Query

Specify the minimum number of characters in a query word to accept one typo in this word.

setMinWordSizefor2Typos(Integer) - Method in class com.algolia.search.saas.Query

Specify the minimum number of characters in a query word to accept one typo in this word.

setNumericFilters(JSONArray) - Method in class com.algolia.search.saas.Query

Deprecated.

Use Query.setFilters(String) instead.

setOffset(int) - Method in class com.algolia.search.saas.Query

Set the offset of the first hit to return (zero-based).

setOptionalWords(String...) - Method in class com.algolia.search.saas.Query

Set the list of words that should be considered as optional when found in the query.

setPage(Integer) - Method in class com.algolia.search.saas.Query

Set the page to retrieve (zero base).

setPercentileComputation(boolean) - Method in class com.algolia.search.saas.Query

Whether to include the query in processing time percentile computation.

setQuery(String) - Method in class com.algolia.search.saas.places.PlacesQuery

Set the full text query.

setQuery(String) - Method in class com.algolia.search.saas.Query

Set the full text query

setQueryType(Query.QueryType) - Method in class com.algolia.search.saas.Query

Select how the query words are interpreted:

setReadHosts(String...) - Method in class com.algolia.search.saas.AbstractClient

setReadTimeout(int) - Method in class com.algolia.search.saas.AbstractClient

Set the default read timeout.

setRemoveStopWords(Object) - Method in class com.algolia.search.saas.Query

Enable the removal of stop words, disabled by default.

setRemoveWordsIfNoResults(Query.RemoveWordsIfNoResults) - Method in class com.algolia.search.saas.Query

Select the strategy to adopt when a query does not return any result.

setReplaceSynonymsInHighlight(Boolean) - Method in class com.algolia.search.saas.Query

setResponseFields(String...) - Method in class com.algolia.search.saas.Query

Choose which fields the response will contain.

setRestrictHighlightAndSnippetArrays(boolean) - Method in class com.algolia.search.saas.Query

Restricts arrays in highlight and snippet results to items that matched the query.

setRestrictSearchableAttributes(String...) - Method in class com.algolia.search.saas.Query

List of object attributes you want to use for textual search (must be a subset of the searchableAttributes index setting).

setSearchTimeout(int) - Method in class com.algolia.search.saas.AbstractClient

Set the read timeout for search requests.

setSettingsAsync(JSONObject, CompletionHandler) - Method in class com.algolia.search.saas.Index

Set this index’s settings (asynchronously).

setSnippetEllipsisText(String) - Method in class com.algolia.search.saas.Query

Specify the string that is used as an ellipsis indicator when a snippet is truncated (defaults to the empty string).

setSynonyms(Boolean) - Method in class com.algolia.search.saas.Query

setTagFilters(JSONArray) - Method in class com.algolia.search.saas.Query

setType(PlacesQuery.Type) - Method in class com.algolia.search.saas.places.PlacesQuery

Set the type of place to search for.

setTypoTolerance(Query.TypoTolerance) - Method in class com.algolia.search.saas.Query

setWriteHosts(String...) - Method in class com.algolia.search.saas.AbstractClient

start() - Method in class com.algolia.search.saas.helpers.BrowseIterator

Start the iteration.

T

toString() - Method in class com.algolia.search.saas.AbstractQuery

Obtain a debug representation of this query.

toString() - Method in enum com.algolia.search.saas.Client.MultipleQueriesStrategy

toString() - Method in class com.algolia.search.saas.Index

toString() - Method in class com.algolia.search.saas.Query.IgnorePlurals

toString() - Method in class com.algolia.search.saas.Query.Polygon

V

valueOf(String) - Static method in enum com.algolia.search.saas.Client.MultipleQueriesStrategy

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.algolia.search.saas.places.PlacesQuery.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.algolia.search.saas.Query.AlternativesAsExact

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.algolia.search.saas.Query.ExactOnSingleWordQuery

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.algolia.search.saas.Query.QueryType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.algolia.search.saas.Query.RemoveWordsIfNoResults

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.algolia.search.saas.Query.TypoTolerance

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.algolia.search.saas.Client.MultipleQueriesStrategy

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.algolia.search.saas.places.PlacesQuery.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.algolia.search.saas.Query.AlternativesAsExact

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.algolia.search.saas.Query.ExactOnSingleWordQuery

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.algolia.search.saas.Query.QueryType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.algolia.search.saas.Query.RemoveWordsIfNoResults

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.algolia.search.saas.Query.TypoTolerance

Returns an array containing the constants of this enum type, in the order they are declared.

version - Variable in class com.algolia.search.saas.AbstractClient.LibraryVersion

W

waitTaskAsync(String, CompletionHandler) - Method in class com.algolia.search.saas.Index

Wait until the publication of a task on the server (helper).

A B C D E G H I L M N P Q R S T V W