# AppSearchException Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) # AppSearchException *** ** * ** *** Kotlin\|[Java](https://developer.android.com/reference/android/app/appsearch/exceptions/AppSearchException "View this page in Java") ``` open class AppSearchException : Exception ``` |---|---|---|------------------------------------------------------------------------------------------------------------------------------------------------------------| | [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) |||| | ↳ | [kotlin.Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) ||| | | ↳ | [java.lang.Exception](https://developer.android.com/reference/kotlin/java/lang/Exception.html#) || | | | ↳ | [android.app.appsearch.exceptions.AppSearchException](https://developer.android.com/reference/kotlin/android/app/appsearch/exceptions/AppSearchException#) | An exception thrown by[android.app.appsearch.AppSearchSession](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchSession.html#)or a subcomponent. These exceptions can be converted into a failed[AppSearchResult](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#)for propagating to the client. ## Summary | Public constructors || |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---| | [AppSearchException](https://developer.android.com/reference/kotlin/android/app/appsearch/exceptions/AppSearchException#AppSearchException(kotlin.Int))`(`resultCode:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Initializes an[AppSearchException](https://developer.android.com/reference/kotlin/android/app/appsearch/exceptions/AppSearchException#)with no message. | | [AppSearchException](https://developer.android.com/reference/kotlin/android/app/appsearch/exceptions/AppSearchException#AppSearchException(kotlin.Int,%20kotlin.String))`(`resultCode:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `message:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?`)` Initializes an[AppSearchException](https://developer.android.com/reference/kotlin/android/app/appsearch/exceptions/AppSearchException#)with a result code and message. | | [AppSearchException](https://developer.android.com/reference/kotlin/android/app/appsearch/exceptions/AppSearchException#AppSearchException(kotlin.Int,%20kotlin.String,%20kotlin.Throwable))`(`resultCode:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `message:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?`, `cause:` `[Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?`)` Initializes an[AppSearchException](https://developer.android.com/reference/kotlin/android/app/appsearch/exceptions/AppSearchException#)with a result code, message and cause. | | Public methods || |------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | open[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [getResultCode](https://developer.android.com/reference/kotlin/android/app/appsearch/exceptions/AppSearchException#getResultCode())`()` Returns the result code this exception was constructed with. | | open[AppSearchResult](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#)\ | [toAppSearchResult](https://developer.android.com/reference/kotlin/android/app/appsearch/exceptions/AppSearchException#toAppSearchResult())`()` Converts this[java.lang.Exception](https://developer.android.com/reference/kotlin/java/lang/Exception.html#)into a failed[AppSearchResult](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#). | ## Public constructors ### AppSearchException Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` AppSearchException(resultCode: Int) ``` Initializes an[AppSearchException](https://developer.android.com/reference/kotlin/android/app/appsearch/exceptions/AppSearchException#)with no message. | Parameters || |--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `resultCode` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):One of the constants documented in[AppSearchResult.getResultCode](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#getResultCode()). Value is[android.app.appsearch.AppSearchResult#RESULT_OK](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_OK:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_UNKNOWN_ERROR](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_UNKNOWN_ERROR:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_INTERNAL_ERROR](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_INTERNAL_ERROR:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_INVALID_ARGUMENT](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_INVALID_ARGUMENT:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_IO_ERROR](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_IO_ERROR:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_OUT_OF_SPACE](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_OUT_OF_SPACE:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_NOT_FOUND](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_NOT_FOUND:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_INVALID_SCHEMA](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_INVALID_SCHEMA:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_SECURITY_ERROR](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_SECURITY_ERROR:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_DENIED](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_DENIED:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_RATE_LIMITED](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_RATE_LIMITED:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_ALREADY_EXISTS](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_ALREADY_EXISTS:kotlin.Int), android.app.appsearch.AppSearchResult.RESULT_ABORTED, or android.app.appsearch.AppSearchResult.RESULT_UNAVAILABLE | ### AppSearchException Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` AppSearchException(     resultCode: Int,     message: String?) ``` Initializes an[AppSearchException](https://developer.android.com/reference/kotlin/android/app/appsearch/exceptions/AppSearchException#)with a result code and message. | Parameters || |--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `resultCode` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):One of the constants documented in[AppSearchResult.getResultCode](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#getResultCode()). Value is[android.app.appsearch.AppSearchResult#RESULT_OK](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_OK:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_UNKNOWN_ERROR](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_UNKNOWN_ERROR:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_INTERNAL_ERROR](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_INTERNAL_ERROR:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_INVALID_ARGUMENT](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_INVALID_ARGUMENT:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_IO_ERROR](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_IO_ERROR:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_OUT_OF_SPACE](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_OUT_OF_SPACE:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_NOT_FOUND](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_NOT_FOUND:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_INVALID_SCHEMA](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_INVALID_SCHEMA:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_SECURITY_ERROR](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_SECURITY_ERROR:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_DENIED](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_DENIED:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_RATE_LIMITED](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_RATE_LIMITED:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_ALREADY_EXISTS](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_ALREADY_EXISTS:kotlin.Int), android.app.appsearch.AppSearchResult.RESULT_ABORTED, or android.app.appsearch.AppSearchResult.RESULT_UNAVAILABLE | | `message` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?:The detail message (which is saved for later retrieval by the[getMessage()](https://developer.android.com/reference/kotlin/java/lang/Throwable.html#getMessage())method). This value may be`null`. | ### AppSearchException Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` AppSearchException(     resultCode: Int,     message: String?,     cause: Throwable?) ``` Initializes an[AppSearchException](https://developer.android.com/reference/kotlin/android/app/appsearch/exceptions/AppSearchException#)with a result code, message and cause. | Parameters || |--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `resultCode` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):One of the constants documented in[AppSearchResult.getResultCode](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#getResultCode()). Value is[android.app.appsearch.AppSearchResult#RESULT_OK](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_OK:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_UNKNOWN_ERROR](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_UNKNOWN_ERROR:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_INTERNAL_ERROR](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_INTERNAL_ERROR:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_INVALID_ARGUMENT](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_INVALID_ARGUMENT:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_IO_ERROR](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_IO_ERROR:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_OUT_OF_SPACE](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_OUT_OF_SPACE:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_NOT_FOUND](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_NOT_FOUND:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_INVALID_SCHEMA](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_INVALID_SCHEMA:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_SECURITY_ERROR](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_SECURITY_ERROR:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_DENIED](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_DENIED:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_RATE_LIMITED](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_RATE_LIMITED:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_ALREADY_EXISTS](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_ALREADY_EXISTS:kotlin.Int), android.app.appsearch.AppSearchResult.RESULT_ABORTED, or android.app.appsearch.AppSearchResult.RESULT_UNAVAILABLE | | `message` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?:The detail message (which is saved for later retrieval by the[getMessage()](https://developer.android.com/reference/kotlin/java/lang/Throwable.html#getMessage())method). This value may be`null`. | | `cause` | [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?:The cause (which is saved for later retrieval by the[getCause()](https://developer.android.com/reference/kotlin/java/lang/Throwable.html#getCause())method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.) | ## Public methods ### getResultCode Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun getResultCode(): Int ``` Returns the result code this exception was constructed with. | Return || |----------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | One of the constants documented in[AppSearchResult.getResultCode](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#getResultCode()). Value is[android.app.appsearch.AppSearchResult#RESULT_OK](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_OK:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_UNKNOWN_ERROR](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_UNKNOWN_ERROR:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_INTERNAL_ERROR](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_INTERNAL_ERROR:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_INVALID_ARGUMENT](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_INVALID_ARGUMENT:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_IO_ERROR](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_IO_ERROR:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_OUT_OF_SPACE](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_OUT_OF_SPACE:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_NOT_FOUND](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_NOT_FOUND:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_INVALID_SCHEMA](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_INVALID_SCHEMA:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_SECURITY_ERROR](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_SECURITY_ERROR:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_DENIED](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_DENIED:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_RATE_LIMITED](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_RATE_LIMITED:kotlin.Int),[android.app.appsearch.AppSearchResult#RESULT_ALREADY_EXISTS](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#RESULT_ALREADY_EXISTS:kotlin.Int), android.app.appsearch.AppSearchResult.RESULT_ABORTED, or android.app.appsearch.AppSearchResult.RESULT_UNAVAILABLE | ### toAppSearchResult Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun toAppSearchResult(): AppSearchResult ``` Converts this[java.lang.Exception](https://developer.android.com/reference/kotlin/java/lang/Exception.html#)into a failed[AppSearchResult](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#). | Return || |------------------------------------------------------------------------------------------------------------------|-----------------------------| | [AppSearchResult](https://developer.android.com/reference/kotlin/android/app/appsearch/AppSearchResult.html#) | This value cannot be`null`. |