WebResourceResponse

Kotlin |Java

open class WebResourceResponse

kotlin.Any
↳	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(mimeType: String!, encoding: String!, statusCode: Int, reasonPhrase: String, responseHeaders: MutableMap<String!, String!>!, data: InputStream!)` Constructs a resource response with the given parameters.
`WebResourceResponse(mimeType: String!, encoding: String!, data: InputStream!)` Constructs a resource response with the given MIME type, character encoding, and input stream.

Public methods
open InputStream!	`getData()` Gets the input stream that provides the resource response's data.
open String!	`getEncoding()` Gets the resource response's encoding.
open String!	`getMimeType()` Gets the resource response's MIME type.
open String!	`getReasonPhrase()` Gets the description of the resource response's status code.
open MutableMap<String!, String!>!	`getResponseHeaders()` Gets the headers for the resource response.
open Int	`getStatusCode()` Gets the resource response's status code.
open Unit	`setData(data: InputStream!)` Sets the input stream that provides the resource response's data.
open Unit	`setEncoding(encoding: String!)` Sets the resource response's encoding, for example "UTF-8".
open Unit	`setMimeType(mimeType: String!)` Sets the resource response's MIME type, for example "text/html".
open Unit	`setResponseHeaders(headers: MutableMap<String!, String!>!)` Sets the headers for the resource response.
open Unit	`setStatusCodeAndReasonPhrase(statusCode: Int, reasonPhrase: String)` Sets the resource response's status code and reason phrase.

Public constructors

WebResourceResponse

Added in API level 21

WebResourceResponse(
    mimeType: String!, 
    encoding: String!, 
    statusCode: Int, 
    reasonPhrase: String, 
    responseHeaders: MutableMap<String!, String!>!, 
    data: InputStream!)

Constructs a resource response with the given parameters. Callers must implement InputStream.read(byte[]) 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) for details on what should be specified for mimeType and encoding.

Parameters
`mimeType`	String!: the resource response's MIME type, for example `"text/html"`.
`encoding`	String!: the resource response's character encoding, for example `"utf-8"`.
`statusCode`	Int: 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: the phrase describing the status code, for example "OK". Must be non-empty. This value cannot be `null`.
`responseHeaders`	MutableMap<String!, String!>!: the resource response's headers represented as a mapping of header name -> header value.
`data`	InputStream!: the input stream that provides the resource response's data. Must not be a StringBufferInputStream.

WebResourceResponse

Added in API level 11

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[]) 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!: the resource response's MIME type, for example `"text/html"`.
`encoding`	String!: the resource response's character encoding, for example `"utf-8"`.
`data`	InputStream!: the input stream that provides the resource response's data. Must not be a StringBufferInputStream.

Public methods

getData

Added in API level 11

open fun getData(): InputStream!

Gets the input stream that provides the resource response's data.

Return
`InputStream!`	The input stream that provides the resource response's data

getEncoding

Added in API level 11

open fun getEncoding(): String!

Gets the resource response's encoding.

Return
`String!`	The resource response's encoding

getMimeType

Added in API level 11

open fun getMimeType(): String!

Gets the resource response's MIME type.

Return
`String!`	The resource response's MIME type

getReasonPhrase

Added in API level 21

open fun getReasonPhrase(): String!

Gets the description of the resource response's status code.

Return
`String!`	The description of the resource response's status code.

getResponseHeaders

Added in API level 21

open fun getResponseHeaders(): MutableMap<String!, String!>!

Gets the headers for the resource response.

Return
`MutableMap<String!, String!>!`	The headers for the resource response.

getStatusCode

Added in API level 21

open fun getStatusCode(): Int

Gets the resource response's status code.

Return
`Int`	The resource response's status code.

setData

Added in API level 11

open fun setData(data: InputStream!): Unit

Sets the input stream that provides the resource response's data. Callers must implement InputStream.read(byte[]). java.io.InputStream#close() will be called after the WebView has finished with the response.

Parameters
`data`	InputStream!: the input stream that provides the resource response's data. Must not be a StringBufferInputStream.

setEncoding

Added in API level 11

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!: The resource response's encoding

setMimeType

Added in API level 11

open fun setMimeType(mimeType: String!): Unit

Sets the resource response's MIME type, for example "text/html".

Parameters
`mimeType`	String!: The resource response's MIME type

setResponseHeaders

Added in API level 21

open fun setResponseHeaders(headers: MutableMap<String!, String!>!): Unit

Sets the headers for the resource response.

Parameters
`headers`	MutableMap<String!, String!>!: Mapping of header name -> header value.

setStatusCodeAndReasonPhrase

Added in API level 21

open fun setStatusCodeAndReasonPhrase(
    statusCode: Int, 
    reasonPhrase: String
): Unit

Sets the resource response's status code and reason phrase.

Parameters
`statusCode`	Int: 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: the phrase describing the status code, for example "OK". Must be non-empty. This value cannot be `null`.