Skip navigation links
A B C D E F G H I J K L M N O 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).
addBuildListener(BuildListener) - Method in class com.algolia.search.saas.MirroredIndex
Add a listener for build events.
addDataSelectionQuery(MirroredIndex.DataSelectionQuery) - Method in class com.algolia.search.saas.MirroredIndex
Add a data selection query to this index.
addObject(JSONObject, RequestOptions) - Method in class com.algolia.search.saas.Index
Adds an object in this index.
addObject(JSONObject, String, RequestOptions) - Method in class com.algolia.search.saas.Index
Adds an object in this index.
addObjectAsync(JSONObject, CompletionHandler) - Method in class com.algolia.search.saas.Index
Adds an object to this index (asynchronously).
addObjectAsync(JSONObject, String, CompletionHandler) - Method in class com.algolia.search.saas.Index
Adds an object to this index, assigning it the specified object ID (asynchronously).
addObjectAsync(JSONObject, String, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.Index
Adds an object to this index, assigning it the specified object ID (asynchronously).
addObjects(JSONArray, RequestOptions) - Method in class com.algolia.search.saas.Index
Adds several objects.
addObjectsAsync(JSONArray, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.Index
Adds several objects to this index (asynchronously).
addObjectsAsync(JSONArray, CompletionHandler) - Method in class com.algolia.search.saas.Index
Adds several objects to this index (asynchronously).
addSyncListener(SyncListener) - Method in class com.algolia.search.saas.MirroredIndex
Add a listener for sync events.
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, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.Client
Batch operations.
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).
browseAsync(Query, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.Index
Browse all index content (initial call).
browseAsync(Query, CompletionHandler) - Method in class com.algolia.search.saas.OfflineIndex
Browse all index content (initial call).
browseFromAsync(String, CompletionHandler) - Method in class com.algolia.search.saas.Index
Browse the index from a cursor.
browseFromAsync(String, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.Index
Browse the index from a cursor.
browseFromAsync(String, CompletionHandler) - Method in class com.algolia.search.saas.OfflineIndex
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(Index, Query, RequestOptions, 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.
browseMirrorAsync(Query, CompletionHandler) - Method in class com.algolia.search.saas.MirroredIndex
Browse the local mirror (initial call).
browseMirrorFromAsync(String, CompletionHandler) - Method in class com.algolia.search.saas.MirroredIndex
Browse the local mirror (subsequent calls).
build() - Method in class com.algolia.search.saas.AbstractQuery
Build the URL query parameter string representing this object.
buildDidFinish(MirroredIndex, Throwable) - Method in interface com.algolia.search.saas.BuildListener
Build of the local index has just finished.
buildDidStart(MirroredIndex) - Method in interface com.algolia.search.saas.BuildListener
Build of the local index has just started.
buildFromFiles(File, File[], CompletionHandler) - Method in class com.algolia.search.saas.OfflineIndex
Build the index from local data stored on the filesystem.
buildFromFiles(File, File...) - Method in class com.algolia.search.saas.OfflineIndex
 
buildFromRawResources(Resources, int, int[], CompletionHandler) - Method in class com.algolia.search.saas.OfflineIndex
Build the index from local data stored in raw resources.
buildFromRawResources(Resources, int, int...) - Method in class com.algolia.search.saas.OfflineIndex
 
BuildListener - Interface in com.algolia.search.saas
Listener for events related to index building.
buildOfflineFromFiles(File, File[], CompletionHandler) - Method in class com.algolia.search.saas.MirroredIndex
Replace the local mirror with local data stored on the filesystem.
buildOfflineFromFiles(File, File...) - Method in class com.algolia.search.saas.MirroredIndex
 
buildOfflineFromRawResources(Resources, int, int[], CompletionHandler) - Method in class com.algolia.search.saas.MirroredIndex
Replace the local mirror with local data stored in raw resources.
buildOfflineFromRawResources(Resources, int, int...) - Method in class com.algolia.search.saas.MirroredIndex
 

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.
clearIndex(RequestOptions) - Method in class com.algolia.search.saas.Index
Deletes the index content without removing settings and index specific API keys.
clearIndexAsync(CompletionHandler) - Method in class com.algolia.search.saas.Index
Clear this index.
clearIndexAsync(RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.Index
Clear this index.
clearIndexAsync(CompletionHandler) - Method in class com.algolia.search.saas.OfflineIndex.WriteTransaction
Delete the index content without removing settings.
clearIndexSync() - Method in class com.algolia.search.saas.OfflineIndex.WriteTransaction
Delete the index content without removing settings.
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
 
commitAsync(CompletionHandler) - Method in class com.algolia.search.saas.OfflineIndex.WriteTransaction
Commit the transaction.
commitSync() - Method in class com.algolia.search.saas.OfflineIndex.WriteTransaction
Commit the transaction (synchronously).
CompletionHandler - Interface in com.algolia.search.saas
Handles completion of an API request.
copyIndexAsync(String, String, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.Client
Copy an existing index.
copyIndexAsync(String, String, CompletionHandler) - Method in class com.algolia.search.saas.Client
Copy an existing index.

D

DataSelectionQuery(Query, int) - Constructor for class com.algolia.search.saas.MirroredIndex.DataSelectionQuery
 
DEFAULT_DELAY_BETWEEN_SYNCS - Static variable in class com.algolia.search.saas.MirroredIndex
Default minimum delay between two syncs (in milliseconds).
DEFAULT_OFFLINE_FALLBACK_TIMEOUT - Static variable in class com.algolia.search.saas.MirroredIndex
Default delay before launching an offline request (in milliseconds).
DEFAULT_SETTINGS_VERSION - Static variable in class com.algolia.search.saas.Index
 
deleteBy(Query) - Method in class com.algolia.search.saas.Index
Deletes all records matching the query.
deleteBy(Query, RequestOptions) - Method in class com.algolia.search.saas.Index
Deletes all records matching the query.
deleteByAsync(Query, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.Index
Deletes all objects matching a query (helper).
deleteByAsync(Query, CompletionHandler) - Method in class com.algolia.search.saas.Index
Deletes all objects matching a query (helper).
deleteByQuery(Query, RequestOptions) - Method in class com.algolia.search.saas.Index
Deprecated.
deleteByQueryAsync(Query, CompletionHandler) - Method in class com.algolia.search.saas.Index
deleteByQueryAsync(Query, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.Index
deleteByQueryAsync(Query, CompletionHandler) - Method in class com.algolia.search.saas.OfflineIndex
Delete all objects matching a query (helper).
deleteIndexAsync(String, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.Client
Delete an index.
deleteIndexAsync(String, CompletionHandler) - Method in class com.algolia.search.saas.Client
Delete an index.
deleteIndexOfflineAsync(String, CompletionHandler) - Method in class com.algolia.search.saas.OfflineClient
Delete an offline index.
deleteObject(String, RequestOptions) - Method in class com.algolia.search.saas.Index
Deletes an object from the index.
deleteObjectAsync(String, CompletionHandler) - Method in class com.algolia.search.saas.Index
Deletes an object from this index (asynchronously).
deleteObjectAsync(String, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.Index
Deletes an object from this index (asynchronously).
deleteObjectAsync(String, CompletionHandler) - Method in class com.algolia.search.saas.OfflineIndex.WriteTransaction
Delete an object.
deleteObjects(Collection<String>, RequestOptions) - Method in class com.algolia.search.saas.Index
Deletes several objects.
deleteObjectsAsync(Collection<String>, CompletionHandler) - Method in class com.algolia.search.saas.Index
Deletes several objects from this index (asynchronously).
deleteObjectsAsync(Collection<String>, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.Index
Deletes several objects from this index (asynchronously).
deleteObjectsAsync(Collection<String>, CompletionHandler) - Method in class com.algolia.search.saas.OfflineIndex.WriteTransaction
Delete multiple objects.
deleteObjectsSync(Collection<String>) - Method in class com.algolia.search.saas.OfflineIndex.WriteTransaction
Delete multiple objects (synchronously).
deleteObjectSync(String) - Method in class com.algolia.search.saas.OfflineIndex.WriteTransaction
Delete an object (synchronously).
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.
enableOfflineMode(String) - Method in class com.algolia.search.saas.OfflineClient
Enable the offline mode.
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.MirroredIndex.DataSelectionQuery
 
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
 
equals(Object) - Method in class com.algolia.search.saas.RequestOptions
 
execute(Runnable) - Method in class com.algolia.search.saas.helpers.HandlerExecutor
Execute a command, by posting it to the underlying handler.

F

finalize() - Method in class com.algolia.search.saas.OfflineIndex.WriteTransaction
 
fromString(String) - Static method in enum com.algolia.search.saas.Query.AlternativesAsExact
 
fromString(String) - Static method in enum com.algolia.search.saas.Query.ExactOnSingleWordQuery
 
fromString(String) - Static method in enum com.algolia.search.saas.Query.QueryType
 
fromString(String) - Static method in enum com.algolia.search.saas.Query.RemoveWordsIfNoResults
 
fromString(String) - Static method in enum com.algolia.search.saas.Query.SortFacetValuesBy
 
fromString(String) - Static method in enum com.algolia.search.saas.Query.TypoTolerance
 

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
 
getBuildTime() - Method in class com.algolia.search.saas.MirroredIndex.SyncStats
 
getByObjectID(String) - Method in class com.algolia.search.saas.places.PlacesClient
Get a place by its objectID.
getClickAnalytics() - Method in class com.algolia.search.saas.Query
 
getClient() - Method in class com.algolia.search.saas.Index
 
getClient() - Method in class com.algolia.search.saas.MirroredIndex
 
getClient() - Method in class com.algolia.search.saas.OfflineIndex
Get the client to which this index belongs.
getConnectTimeout() - Method in class com.algolia.search.saas.AbstractClient
Get the connection timeout.
getContext() - Method in class com.algolia.search.saas.OfflineClient
 
getCountries() - Method in class com.algolia.search.saas.places.PlacesQuery
 
getDataSelectionQueries() - Method in class com.algolia.search.saas.MirroredIndex
 
getDefaultDataDir() - Method in class com.algolia.search.saas.OfflineClient
Get the default data directory.
getDelayBetweenSyncs() - Method in class com.algolia.search.saas.MirroredIndex
 
getDelayBetweenSyncs(TimeUnit) - Method in class com.algolia.search.saas.MirroredIndex
Get the delay between two syncs.
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
 
getEnableRules() - 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
 
getFetchTime() - Method in class com.algolia.search.saas.MirroredIndex.SyncStats
 
getFileCount() - Method in class com.algolia.search.saas.MirroredIndex.SyncStats
 
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.
getHeader(String) - Method in class com.algolia.search.saas.RequestOptions
Get the value of a 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.
getId() - Method in class com.algolia.search.saas.OfflineIndex.WriteTransaction
Get this transaction's ID.
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).
getIndex(String) - Method in class com.algolia.search.saas.OfflineClient
Obtain a mirrored 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
 
getName() - Method in class com.algolia.search.saas.OfflineIndex
Get this index's name.
getNumericFilters() - Method in class com.algolia.search.saas.Query
Deprecated.
Use Query.getFilters() instead.
getObject(String, RequestOptions) - Method in class com.algolia.search.saas.Index
Gets an object from this index.
getObject(String, Collection<String>, RequestOptions) - Method in class com.algolia.search.saas.Index
Gets an object from this index.
getObjectAsync(String, CompletionHandler) - Method in class com.algolia.search.saas.Index
Gets an object from this index (asynchronously).
getObjectAsync(String, Collection<String>, CompletionHandler) - Method in class com.algolia.search.saas.Index
Gets an object from this index, optionally restricting the retrieved content (asynchronously).
getObjectAsync(String, Collection<String>, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.Index
Gets an object from this index, optionally restricting the retrieved content (asynchronously).
getObjectAsync(String, Collection<String>, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.MirroredIndex
Get an individual object from the online API, falling back to the local mirror in case of error (when enabled).
getObjectAsync(String, CompletionHandler) - Method in class com.algolia.search.saas.OfflineIndex
Get an object from this index (asynchronously).
getObjectAsync(String, List<String>, CompletionHandler) - Method in class com.algolia.search.saas.OfflineIndex
Get an object from this index, optionally restricting the retrieved content (asynchronously).
getObjectCount() - Method in class com.algolia.search.saas.MirroredIndex.SyncStats
 
getObjectOfflineAsync(String, List<String>, CompletionHandler) - Method in class com.algolia.search.saas.MirroredIndex
Get an individual object, explicitly targeting the offline mirror, not the online API.
getObjectOfflineAsync(String, CompletionHandler) - Method in class com.algolia.search.saas.MirroredIndex
Get an individual object, explicitly targeting the offline mirror, not the online API.
getObjectOnlineAsync(String, List<String>, CompletionHandler) - Method in class com.algolia.search.saas.MirroredIndex
Get an individual object, explicitly targeting the online API, not the offline mirror.
getObjectOnlineAsync(String, List<String>, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.MirroredIndex
Get an individual object, explicitly targeting the online API, not the offline mirror.
getObjectOnlineAsync(String, CompletionHandler) - Method in class com.algolia.search.saas.MirroredIndex
Get an individual object, explicitly targeting the online API, not the offline mirror.
getObjects(Collection<String>) - Method in class com.algolia.search.saas.Index
Gets several objects from this index.
getObjects(Collection<String>, Collection<String>, RequestOptions) - Method in class com.algolia.search.saas.Index
Gets several objects from this index.
getObjectsAsync(Collection<String>, CompletionHandler) - Method in class com.algolia.search.saas.Index
Gets several objects from this index (asynchronously).
getObjectsAsync(Collection<String>, List<String>, CompletionHandler) - Method in class com.algolia.search.saas.Index
Gets several objects from this index (asynchronously), optionally restricting the retrieved content (asynchronously).
getObjectsAsync(Collection<String>, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.Index
Gets several objects from this index (asynchronously), optionally restricting the retrieved content (asynchronously).
getObjectsAsync(Collection<String>, Collection<String>, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.Index
Gets several objects from this index (asynchronously), optionally restricting the retrieved content (asynchronously).
getObjectsAsync(Collection<String>, Collection<String>, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.MirroredIndex
Get individual objects from the online API, falling back to the local mirror in case of error (when enabled).
getObjectsAsync(List<String>, CompletionHandler) - Method in class com.algolia.search.saas.OfflineIndex
Get several objects from this index (asynchronously).
getObjectsOfflineAsync(List<String>, List<String>, CompletionHandler) - Method in class com.algolia.search.saas.MirroredIndex
Get individual objects, explicitly targeting the offline mirror, not the online API.
getObjectsOfflineAsync(List<String>, CompletionHandler) - Method in class com.algolia.search.saas.MirroredIndex
Get individual objects, explicitly targeting the offline mirror, not the online API.
getObjectsOnlineAsync(List<String>, List<String>, CompletionHandler) - Method in class com.algolia.search.saas.MirroredIndex
Get individual objects, explicitly targeting the online API, not the offline mirror.
getObjectsOnlineAsync(List<String>, List<String>, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.MirroredIndex
Get individual objects, explicitly targeting the online API, not the offline mirror.
getObjectsOnlineAsync(List<String>, CompletionHandler) - Method in class com.algolia.search.saas.MirroredIndex
Get individual objects, explicitly targeting the online API, not the offline mirror.
getOfflineFallbackTimeout() - Method in class com.algolia.search.saas.MirroredIndex
 
getOfflineIndex(String) - Method in class com.algolia.search.saas.OfflineClient
Obtain a purely offline index.
getOffset() - Method in class com.algolia.search.saas.Query
 
getOptionalFilters() - 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
 
getRawIndexName() - Method in class com.algolia.search.saas.Index
 
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
 
getRequestStrategy() - Method in class com.algolia.search.saas.MirroredIndex
 
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
 
getRootDataDir() - Method in class com.algolia.search.saas.OfflineClient
Get the path to directory where the local data is stored.
getRuleContexts() - Method in class com.algolia.search.saas.Query
 
getSearchTimeout() - Method in class com.algolia.search.saas.AbstractClient
Get the read timeout for search requests.
getSettings(RequestOptions) - Method in class com.algolia.search.saas.Index
Gets the settings of this index.
getSettings(int, RequestOptions) - Method in class com.algolia.search.saas.Index
Gets the settings of this index for a specific settings format.
getSettingsAsync(CompletionHandler) - Method in class com.algolia.search.saas.Index
Gets this index's settings (asynchronously).
getSettingsAsync(RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.Index
Gets this index's settings (asynchronously).
getSettingsAsync(CompletionHandler) - Method in class com.algolia.search.saas.OfflineIndex
Get this index's settings (asynchronously).
getSnippetEllipsisText() - Method in class com.algolia.search.saas.Query
 
getSortFacetValuesBy() - 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).
getSumOrFiltersScores() - Method in class com.algolia.search.saas.Query
 
getSynonyms() - Method in class com.algolia.search.saas.Query
 
getTagFilters() - Method in class com.algolia.search.saas.Query
 
getTotalTime() - Method in class com.algolia.search.saas.MirroredIndex.SyncStats
 
getType() - Method in class com.algolia.search.saas.places.PlacesQuery
 
getTypoTolerance() - Method in class com.algolia.search.saas.Query
 
getUrlParameter(String) - Method in class com.algolia.search.saas.RequestOptions
Get the value of a URL parameter.
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.
HandlerExecutor - Class in com.algolia.search.saas.helpers
Adapts an Android Handler into a JRE Executor.
HandlerExecutor(Handler) - Constructor for class com.algolia.search.saas.helpers.HandlerExecutor
Construct a new executor wrapping the specified handler.
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.MirroredIndex.DataSelectionQuery
 
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.
hasOfflineData() - Method in class com.algolia.search.saas.MirroredIndex
Test if this index has offline data on disk.
hasOfflineData(String) - Method in class com.algolia.search.saas.OfflineClient
Test if an index has offline data on disk.
hasOfflineData() - Method in class com.algolia.search.saas.OfflineIndex
Test if this index has offline data on disk.
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.
initIndex(String) - Method in class com.algolia.search.saas.OfflineClient
Deprecated.
You should now use OfflineClient.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 class com.algolia.search.saas.OfflineIndex.WriteTransaction
Test whether this transaction is finished.
isFinished() - Method in interface com.algolia.search.saas.Request
Test if this request is still running.
isMirrored() - Method in class com.algolia.search.saas.MirroredIndex
 
isTransient() - Method in exception com.algolia.search.saas.AlgoliaException
Test whether this error is transient.

J

JSON_KEY_ORIGIN - Static variable in class com.algolia.search.saas.MirroredIndex
Key used to indicate the origin of results in the returned JSON.
JSON_VALUE_ORIGIN_LOCAL - Static variable in class com.algolia.search.saas.MirroredIndex
Value for `JSON_KEY_ORIGIN` indicating that the results come from the local mirror.
JSON_VALUE_ORIGIN_REMOTE - Static variable in class com.algolia.search.saas.MirroredIndex
Value for `JSON_KEY_ORIGIN` indicating that the results come from the online API.

K

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

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(RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.Client
List existing indexes.
listIndexesAsync(CompletionHandler) - Method in class com.algolia.search.saas.Client
List existing indexes.
listIndexesOfflineAsync(CompletionHandler) - Method in class com.algolia.search.saas.OfflineClient
List existing offline indices.
lng - Variable in class com.algolia.search.saas.AbstractQuery.LatLng
 

M

maxObjects - Variable in class com.algolia.search.saas.MirroredIndex.DataSelectionQuery
Maximum number of objects to retrieve.
MirroredIndex - Class in com.algolia.search.saas
An online index that can also be mirrored locally.
MirroredIndex.DataSelectionQuery - Class in com.algolia.search.saas
A data selection query.
MirroredIndex.Strategy - Enum in com.algolia.search.saas
Strategy to choose between online and offline search.
MirroredIndex.SyncStats - Class in com.algolia.search.saas
Statistics about a sync.
moveIndexAsync(String, String, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.Client
Move an existing index.
moveIndexAsync(String, String, CompletionHandler) - Method in class com.algolia.search.saas.Client
Move an existing index.
moveIndexOfflineAsync(String, String, CompletionHandler) - Method in class com.algolia.search.saas.OfflineClient
Move an existing offline index.
multipleQueriesAsync(List<IndexQuery>, Client.MultipleQueriesStrategy, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.Client
Run multiple queries, potentially targeting multiple indexes, with one API call.
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(Collection<Query>, Client.MultipleQueriesStrategy, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.Index
Run multiple queries on this index with one API call.
multipleQueriesAsync(Collection<Query>, Client.MultipleQueriesStrategy, CompletionHandler) - Method in class com.algolia.search.saas.Index
Run multiple queries on this index with one API call.
multipleQueriesAsync(Collection<Query>, Client.MultipleQueriesStrategy, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.MirroredIndex
 
multipleQueriesAsync(List<Query>, Client.MultipleQueriesStrategy, CompletionHandler) - Method in class com.algolia.search.saas.OfflineIndex
Run multiple queries on this index with one API call.
multipleQueriesOfflineAsync(List<Query>, Client.MultipleQueriesStrategy, CompletionHandler) - Method in class com.algolia.search.saas.MirroredIndex
Run multiple queries on this index, explicitly targeting the offline mirror.
multipleQueriesOnlineAsync(List<Query>, Client.MultipleQueriesStrategy, CompletionHandler) - Method in class com.algolia.search.saas.MirroredIndex
Run multiple queries on this index, explicitly targeting the online API.
multipleQueriesOnlineAsync(List<Query>, Client.MultipleQueriesStrategy, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.MirroredIndex
Run multiple queries on this index, explicitly targeting the online API.

N

name - Variable in class com.algolia.search.saas.AbstractClient.LibraryVersion
 
newTransaction() - Method in class com.algolia.search.saas.OfflineIndex
Create a new write transaction.

O

OfflineClient - Class in com.algolia.search.saas
An API client that adds offline features on top of the regular online API client.
OfflineClient(Context, String, String) - Constructor for class com.algolia.search.saas.OfflineClient
Construct a new offline-enabled API client.
OfflineClient(Context, String, String, File) - Constructor for class com.algolia.search.saas.OfflineClient
Construct a new offline-enabled API client.
OfflineClient(Context, String, String, File, String[]) - Constructor for class com.algolia.search.saas.OfflineClient
Construct a new offline-enabled API client.
OfflineIndex - Class in com.algolia.search.saas
A purely offline index.
OfflineIndex.WriteTransaction - Class in com.algolia.search.saas
A transaction to update the index.

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
 
parseFrom(String) - Method in class com.algolia.search.saas.AbstractQuery
Parse a URL query parameter string and store the resulting parameters into this query.
parseLatLng(String) - Static method in class com.algolia.search.saas.AbstractQuery
Deprecated.
partialUpdateObject(JSONObject, String, Boolean, RequestOptions) - Method in class com.algolia.search.saas.Index
Update partially an object (only update attributes passed in argument).
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).
partialUpdateObjectAsync(JSONObject, String, boolean, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.Index
Partially update an object (asynchronously).
partialUpdateObjects(JSONArray, boolean, RequestOptions) - Method in class com.algolia.search.saas.Index
Partially Override the content of several objects.
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).
partialUpdateObjectsAsync(JSONArray, boolean, RequestOptions, 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](https://community.algolia.com/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(CharSequence) - 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 - Variable in class com.algolia.search.saas.MirroredIndex.DataSelectionQuery
Query parameters.
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(CharSequence) - 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.SortFacetValuesBy - 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
 
removeBuildListener(BuildListener) - Method in class com.algolia.search.saas.MirroredIndex
Remove a listener for build events.
removeSyncListener(SyncListener) - Method in class com.algolia.search.saas.MirroredIndex
Remove a listener for sync events.
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.
RequestOptions - Class in com.algolia.search.saas
Per-request options.
RequestOptions() - Constructor for class com.algolia.search.saas.RequestOptions
Construct empty request options.
rollbackAsync(CompletionHandler) - Method in class com.algolia.search.saas.OfflineIndex.WriteTransaction
Roll back the current write transaction.
rollbackSync() - Method in class com.algolia.search.saas.OfflineIndex.WriteTransaction
Rollback the transaction.

S

saveObject(JSONObject, String, RequestOptions) - Method in class com.algolia.search.saas.Index
Override the content of object.
saveObjectAsync(JSONObject, String, CompletionHandler) - Method in class com.algolia.search.saas.Index
Update an object (asynchronously).
saveObjectAsync(JSONObject, String, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.Index
Update an object (asynchronously).
saveObjectAsync(JSONObject, CompletionHandler) - Method in class com.algolia.search.saas.OfflineIndex.WriteTransaction
Save an object.
saveObjects(JSONArray, RequestOptions) - Method in class com.algolia.search.saas.Index
Override the content of several objects.
saveObjectsAsync(JSONArray, CompletionHandler) - Method in class com.algolia.search.saas.Index
Update several objects (asynchronously).
saveObjectsAsync(JSONArray, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.Index
Update several objects (asynchronously).
saveObjectsAsync(JSONArray, CompletionHandler) - Method in class com.algolia.search.saas.OfflineIndex.WriteTransaction
Save multiple objects.
saveObjectsSync(JSONArray) - Method in class com.algolia.search.saas.OfflineIndex.WriteTransaction
Save multiple objects (synchronously).
saveObjectSync(JSONObject) - Method in class com.algolia.search.saas.OfflineIndex.WriteTransaction
Save an object (synchronously).
search(Query, RequestOptions) - Method in class com.algolia.search.saas.Index
Searches inside the index.
Searchable - Class in com.algolia.search.saas
A searchable source of data
Searchable() - Constructor for class com.algolia.search.saas.Searchable
 
searchAsync(Query, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.Index
Searches inside this index (asynchronously).
searchAsync(Query, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.MirroredIndex
Search the online API, falling back to the local mirror if enabled in case of error.
searchAsync(Query, CompletionHandler) - Method in class com.algolia.search.saas.OfflineIndex
Search inside this index (asynchronously).
searchAsync(PlacesQuery, CompletionHandler) - Method in class com.algolia.search.saas.places.PlacesClient
Search for places.
searchAsync(Query, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.Searchable
Search inside this index (asynchronously).
searchAsync(Query, CompletionHandler) - Method in class com.algolia.search.saas.Searchable
Search inside this index (asynchronously).
searchDisjunctiveFacetingAsync(Query, Collection<String>, Map<String, T>, 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, Collection<String>, Map<String, ? extends Collection<String>>, RequestOptions, 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).
searchDisjunctiveFacetingAsync(Query, Collection<String>, Map<String, ? extends Collection<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).
searchDisjunctiveFacetingAsync(Query, List<String>, Map<String, List<String>>, CompletionHandler) - Method in class com.algolia.search.saas.OfflineIndex
Perform a search with disjunctive facets, generating as many queries as number of disjunctive facets (helper).
searchDisjunctiveFacetingAsync(Query, Collection<String>, Map<String, ? extends Collection<String>>, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.Searchable
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
searchForFacetValues(String, String, Query, CompletionHandler) - Method in class com.algolia.search.saas.Index
searchForFacetValuesAsync(String, String, CompletionHandler) - Method in class com.algolia.search.saas.Index
Searches (asynchronously) for some text in a facet values.
searchForFacetValuesAsync(String, String, Query, CompletionHandler) - Method in class com.algolia.search.saas.Index
Searches 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, Query, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.Index
Searches 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, Query, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.MirroredIndex
 
searchForFacetValuesAsync(String, String, Query, CompletionHandler) - Method in class com.algolia.search.saas.OfflineIndex
Search for facet values (asynchronously).
searchForFacetValuesAsync(String, String, Query, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.Searchable
Search for some text in a facet values, optionally restricting the returned values to those contained in objects matching other (regular) search criteria.
searchForFacetValuesOffline(String, String, Query, CompletionHandler) - Method in class com.algolia.search.saas.MirroredIndex
Search for facet values, explicitly targeting the offline mirror, not the online API.
searchForFacetValuesOnline(String, String, Query, CompletionHandler) - Method in class com.algolia.search.saas.MirroredIndex
Search for facet values, explicitly targeting the online API, not the offline mirror.
searchForFacetValuesOnline(String, String, Query, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.MirroredIndex
Search for facet values, explicitly targeting the online API, not the offline mirror.
searchOfflineAsync(Query, CompletionHandler) - Method in class com.algolia.search.saas.MirroredIndex
Search the local mirror.
searchOnlineAsync(Query, CompletionHandler) - Method in class com.algolia.search.saas.MirroredIndex
Search the online API.
searchOnlineAsync(Query, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.MirroredIndex
Search the online API.
searchSync(Query, RequestOptions) - Method in class com.algolia.search.saas.Index
Searches inside this index (synchronously).
searchSync(Query) - Method in class com.algolia.search.saas.Index
Searches 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(List<String>) - Method in class com.algolia.search.saas.Query
Deprecated.
setAttributesToHighlight(String...) - Method in class com.algolia.search.saas.Query
Specify the list of attribute names to highlight.
setAttributesToRetrieve(List<String>) - Method in class com.algolia.search.saas.Query
Deprecated.
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').
setClickAnalytics(Boolean) - Method in class com.algolia.search.saas.Query
 
setCompletionExecutor(Executor) - Method in class com.algolia.search.saas.AbstractClient
Change the executor on which completion handlers are executed.
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.
setDataSelectionQueries(MirroredIndex.DataSelectionQuery...) - Method in class com.algolia.search.saas.MirroredIndex
Replace all data selection queries associated to this index.
setDelayBetweenSyncs(long) - Method in class com.algolia.search.saas.MirroredIndex
Set the delay after which data is considered to be obsolete.
setDelayBetweenSyncs(long, TimeUnit) - Method in class com.algolia.search.saas.MirroredIndex
Set the delay after which data is considered to be obsolete.
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.
setEnableRules(Boolean) - Method in class com.algolia.search.saas.Query
 
setExactOnSingleWordQuery(Query.ExactOnSingleWordQuery) - Method in class com.algolia.search.saas.Query
 
setFacetFilters(JSONArray) - Method in class com.algolia.search.saas.Query
Deprecated.
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.
setHeader(String, String) - Method in class com.algolia.search.saas.RequestOptions
Set a HTTP header (untyped version).
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.
setMirrored(boolean) - Method in class com.algolia.search.saas.MirroredIndex
 
setNumericFilters(JSONArray) - Method in class com.algolia.search.saas.Query
Deprecated.
setOfflineFallbackTimeout(long) - Method in class com.algolia.search.saas.MirroredIndex
 
setOfflineFallbackTimeout(long, TimeUnit) - Method in class com.algolia.search.saas.MirroredIndex
 
setOffset(int) - Method in class com.algolia.search.saas.Query
Set the offset of the first hit to return (zero-based).
setOptionalFilters(String...) - Method in class com.algolia.search.saas.Query
Set a list of filters for ranking purposes, to rank higher records that contain the filter(s).
setOptionalWords(String...) - Method in class com.algolia.search.saas.Query
Set a 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(CharSequence) - Method in class com.algolia.search.saas.places.PlacesQuery
Set the full text query.
setQuery(CharSequence) - 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
 
setRequestStrategy(MirroredIndex.Strategy) - Method in class com.algolia.search.saas.MirroredIndex
 
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).
setRuleContexts(String...) - Method in class com.algolia.search.saas.Query
Set a list of contexts for which rules are enabled.
setSearchTimeout(int) - Method in class com.algolia.search.saas.AbstractClient
Set the read timeout for search requests.
setSettings(JSONObject, boolean, RequestOptions) - Method in class com.algolia.search.saas.Index
Set settings for this index.
setSettingsAsync(JSONObject, CompletionHandler) - Method in class com.algolia.search.saas.Index
Set this index's settings (asynchronously).
setSettingsAsync(JSONObject, boolean, RequestOptions, CompletionHandler) - Method in class com.algolia.search.saas.Index
Set this index's settings (asynchronously).
setSettingsAsync(JSONObject, CompletionHandler) - Method in class com.algolia.search.saas.OfflineIndex.WriteTransaction
Set the index settings.
setSettingsSync(JSONObject) - Method in class com.algolia.search.saas.OfflineIndex.WriteTransaction
Set the index settings (synchronously).
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).
setSortFacetValuesBy(Query.SortFacetValuesBy) - Method in class com.algolia.search.saas.Query
When using Query.setFacets(java.lang.String...), Algolia retrieves a list of matching facet values for each faceted attribute.
setSumOrFiltersScores(Boolean) - Method in class com.algolia.search.saas.Query
 
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
 
setUrlParameter(String, String) - Method in class com.algolia.search.saas.RequestOptions
Set a URL parameter (untyped version).
setWriteHosts(String...) - Method in class com.algolia.search.saas.AbstractClient
 
start() - Method in class com.algolia.search.saas.helpers.BrowseIterator
Start the iteration.
sync() - Method in class com.algolia.search.saas.MirroredIndex
Launch a sync.
syncDidFinish(MirroredIndex, Throwable, MirroredIndex.SyncStats) - Method in interface com.algolia.search.saas.SyncListener
Synchronization has just finished.
syncDidStart(MirroredIndex) - Method in interface com.algolia.search.saas.SyncListener
Synchronization has just started.
syncIfNeeded() - Method in class com.algolia.search.saas.MirroredIndex
Launch a sync only if the data is obsolete.
SyncListener - Interface in com.algolia.search.saas
Listener for sync-related events.
SyncStats() - Constructor for class com.algolia.search.saas.MirroredIndex.SyncStats
 

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.MirroredIndex.SyncStats
 
toString() - Method in class com.algolia.search.saas.OfflineIndex
 
toString() - Method in class com.algolia.search.saas.OfflineIndex.WriteTransaction
 
toString() - Method in class com.algolia.search.saas.Query.IgnorePlurals
 
toString() - Method in class com.algolia.search.saas.Query.Polygon
 
toString() - Method in class com.algolia.search.saas.RequestOptions
 
toString() - Method in class com.algolia.search.saas.Searchable
If you override this please be sure it returns a unique string per instance

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.MirroredIndex.Strategy
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.SortFacetValuesBy
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.MirroredIndex.Strategy
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.SortFacetValuesBy
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

waitTask(String, long) - Method in class com.algolia.search.saas.Index
Wait the publication of a task on the server.
waitTask(String) - Method in class com.algolia.search.saas.Index
Waits for the publication of a task on the server.
waitTaskAsync(String, CompletionHandler) - Method in class com.algolia.search.saas.Index
Wait until the publication of a task on the server (helper).
waitTaskAsync(long, CompletionHandler) - Method in class com.algolia.search.saas.Index
Wait until the publication of a task on the server (helper).
WriteTransaction() - Constructor for class com.algolia.search.saas.OfflineIndex.WriteTransaction
 
A B C D E F G H I J K L M N O P Q R S T V W 
Skip navigation links