WebResourceResponse - Android SDK

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

Added in API level 11

public class

WebResourceResponse

extends Object

java.lang.Object
↳	android.webkit.WebResourceResponse

Class Overview

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.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Public Constructors

public WebResourceResponse (String mimeType, String encoding, InputStream data)

Added in API level 11

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	the resource response's MIME type, for example text/html
encoding	the resource response's encoding
data	the input stream that provides the resource response's data. Must not be a StringBufferInputStream.

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

Added in API level 21

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

Parameters

mimeType	the resource response's MIME type, for example text/html
encoding	the resource response's encoding
statusCode	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	the phrase describing the status code, for example "OK". Must be non-null and not empty.
responseHeaders	the resource response's headers represented as a mapping of header name -> header value.
data	the input stream that provides the resource response's data. Must not be a StringBufferInputStream.

Public Methods

public InputStream getData ()

Added in API level 11

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

Returns

The input stream that provides the resource response's data

public String getEncoding ()

Added in API level 11

Gets the resource response's encoding.

Returns

The resource response's encoding

public String getMimeType ()

Added in API level 11

Gets the resource response's MIME type.

Returns

The resource response's MIME type

public String getReasonPhrase ()

Added in API level 21

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

Returns

The description of the resource response's status code.

public Map<String, String> getResponseHeaders ()

Added in API level 21

Gets the headers for the resource response.

Returns

The headers for the resource response.

public int getStatusCode ()

Added in API level 21

Gets the resource response's status code.

Returns

The resource response's status code.

public void setData (InputStream data)

Added in API level 11

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

Parameters

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

public void setEncoding (String encoding)

Added in API level 11

Sets the resource response's encoding, for example "UTF-8". This is used to decode the data from the input stream.

Parameters

encoding	The resource response's encoding

public void setMimeType (String mimeType)

Added in API level 11

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

Parameters

mimeType	The resource response's MIME type

public void setResponseHeaders (Map<String, String> headers)

Added in API level 21

Sets the headers for the resource response.

Parameters

headers	Mapping of header name -> header value.

public void setStatusCodeAndReasonPhrase (int statusCode, String reasonPhrase)

Added in API level 21

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

Parameters

statusCode	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	the phrase describing the status code, for example "OK". Must be non-null and not empty.

Results

Annotations

Interfaces

Classes

Enums

WebResourceResponse

Class Overview

Summary

Public Constructors

public WebResourceResponse (String mimeType, String encoding, InputStream data)

Parameters

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

Parameters

Public Methods

public InputStream getData ()

Returns

public String getEncoding ()

Returns

public String getMimeType ()

Returns

public String getReasonPhrase ()

Returns

public Map<String, String> getResponseHeaders ()

Returns

public int getStatusCode ()

Returns

public void setData (InputStream data)

Parameters

public void setEncoding (String encoding)

Parameters

public void setMimeType (String mimeType)

Parameters

public void setResponseHeaders (Map<String, String> headers)

Parameters

public void setStatusCodeAndReasonPhrase (int statusCode, String reasonPhrase)

Parameters