AppSearchResult

@ExperimentalAppSearchApi
const val RESULT_ALREADY_EXISTS = 12: Int

The operation is invalid because the resource already exists and can't be replaced.

@ExperimentalAppSearchApi
const val RESULT_DENIED = 9: Int

The requested operation is denied for the caller. This error is logged and returned for denylist rejections.

const val RESULT_INTERNAL_ERROR = 2: Int

An internal error occurred within AppSearch, which the caller cannot address. This error may be considered similar to IllegalStateException

const val RESULT_INVALID_ARGUMENT = 3: Int

The caller supplied invalid arguments to the call. This error may be considered similar to IllegalArgumentException.

const val RESULT_INVALID_SCHEMA = 7: Int

The caller supplied a schema which is invalid or incompatible with the previous schema.

const val RESULT_IO_ERROR = 4: Int

An issue occurred reading or writing to storage. The call might succeed if repeated. This error may be considered similar to java.io.IOException.

const val RESULT_NOT_FOUND = 6: Int

An entity the caller requested to interact with does not exist in the system.

const val RESULT_OK = 0: Int

The call was successful.

const val RESULT_OUT_OF_SPACE = 5: Int

Storage is out of space, and no more space could be reclaimed.

@ExperimentalAppSearchApi
const val RESULT_RATE_LIMITED = 10: Int

The caller has hit AppSearch's rate limit and the requested operation has been rejected. The caller is recommended to reschedule tasks with exponential backoff.

const val RESULT_SECURITY_ERROR = 8: Int

The caller requested an operation it does not have privileges for.

@ExperimentalAppSearchApi
const val RESULT_TIMED_OUT = 11: Int

The operation was timed out.

const val RESULT_UNKNOWN_ERROR = 1: Int

An unknown error occurred while processing the call.

fun getErrorMessage(): String?

Returns the error message associated with this result.

If isSuccess is true, the error message is always null. The error message may be null even if isSuccess is false. See the documentation of the particular AppSearchSession call producing this AppSearchResult for what is returned by getErrorMessage.

fun getResultCode(): Int

Returns one of the RESULT constants defined in AppSearchResult.

fun getResultValue(): ValueType?

Returns the result value associated with this result, if it was successful.

See the documentation of the particular AppSearchSession call producing this AppSearchResult for what is placed in the result value by that call.

fun isSuccess(): Boolean

Returns true if getResultCode equals RESULT_OK.

java-static fun <ValueType> newFailedResult(resultCode: Int, errorMessage: String?): AppSearchResult<ValueType!>

Creates a new failed AppSearchResult.

java-static fun <ValueType> newSuccessfulResult(value: ValueType?): AppSearchResult<ValueType!>

Creates a new successful AppSearchResult.