com.algolia.search.saas

Class OfflineClient

Object

com.algolia.search.saas.AbstractClient

com.algolia.search.saas.Client

com.algolia.search.saas.OfflineClient

public class OfflineClient
extends Client

An API client that adds offline features on top of the regular online API client.

NOTE: Requires Algolia's SDK. The enableOfflineMode(String) method must be called with a valid license key prior to calling any offline-related method.

Nested Class Summary

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

Client.MultipleQueriesStrategy

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

AbstractClient.LibraryVersion

Constructor Summary

Constructors

Constructor and Description
OfflineClient(android.content.Context context, String applicationID, String apiKey) Construct a new offline-enabled API client.
OfflineClient(android.content.Context context, String applicationID, String apiKey, File dataDir) Construct a new offline-enabled API client.
OfflineClient(android.content.Context context, String applicationID, String apiKey, File dataDir, String[] hosts) Construct a new offline-enabled API client.

Method Summary

Modifier and Type	Method and Description
Request	deleteIndexOfflineAsync(String indexName, CompletionHandler completionHandler) Delete an offline index.
void	enableOfflineMode(String licenseData) Enable the offline mode.
android.content.Context	getContext()
File	getDefaultDataDir() Get the default data directory.
MirroredIndex	getIndex(String indexName) Obtain a mirrored index.
OfflineIndex	getOfflineIndex(String indexName) Obtain a purely offline index.
File	getRootDataDir() Get the path to directory where the local data is stored.
boolean	hasOfflineData(String name) Test if an index has offline data on disk.
MirroredIndex	initIndex(String indexName) Deprecated. You should now use getIndex(String), which re-uses instances with the same name.
Request	listIndexesOfflineAsync(CompletionHandler completionHandler) List existing offline indices.
Request	moveIndexOfflineAsync(String srcIndexName, String dstIndexName, CompletionHandler completionHandler) Move an existing offline index.

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

batchAsync, batchAsync, copyIndexAsync, copyIndexAsync, deleteIndexAsync, deleteIndexAsync, getApplicationID, listIndexesAsync, listIndexesAsync, moveIndexAsync, moveIndexAsync, multipleQueriesAsync, multipleQueriesAsync

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

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

Methods inherited from class Object

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

Constructor Detail

OfflineClient

public OfflineClient(@NonNull
                     android.content.Context context,
                     @NonNull
                     String applicationID,
                     @NonNull
                     String apiKey)

Construct a new offline-enabled API client.

Parameters:

context - An Android context.

applicationID - See Client.

apiKey - See Client.

OfflineClient

public OfflineClient(@NonNull
                     android.content.Context context,
                     @NonNull
                     String applicationID,
                     @NonNull
                     String apiKey,
                     File dataDir)

Construct a new offline-enabled API client.

Parameters:

context - An Android context.

applicationID - See Client.

apiKey - See Client.

dataDir - Path to the directory where the local data will be stored. If null, the default directory will be used. See getDefaultDataDir().

OfflineClient

public OfflineClient(@NonNull
                     android.content.Context context,
                     @NonNull
                     String applicationID,
                     @NonNull
                     String apiKey,
                     File dataDir,
                     String[] hosts)

Construct a new offline-enabled API client.

Parameters:

context - An Android context.

applicationID - See Client.

apiKey - See Client.

dataDir - Path to the directory where the local data will be stored. If null, the default directory will be used. See getDefaultDataDir().

hosts - See Client.

Method Detail

initIndex

public MirroredIndex initIndex(@NonNull
                               String indexName)

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

Create a new index. Although this will always be an instance of MirroredIndex, mirroring is deactivated by default.

Overrides:

initIndex in class Client

Parameters:

indexName - the name of index

Returns:

The newly created index.

getIndex

@NonNull
public MirroredIndex getIndex(@NonNull
                                       String indexName)

Obtain a mirrored index. Although this will always be an instance of MirroredIndex, mirroring is deactivated by default.

Overrides:

getIndex in class Client

Parameters:

indexName - The name of the index.

Returns:

A proxy to the specified index. **Warning:** The name should not overlap with any `OfflineIndex`. See getOfflineIndex(String).

getOfflineIndex

public OfflineIndex getOfflineIndex(@NonNull
                                    String indexName)

Obtain a purely offline index.

Parameters:

indexName - The name of the index.

Returns:

A proxy to the specified index. **Warning:** The name should not overlap with any `MirroredIndex`. See getIndex(String).

getRootDataDir

@NonNull
public File getRootDataDir()

Get the path to directory where the local data is stored.

enableOfflineMode

public void enableOfflineMode(@NonNull
                              String licenseData)

Enable the offline mode.

Parameters:

licenseData - License for Algolia's SDK.

getDefaultDataDir

public File getDefaultDataDir()

Get the default data directory. This is an "algolia" subdirectory inside the application's files directory.

Returns:

The default data directory.

getContext

@NonNull
public android.content.Context getContext()

hasOfflineData

public boolean hasOfflineData(@NonNull
                              String name)

Test if an index has offline data on disk. **Note:** This applies both to MirroredIndex and OfflineIndex instances. **Warning:** This method is synchronous!

Parameters:

name - The index's name.

Returns:

`true` if data exists on disk for this index, `false` otherwise.

listIndexesOfflineAsync

public Request listIndexesOfflineAsync(@NonNull
                                       CompletionHandler completionHandler)

List existing offline indices. Only indices that *actually exist* on disk are listed. If an instance was created but never synced or written to, it will not appear in the list. **Note:** This applies both to MirroredIndex and OfflineIndex instances.

Parameters:

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

Returns:

A cancellable request.

deleteIndexOfflineAsync

public Request deleteIndexOfflineAsync(@NonNull
                                       String indexName,
                                       CompletionHandler completionHandler)

Delete an offline index. This deletes the data on disk. If the index does not exist, this method does nothing. **Note:** This applies both to MirroredIndex and OfflineIndex instances.

Parameters:

indexName - Name of index to delete.

Returns:

A JSON object.

moveIndexOfflineAsync

public Request moveIndexOfflineAsync(@NonNull
                                     String srcIndexName,
                                     @NonNull
                                     String dstIndexName,
                                     CompletionHandler completionHandler)

Move an existing offline index. **Warning:** This will overwrite the destination index if it exists. **Note:** This applies both to MirroredIndex and OfflineIndex instances.

Parameters:

srcIndexName - Name of index to move.

dstIndexName - The new index name.

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

Returns:

A cancellable request.