# AppSearchResult Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary:[Constants](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#constants)\|[Methods](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#inhmethods) # AppSearchResult *** ** * ** *** [Kotlin](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult "View this page in Kotlin")\|Java ` public final class AppSearchResult ` ` extends `[Object](https://developer.android.com/reference/java/lang/Object)` `` ` |---|----------------------------------------------------| | [java.lang.Object](https://developer.android.com/reference/java/lang/Object) || | ↳ | android.app.appsearch.AppSearchResult\ |
*** ** * ** *** Information about the success or failure of an AppSearch call. ## Summary | ### Constants || |-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `int` | [RESULT_ALREADY_EXISTS](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_ALREADY_EXISTS) The operation is invalid because the resource already exists and can't be replaced. | | `int` | [RESULT_DENIED](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_DENIED) The requested operation is denied for the caller. | | `int` | [RESULT_INTERNAL_ERROR](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_INTERNAL_ERROR) An internal error occurred within AppSearch, which the caller cannot address. | | `int` | [RESULT_INVALID_ARGUMENT](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_INVALID_ARGUMENT) The caller supplied invalid arguments to the call. | | `int` | [RESULT_INVALID_SCHEMA](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_INVALID_SCHEMA) The caller supplied a schema which is invalid or incompatible with the previous schema. | | `int` | [RESULT_IO_ERROR](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_IO_ERROR) An issue occurred reading or writing to storage. | | `int` | [RESULT_NOT_FOUND](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_NOT_FOUND) An entity the caller requested to interact with does not exist in the system. | | `int` | [RESULT_OK](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_OK) The call was successful. | | `int` | [RESULT_OUT_OF_SPACE](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_OUT_OF_SPACE) Storage is out of space, and no more space could be reclaimed. | | `int` | [RESULT_RATE_LIMITED](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_RATE_LIMITED) The caller has hit AppSearch's rate limit and the requested operation has been rejected. | | `int` | [RESULT_SECURITY_ERROR](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_SECURITY_ERROR) The caller requested an operation it does not have privileges for. | | `int` | [RESULT_UNKNOWN_ERROR](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_UNKNOWN_ERROR) An unknown error occurred while processing the call. | | ### Public methods || |-------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` boolean` | ` `[equals](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` other) ` Indicates whether some other object is "equal to" this one. | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[getErrorMessage](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#getErrorMessage())`() ` Returns the error message associated with this result. | | ` int` | ` `[getResultCode](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#getResultCode())`() ` Returns one of the`RESULT`constants defined in[AppSearchResult](https://developer.android.com/reference/android/app/appsearch/AppSearchResult). | | ` ValueType` | ` `[getResultValue](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#getResultValue())`() ` Returns the result value associated with this result, if it was successful. | | ` int` | ` `[hashCode](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#hashCode())`() ` Returns a hash code value for the object. | | ` boolean` | ` `[isSuccess](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#isSuccess())`() ` Returns`true`if[getResultCode()](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#getResultCode())equals[AppSearchResult.RESULT_OK](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_OK). | | ` static `[AppSearchResult](https://developer.android.com/reference/android/app/appsearch/AppSearchResult)`` | ` `[newFailedResult](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#newFailedResult(int,%20java.lang.String))`(int resultCode, `[String](https://developer.android.com/reference/java/lang/String)` errorMessage) ` Creates a new failed[AppSearchResult](https://developer.android.com/reference/android/app/appsearch/AppSearchResult). | | ` static `[AppSearchResult](https://developer.android.com/reference/android/app/appsearch/AppSearchResult)`` | ` `[newSuccessfulResult](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#newSuccessfulResult(ValueType))`(ValueType value) ` Creates a new successful[AppSearchResult](https://developer.android.com/reference/android/app/appsearch/AppSearchResult). | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[toString](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#toString())`() ` Returns a string representation of the object. | | ### Inherited methods | |-----------------------|---| | From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object) | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` `[finalize](https://developer.android.com/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final `[Class](https://developer.android.com/reference/java/lang/Class)`` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`. | | ` int` | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long,%20int))`(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long))`(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*. | || ## Constants ### RESULT_ALREADY_EXISTS Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Also in[T Extensions 17](https://developer.android.com/sdkExtensions) ``` public static final int RESULT_ALREADY_EXISTS ``` The operation is invalid because the resource already exists and can't be replaced.
Constant Value: 12 (0x0000000c) ### RESULT_DENIED Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Also in[T Extensions 17](https://developer.android.com/sdkExtensions) ``` public static final int RESULT_DENIED ``` The requested operation is denied for the caller. This error is logged and returned for denylist rejections.
Constant Value: 9 (0x00000009) ### RESULT_INTERNAL_ERROR Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static final int RESULT_INTERNAL_ERROR ``` An internal error occurred within AppSearch, which the caller cannot address. This error may be considered similar to[IllegalStateException](https://developer.android.com/reference/java/lang/IllegalStateException)
Constant Value: 2 (0x00000002) ### RESULT_INVALID_ARGUMENT Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static final int RESULT_INVALID_ARGUMENT ``` The caller supplied invalid arguments to the call. This error may be considered similar to[IllegalArgumentException](https://developer.android.com/reference/java/lang/IllegalArgumentException).
Constant Value: 3 (0x00000003) ### RESULT_INVALID_SCHEMA Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static final int RESULT_INVALID_SCHEMA ``` The caller supplied a schema which is invalid or incompatible with the previous schema.
Constant Value: 7 (0x00000007) ### RESULT_IO_ERROR Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static final int RESULT_IO_ERROR ``` An issue occurred reading or writing to storage. The call might succeed if repeated. This error may be considered similar to[IOException](https://developer.android.com/reference/java/io/IOException).
Constant Value: 4 (0x00000004) ### RESULT_NOT_FOUND Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static final int RESULT_NOT_FOUND ``` An entity the caller requested to interact with does not exist in the system.
Constant Value: 6 (0x00000006) ### RESULT_OK Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static final int RESULT_OK ``` The call was successful.
Constant Value: 0 (0x00000000) ### RESULT_OUT_OF_SPACE Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static final int RESULT_OUT_OF_SPACE ``` Storage is out of space, and no more space could be reclaimed.
Constant Value: 5 (0x00000005) ### RESULT_RATE_LIMITED Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Also in[T Extensions 17](https://developer.android.com/sdkExtensions) ``` public static final int RESULT_RATE_LIMITED ``` 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.
Constant Value: 10 (0x0000000a) ### RESULT_SECURITY_ERROR Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static final int RESULT_SECURITY_ERROR ``` The caller requested an operation it does not have privileges for.
Constant Value: 8 (0x00000008) ### RESULT_UNKNOWN_ERROR Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static final int RESULT_UNKNOWN_ERROR ``` An unknown error occurred while processing the call.
Constant Value: 1 (0x00000001) ## Public methods ### equals Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public boolean equals (Object other) ``` Indicates whether some other object is "equal to" this one. The`equals`method implements an equivalence relation on non-null object references: - It is*reflexive* : for any non-null reference value`x`,`x.equals(x)`should return`true`. - It is*symmetric* : for any non-null reference values`x`and`y`,`x.equals(y)`should return`true`if and only if`y.equals(x)`returns`true`. - It is*transitive* : for any non-null reference values`x`,`y`, and`z`, if`x.equals(y)`returns`true`and`y.equals(z)`returns`true`, then`x.equals(z)`should return`true`. - It is*consistent* : for any non-null reference values`x`and`y`, multiple invocations of`x.equals(y)`consistently return`true`or consistently return`false`, provided no information used in`equals`comparisons on the objects is modified. - For any non-null reference value`x`,`x.equals(null)`should return`false`. An equivalence relation partitions the elements it operates on into*equivalence classes*; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
| Parameters || |---------|-------------------------------------------| | `other` | `Object`: This value may be`null`.
| | Returns || |-----------|-------------------------------------------------------------------------------| | `boolean` | `true`if this object is the same as the obj argument;`false`otherwise.
| ### getErrorMessage Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public String getErrorMessage () ``` Returns the error message associated with this result. If[isSuccess()](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#isSuccess())is`true`, the error message is always`null`. The error message may be`null`even if[isSuccess()](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#isSuccess())is`false`. See the documentation of the particular[AppSearchSession](https://developer.android.com/reference/android/app/appsearch/AppSearchSession)call producing this[AppSearchResult](https://developer.android.com/reference/android/app/appsearch/AppSearchResult)for what is returned by[getErrorMessage()](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#getErrorMessage()).
| Returns || |--------------------------------------------------------------------|--------| | [String](https://developer.android.com/reference/java/lang/String) |
| ### getResultCode Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public int getResultCode () ``` Returns one of the`RESULT`constants defined in[AppSearchResult](https://developer.android.com/reference/android/app/appsearch/AppSearchResult).
| Returns || |-------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `int` | Value is[RESULT_OK](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_OK),[RESULT_UNKNOWN_ERROR](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_UNKNOWN_ERROR),[RESULT_INTERNAL_ERROR](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_INTERNAL_ERROR),[RESULT_INVALID_ARGUMENT](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_INVALID_ARGUMENT),[RESULT_IO_ERROR](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_IO_ERROR),[RESULT_OUT_OF_SPACE](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_OUT_OF_SPACE),[RESULT_NOT_FOUND](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_NOT_FOUND),[RESULT_INVALID_SCHEMA](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_INVALID_SCHEMA),[RESULT_SECURITY_ERROR](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_SECURITY_ERROR),[RESULT_DENIED](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_DENIED),[RESULT_RATE_LIMITED](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_RATE_LIMITED),[RESULT_ALREADY_EXISTS](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_ALREADY_EXISTS), android.app.appsearch.AppSearchResult.RESULT_ABORTED, or android.app.appsearch.AppSearchResult.RESULT_UNAVAILABLE
| ### getResultValue Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public ValueType getResultValue () ``` Returns the result value associated with this result, if it was successful. See the documentation of the particular[AppSearchSession](https://developer.android.com/reference/android/app/appsearch/AppSearchSession)call producing this[AppSearchResult](https://developer.android.com/reference/android/app/appsearch/AppSearchResult)for what is placed in the result value by that call.
| Returns || |-------------|---------------------------------| | `ValueType` | This value may be`null`.
| | Throws || |--------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| | [IllegalStateException](https://developer.android.com/reference/java/lang/IllegalStateException) | if this[AppSearchResult](https://developer.android.com/reference/android/app/appsearch/AppSearchResult)is not successful. | ### hashCode Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public int hashCode () ``` Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by[HashMap](https://developer.android.com/reference/java/util/HashMap). The general contract of`hashCode`is: - Whenever it is invoked on the same object more than once during an execution of a Java application, the`hashCode`method must consistently return the same integer, provided no information used in`equals`comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))method, then calling the`hashCode`method on each of the two objects must produce the same integer result. - It is*not* required that if two objects are unequal according to the[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))method, then calling the`hashCode`method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

| Returns || |-------|-------------------------------------------| | `int` | a hash code value for this object.
| ### isSuccess Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public boolean isSuccess () ``` Returns`true`if[getResultCode()](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#getResultCode())equals[AppSearchResult.RESULT_OK](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_OK).
| Returns || |-----------|--------| | `boolean` |
| ### newFailedResult Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static AppSearchResult newFailedResult (int resultCode, String errorMessage) ``` Creates a new failed[AppSearchResult](https://developer.android.com/reference/android/app/appsearch/AppSearchResult).
| Parameters || |----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `resultCode` | `int`: One of the constants documented in[AppSearchResult.getResultCode](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#getResultCode()). Value is[RESULT_OK](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_OK),[RESULT_UNKNOWN_ERROR](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_UNKNOWN_ERROR),[RESULT_INTERNAL_ERROR](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_INTERNAL_ERROR),[RESULT_INVALID_ARGUMENT](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_INVALID_ARGUMENT),[RESULT_IO_ERROR](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_IO_ERROR),[RESULT_OUT_OF_SPACE](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_OUT_OF_SPACE),[RESULT_NOT_FOUND](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_NOT_FOUND),[RESULT_INVALID_SCHEMA](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_INVALID_SCHEMA),[RESULT_SECURITY_ERROR](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_SECURITY_ERROR),[RESULT_DENIED](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_DENIED),[RESULT_RATE_LIMITED](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_RATE_LIMITED),[RESULT_ALREADY_EXISTS](https://developer.android.com/reference/android/app/appsearch/AppSearchResult#RESULT_ALREADY_EXISTS), android.app.appsearch.AppSearchResult.RESULT_ABORTED, or android.app.appsearch.AppSearchResult.RESULT_UNAVAILABLE
| | `errorMessage` | `String`: An optional string describing the reason or nature of the failure. This value may be`null`.
| | Returns || |---------------------------------------------------------------------------------------------------------------|------------------------------------| | [AppSearchResult](https://developer.android.com/reference/android/app/appsearch/AppSearchResult)`` | This value cannot be`null`.
| ### newSuccessfulResult Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static AppSearchResult newSuccessfulResult (ValueType value) ``` Creates a new successful[AppSearchResult](https://developer.android.com/reference/android/app/appsearch/AppSearchResult).
| Parameters || |---------|------------------------------------------------------------------------------------------------------------------------------------------| | `value` | `ValueType`: An optional value to associate with the successful result of the operation being performed. This value may be`null`.
| | Returns || |---------------------------------------------------------------------------------------------------------------|------------------------------------| | [AppSearchResult](https://developer.android.com/reference/android/app/appsearch/AppSearchResult)`` | This value cannot be`null`.
| ### toString Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public String toString () ``` Returns a string representation of the object.
| Returns || |--------------------------------------------------------------------|------------------------------------| | [String](https://developer.android.com/reference/java/lang/String) | This value cannot be`null`.
|