public abstract class

JsonRequest

extends Request<T>

java.lang.Object
↳	com.android.volley.Request<T>
	↳	com.android.volley.toolbox.JsonRequest<T>

Known Direct Subclasses

JsonArrayRequest, JsonObjectRequest

Class Overview

A request for retrieving a T type response body at a given URL that also optionally sends along a JSON body in the request specified.

Summary

Constants
String	PROTOCOL_CHARSET	Default charset for JSON request.

Public Constructors
	JsonRequest(String url, String requestBody, Listener<T> listener, Response.ErrorListener errorListener) This constructor is deprecated. Use `JsonRequest(int, String, String, Listener, ErrorListener)`.
	JsonRequest(int method, String url, String requestBody, Listener<T> listener, Response.ErrorListener errorListener)

Public Methods
byte[]	getBody() Returns the raw POST or PUT body to be sent.
String	getBodyContentType() Returns the content type of the POST or PUT body.
byte[]	getPostBody() This method is deprecated. Use `getBody()`.
String	getPostBodyContentType() This method is deprecated. Use `getBodyContentType()`.

Protected Methods
void	deliverResponse(T response) Subclasses must implement this to perform delivery of the parsed response to their listeners.
abstract Response<T>	parseNetworkResponse(NetworkResponse response) Subclasses must implement this to parse the raw network response and return an appropriate response type.

[Expand]

Inherited Methods

From class com.android.volley.Request

void	addMarker(String tag) Adds an event to this request's event log; for debugging.
void	cancel() Mark this request as canceled.
int	compareTo(Request<T> other) Our comparator sorts from high to low priority, and secondarily by sequence number to provide FIFO ordering.
void	deliverError(VolleyError error) Delivers error message to the ErrorListener that the Request was initialized with.
abstract void	deliverResponse(T response) Subclasses must implement this to perform delivery of the parsed response to their listeners.
byte[]	getBody() Returns the raw POST or PUT body to be sent.
String	getBodyContentType() Returns the content type of the POST or PUT body.
Cache.Entry	getCacheEntry() Returns the annotated cache entry, or null if there isn't one.
String	getCacheKey() Returns the cache key for this request.
Response.ErrorListener	getErrorListener()
Map<String, String>	getHeaders() Returns a list of extra HTTP headers to go along with this request.
int	getMethod() Return the method for this request.
Map<String, String>	getParams() Returns a Map of parameters to be used for a POST or PUT request.
String	getParamsEncoding() Returns which encoding should be used when converting POST or PUT parameters returned by `getParams()` into a raw POST or PUT body.
byte[]	getPostBody() This method is deprecated. Use `getBody()` instead.
String	getPostBodyContentType() This method is deprecated. Use `getBodyContentType()` instead.
Map<String, String>	getPostParams() This method is deprecated. Use `getParams()` instead.
String	getPostParamsEncoding() This method is deprecated. Use `getParamsEncoding()` instead.
Request.Priority	getPriority() Returns the `Request.Priority` of this request; `NORMAL` by default.
RetryPolicy	getRetryPolicy() Returns the retry policy that should be used for this request.
final int	getSequence() Returns the sequence number of this request.
Object	getTag() Returns this request's tag.
final int	getTimeoutMs() Returns the socket timeout in milliseconds per retry attempt.
int	getTrafficStatsTag()
String	getUrl() Returns the URL of this request.
boolean	hasHadResponseDelivered() Returns true if this request has had a response delivered for it.
boolean	isCanceled() Returns true if this request has been canceled.
void	markDelivered() Mark this request as having a response delivered on it.
VolleyError	parseNetworkError(VolleyError volleyError) Subclasses can override this method to parse 'networkError' and return a more specific error.
abstract Response<T>	parseNetworkResponse(NetworkResponse response) Subclasses must implement this to parse the raw network response and return an appropriate response type.
Request<?>	setCacheEntry(Cache.Entry entry) Annotates this request with an entry retrieved for it from cache.
Request<?>	setRequestQueue(RequestQueue requestQueue) Associates this request with the given queue.
Request<?>	setRetryPolicy(RetryPolicy retryPolicy) Sets the retry policy for this request.
final Request<?>	setSequence(int sequence) Sets the sequence number of this request.
final Request<?>	setShouldCache(boolean shouldCache) Set whether or not responses to this request should be cached.
Request<?>	setTag(Object tag) Set a tag on this request.
final boolean	shouldCache() Returns true if responses to this request should be cached.
String	toString()

From class java.lang.Object

From interface java.lang.Comparable

Constants

protected static final String PROTOCOL_CHARSET

Default charset for JSON request.

Constant Value: "utf-8"

Public Constructors

public JsonRequest (String url, String requestBody, Listener<T> listener, Response.ErrorListener errorListener)

This constructor is deprecated.
Use JsonRequest(int, String, String, Listener, ErrorListener).

Deprecated constructor for a JsonRequest which defaults to GET unless getPostBody() or getPostParams() is overridden (which defaults to POST).

public JsonRequest (int method, String url, String requestBody, Listener<T> listener, Response.ErrorListener errorListener)

Public Methods

public byte[] getBody ()

Returns the raw POST or PUT body to be sent.

By default, the body consists of the request parameters in application/x-www-form-urlencoded format. When overriding this method, consider overriding getBodyContentType() as well to match the new body format.

public String getBodyContentType ()

Returns the content type of the POST or PUT body.

public byte[] getPostBody ()

This method is deprecated.
Use getBody().

Returns the raw POST body to be sent.

public String getPostBodyContentType ()

This method is deprecated.
Use getBodyContentType().

Protected Methods

protected void deliverResponse (T response)

Subclasses must implement this to perform delivery of the parsed response to their listeners. The given response is guaranteed to be non-null; responses that fail to parse are not delivered.

Parameters

response	The parsed response returned by `parseNetworkResponse(NetworkResponse)`

protected abstract Response<T> parseNetworkResponse (NetworkResponse response)

Subclasses must implement this to parse the raw network response and return an appropriate response type. This method will be called from a worker thread. The response will not be delivered if you return null.

Parameters

response	Response from the network

Returns

The parsed response, or null in the case of an error

Interfaces

Classes

JsonRequest

Class Overview

Summary

Constants

protected static final String PROTOCOL_CHARSET

Public Constructors

public JsonRequest (String url, String requestBody, Listener<T> listener, Response.ErrorListener errorListener)

public JsonRequest (int method, String url, String requestBody, Listener<T> listener, Response.ErrorListener errorListener)

Public Methods

public byte[] getBody ()

public String getBodyContentType ()

public byte[] getPostBody ()

public String getPostBodyContentType ()

Protected Methods

protected void deliverResponse (T response)

Parameters

protected abstract Response<T> parseNetworkResponse (NetworkResponse response)

Parameters

Returns