# WebResourceResponse Added in[API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) # WebResourceResponse *** ** * ** *** Kotlin\|[Java](https://developer.android.com/reference/android/webkit/WebResourceResponse "View this page in Java") ``` open class WebResourceResponse ``` |---|--------------------------------------------------------------------------------------------------------------------------| | [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) || | ↳ | [android.webkit.WebResourceResponse](https://developer.android.com/reference/kotlin/android/webkit/WebResourceResponse#) | Encapsulates a resource response. Applications can return an instance of this class from android.webkit.WebViewClient#shouldInterceptRequest to provide a custom response when the WebView requests a particular resource. ## Summary | Public constructors || |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---| | [WebResourceResponse](https://developer.android.com/reference/kotlin/android/webkit/WebResourceResponse#WebResourceResponse(kotlin.String,%20kotlin.String,%20kotlin.Int,%20kotlin.String,%20kotlin.collections.MutableMap,%20java.io.InputStream))`(`mimeType:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`, `encoding:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`, `statusCode:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `reasonPhrase:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `responseHeaders:` `[MutableMap](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!,` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!>!`, `data:` `[InputStream](https://developer.android.com/reference/kotlin/java/io/InputStream.html#)!`)` Constructs a resource response with the given parameters. | | [WebResourceResponse](https://developer.android.com/reference/kotlin/android/webkit/WebResourceResponse#WebResourceResponse(kotlin.String,%20kotlin.String,%20java.io.InputStream))`(`mimeType:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`, `encoding:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`, `data:` `[InputStream](https://developer.android.com/reference/kotlin/java/io/InputStream.html#)!`)` Constructs a resource response with the given MIME type, character encoding, and input stream. | | Public methods || |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | open[InputStream](https://developer.android.com/reference/kotlin/java/io/InputStream.html#)! | [getData](https://developer.android.com/reference/kotlin/android/webkit/WebResourceResponse#getData())`()` Gets the input stream that provides the resource response's data. | | open[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | [getEncoding](https://developer.android.com/reference/kotlin/android/webkit/WebResourceResponse#getEncoding())`()` Gets the resource response's encoding. | | open[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | [getMimeType](https://developer.android.com/reference/kotlin/android/webkit/WebResourceResponse#getMimeType())`()` Gets the resource response's MIME type. | | open[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | [getReasonPhrase](https://developer.android.com/reference/kotlin/android/webkit/WebResourceResponse#getReasonPhrase())`()` Gets the description of the resource response's status code. | | open[MutableMap](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html)\<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!,[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!\>! | [getResponseHeaders](https://developer.android.com/reference/kotlin/android/webkit/WebResourceResponse#getResponseHeaders())`()` Gets the headers for the resource response. | | open[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [getStatusCode](https://developer.android.com/reference/kotlin/android/webkit/WebResourceResponse#getStatusCode())`()` Gets the resource response's status code. | | open[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setData](https://developer.android.com/reference/kotlin/android/webkit/WebResourceResponse#setData(java.io.InputStream))`(`data:` `[InputStream](https://developer.android.com/reference/kotlin/java/io/InputStream.html#)!`)` Sets the input stream that provides the resource response's data. | | open[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setEncoding](https://developer.android.com/reference/kotlin/android/webkit/WebResourceResponse#setEncoding(kotlin.String))`(`encoding:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)` Sets the resource response's encoding, for example "UTF-8". | | open[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setMimeType](https://developer.android.com/reference/kotlin/android/webkit/WebResourceResponse#setMimeType(kotlin.String))`(`mimeType:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)` Sets the resource response's MIME type, for example "text/html". | | open[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setResponseHeaders](https://developer.android.com/reference/kotlin/android/webkit/WebResourceResponse#setResponseHeaders(kotlin.collections.MutableMap))`(`headers:` `[MutableMap](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!,` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!>!`)` Sets the headers for the resource response. | | open[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setStatusCodeAndReasonPhrase](https://developer.android.com/reference/kotlin/android/webkit/WebResourceResponse#setStatusCodeAndReasonPhrase(kotlin.Int,%20kotlin.String))`(`statusCode:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `reasonPhrase:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` Sets the resource response's status code and reason phrase. | ## Public constructors ### WebResourceResponse Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` WebResourceResponse(     mimeType: String!,     encoding: String!,     statusCode: Int,     reasonPhrase: String,     responseHeaders: MutableMap!,     data: InputStream!) ``` Constructs a resource response with the given parameters. Callers must implement[InputStream.read(byte[])](https://developer.android.com/reference/kotlin/java/io/InputStream.html#read(kotlin.ByteArray))for the input stream. java.io.InputStream#close() will be called after the WebView has finished with the response. **Note:** See[WebResourceResponse(java.lang.String,java.lang.String,java.io.InputStream)](https://developer.android.com/reference/kotlin/android/webkit/WebResourceResponse#WebResourceResponse(kotlin.String,%20kotlin.String,%20java.io.InputStream))for details on what should be specified for`mimeType`and`encoding`. | Parameters || |-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `mimeType` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!:the resource response's MIME type, for example`"text/html"`. | | `encoding` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!:the resource response's character encoding, for example`"utf-8"`. | | `statusCode` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):the status code needs to be in the ranges \[100, 299\], \[400, 599\]. Causing a redirect by specifying a 3xx code is not supported. | | `reasonPhrase` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html):the phrase describing the status code, for example "OK". Must be non-empty. This value cannot be`null`. | | `responseHeaders` | [MutableMap](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html)\<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!,[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!\>!:the resource response's headers represented as a mapping of header name -\> header value. | | `data` | [InputStream](https://developer.android.com/reference/kotlin/java/io/InputStream.html#)!:the input stream that provides the resource response's data. Must not be a StringBufferInputStream. | ### WebResourceResponse Added in[API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` WebResourceResponse(     mimeType: String!,     encoding: String!,     data: InputStream!) ``` Constructs a resource response with the given MIME type, character encoding, and input stream. Callers must implement[InputStream.read(byte[])](https://developer.android.com/reference/kotlin/java/io/InputStream.html#read(kotlin.ByteArray))for the input stream. java.io.InputStream#close() will be called after the WebView has finished with the response. **Note:** The MIME type and character encoding must be specified as separate parameters (for example`"text/html"`and`"utf-8"`), not a single value like the`"text/html; charset=utf-8"`format used in the HTTP Content-Type header. Do not use the value of a HTTP Content-Encoding header for`encoding`, as that header does not specify a character encoding. Content without a defined character encoding (for example image resources) should pass`null`for`encoding`. | Parameters || |------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `mimeType` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!:the resource response's MIME type, for example`"text/html"`. | | `encoding` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!:the resource response's character encoding, for example`"utf-8"`. | | `data` | [InputStream](https://developer.android.com/reference/kotlin/java/io/InputStream.html#)!:the input stream that provides the resource response's data. Must not be a StringBufferInputStream. | ## Public methods ### getData Added in[API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun getData(): InputStream! ``` Gets the input stream that provides the resource response's data. | Return || |------------------------------------------------------------------------------------------|-------------------------------------------------------------| | [InputStream](https://developer.android.com/reference/kotlin/java/io/InputStream.html#)! | The input stream that provides the resource response's data | ### getEncoding Added in[API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun getEncoding(): String! ``` Gets the resource response's encoding. | Return || |-----------------------------------------------------------------------------------|----------------------------------| | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | The resource response's encoding | ### getMimeType Added in[API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun getMimeType(): String! ``` Gets the resource response's MIME type. | Return || |-----------------------------------------------------------------------------------|-----------------------------------| | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | The resource response's MIME type | ### getReasonPhrase Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun getReasonPhrase(): String! ``` Gets the description of the resource response's status code. | Return || |-----------------------------------------------------------------------------------|---------------------------------------------------------| | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | The description of the resource response's status code. | ### getResponseHeaders Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun getResponseHeaders(): MutableMap! ``` Gets the headers for the resource response. | Return || |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------| | [MutableMap](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!,` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!>! | The headers for the resource response. | ### getStatusCode Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun getStatusCode(): Int ``` Gets the resource response's status code. | Return || |----------------------------------------------------------------------------|--------------------------------------| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | The resource response's status code. | ### setData Added in[API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun setData(data: InputStream!): Unit ``` Sets the input stream that provides the resource response's data. Callers must implement[InputStream.read(byte[])](https://developer.android.com/reference/kotlin/java/io/InputStream.html#read(kotlin.ByteArray)). java.io.InputStream#close() will be called after the WebView has finished with the response. | Parameters || |--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `data` | [InputStream](https://developer.android.com/reference/kotlin/java/io/InputStream.html#)!:the input stream that provides the resource response's data. Must not be a StringBufferInputStream. | ### setEncoding Added in[API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun setEncoding(encoding: String!): Unit ``` Sets the resource response's encoding, for example "UTF-8". This is used to decode the data from the input stream. | Parameters || |------------|--------------------------------------------------------------------------------------------------------------------| | `encoding` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!:The resource response's encoding | ### setMimeType Added in[API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun setMimeType(mimeType: String!): Unit ``` Sets the resource response's MIME type, for example "text/html". | Parameters || |------------|---------------------------------------------------------------------------------------------------------------------| | `mimeType` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!:The resource response's MIME type | ### setResponseHeaders Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun setResponseHeaders(headers: MutableMap!): Unit ``` Sets the headers for the resource response. | Parameters || |-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `headers` | [MutableMap](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html)\<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!,[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!\>!:Mapping of header name -\> header value. | ### setStatusCodeAndReasonPhrase Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun setStatusCodeAndReasonPhrase(     statusCode: Int,     reasonPhrase: String ): Unit ``` Sets the resource response's status code and reason phrase. | Parameters || |----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `statusCode` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):the status code needs to be in the ranges \[100, 299\], \[400, 599\]. Causing a redirect by specifying a 3xx code is not supported. | | `reasonPhrase` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html):the phrase describing the status code, for example "OK". Must be non-empty. This value cannot be`null`. |