OfflineSearchIndex.Error (API Reference)
Enum Class OfflineSearchIndex.Error
- All Implemented Interfaces:
Serializable,Comparable<OfflineSearchIndex.Error>,Constable
- Enclosing class:
- OfflineSearchIndex
Error corresponding to the offline search operation.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionUnable to generate index due to failed database operation.Internal error occurred.UnreachableSDKOptions.persistentMapStoragePathor lacking required permission to generate index inside.Failed to get installed regions in protected cache.Indexing operation cancelled due to OS killing the application or when a new indexing operation is invoked by SDK after finishing a map operation while the previous indexing operation was in progress. -
Method Summary
Modifier and TypeMethodDescriptionstatic OfflineSearchIndex.ErrorReturns the enum constant of this class with the specified name.static OfflineSearchIndex.Error[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
INVALID_PERSISTENT_PATH
Unreachable
SDKOptions.persistentMapStoragePathor lacking required permission to generate index inside. -
MAP_ERROR
Failed to get installed regions in protected cache. Any previous available index would be deleted when this error occurs. Use method
MapDownloader.getInitialPersistentMapStatusto get the status of the map and checkmaploader.PersistentMapStatusfor exact healing procedure for specific status. -
DATABASE_ERROR
Unable to generate index due to failed database operation. Any previous available index would be deleted when this error occurs. Call
MapDownloader.repairPersistentMapto retry index generation. -
OPERATION_CANCELLED
Indexing operation cancelled due to OS killing the application or when a new indexing operation is invoked by SDK after finishing a map operation while the previous indexing operation was in progress. Any previous available index would be deleted when this error occurs. In later case, SDK would finish the latest indexing operation successfully and it can be tracked through
OfflineSearchIndexListener, otherwise callMapDownloader.repairPersistentMapto retry index generation. -
INTERNAL_ERROR
Internal error occurred.
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum class has no constant with the specified nameNullPointerException- if the argument is null
-