Save the date! Android Dev Summit is coming to Mountain View, CA on November 7-8, 2018.

WebResourceResponse

public class WebResourceResponse
extends Object

java.lang.Object
   ↳ android.webkit.WebResourceResponse


Encapsulates a resource response. Applications can return an instance of this class from WebViewClient.shouldInterceptRequest(WebView, WebResourceRequest) to provide a custom response when the WebView requests a particular resource.

Summary

Public constructors

WebResourceResponse(String mimeType, String encoding, InputStream data)

Constructs a resource response with the given MIME type, encoding, and input stream.

WebResourceResponse(String mimeType, String encoding, int statusCode, String reasonPhrase, Map<StringString> responseHeaders, InputStream data)

Constructs a resource response with the given parameters.

Public methods

InputStream getData()

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

String getEncoding()

Gets the resource response's encoding.

String getMimeType()

Gets the resource response's MIME type.

String getReasonPhrase()

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

Map<StringString> getResponseHeaders()

Gets the headers for the resource response.

int getStatusCode()

Gets the resource response's status code.

void setData(InputStream data)

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

void setEncoding(String encoding)

Sets the resource response's encoding, for example "UTF-8".

void setMimeType(String mimeType)

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

void setResponseHeaders(Map<StringString> headers)

Sets the headers for the resource response.

void setStatusCodeAndReasonPhrase(int statusCode, String reasonPhrase)

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

Inherited methods

Public constructors

WebResourceResponse

added in API level 11
public WebResourceResponse (String mimeType, 
                String encoding, 
                InputStream data)

Constructs a resource response with the given MIME type, encoding, and input stream. Callers must implement InputStream.read(byte[]) for the input stream.

Parameters
mimeType String: the resource response's MIME type, for example text/html

encoding String: the resource response's encoding

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

WebResourceResponse

added in API level 21
public WebResourceResponse (String mimeType, 
                String encoding, 
                int statusCode, 
                String reasonPhrase, 
                Map<StringString> responseHeaders, 
                InputStream data)

Constructs a resource response with the given parameters. Callers must implement InputStream.read(byte[]) for the input stream.

Parameters
mimeType String: the resource response's MIME type, for example text/html

encoding String: the resource response's encoding

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 must never be null.

responseHeaders Map: 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.

Public methods

getData

added in API level 11
public InputStream getData ()

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

Returns
InputStream The input stream that provides the resource response's data

getEncoding

added in API level 11
public String getEncoding ()

Gets the resource response's encoding.

Returns
String The resource response's encoding

getMimeType

added in API level 11
public String getMimeType ()

Gets the resource response's MIME type.

Returns
String The resource response's MIME type

getReasonPhrase

added in API level 21
public String getReasonPhrase ()

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

Returns
String The description of the resource response's status code.

getResponseHeaders

added in API level 21
public Map<StringString> getResponseHeaders ()

Gets the headers for the resource response.

Returns
Map<StringString> The headers for the resource response.

getStatusCode

added in API level 21
public int getStatusCode ()

Gets the resource response's status code.

Returns
int The resource response's status code.

setData

added in API level 11
public void setData (InputStream data)

Sets the input stream that provides the resource response's data. Callers must implement InputStream.read(byte[]).

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

setEncoding

added in API level 11
public void setEncoding (String encoding)

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
public void setMimeType (String mimeType)

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
public void setResponseHeaders (Map<StringString> headers)

Sets the headers for the resource response.

Parameters
headers Map: Mapping of header name -> header value.

setStatusCodeAndReasonPhrase

added in API level 21
public void setStatusCodeAndReasonPhrase (int statusCode, 
                String reasonPhrase)

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 must never be null.