added in API level 11

Summary: Ctors | Methods | Inherited Methods | [Expand All]

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 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<String, String> 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<String, String>`	`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<String, String> 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

From class


  
    java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Public constructors

WebResourceResponse

added in API level 11

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

WebResourceResponse (String mimeType, 
                String encoding, 
                int statusCode, 
                String reasonPhrase, 
                Map<String, String> 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-null and not empty.
`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

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

String getEncoding ()

Gets the resource response's encoding.

Returns
`String`	The resource response's encoding

getMimeType

added in API level 11

String getMimeType ()

Gets the resource response's MIME type.

Returns
`String`	The resource response's MIME type

getReasonPhrase

added in API level 21

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

Map<String, String> getResponseHeaders ()

Gets the headers for the resource response.

Returns
`Map<String, String>`	The headers for the resource response.

getStatusCode

added in API level 21

int getStatusCode ()

Gets the resource response's status code.

Returns
`int`	The resource response's status code.

setData

added in API level 11

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

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

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

void setResponseHeaders (Map<String, String> headers)

Sets the headers for the resource response.

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

setStatusCodeAndReasonPhrase

added in API level 21

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-null and not empty.

Jun	JUL	Aug
	15
2016	2017	2018

Most visited

Recently visited

Results for

WebResourceResponse

Summary

Public constructors

Public methods

Inherited methods

Public constructors

WebResourceResponse

WebResourceResponse

Public methods

getData

getEncoding

getMimeType

getReasonPhrase

getResponseHeaders

getStatusCode

setData

setEncoding

setMimeType

setResponseHeaders

setStatusCodeAndReasonPhrase

Annotations

Interfaces

Classes

Enums