com.android.volley.request

Class MultiPartRequest<T>

java.lang.Object

com.android.volley.Request<T>

com.android.volley.request.MultiPartRequest<T>

Type Parameters:

T - Response expected

All Implemented Interfaces:

Response.ProgressListener, java.lang.Comparable<Request<T>>

Direct Known Subclasses:

SimpleMultiPartRequest

public abstract class MultiPartRequest<T>
extends Request<T>
implements Response.ProgressListener

A request for making a Multi Part request

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MultiPartRequest.MultiPartParam A representation of a MultiPart parameter

Nested classes/interfaces inherited from class com.android.volley.Request

Request.Method, Request.Priority

Field Summary

Fields

Modifier and Type	Field and Description
static int	TIMEOUT_MS

Constructor Summary

Constructors

Constructor and Description
MultiPartRequest(int method, java.lang.String url, Response.Listener<T> listener, Response.ErrorListener errorListener) Creates a new request with the given method.

Method Summary

Methods

Modifier and Type	Method and Description
MultiPartRequest<T>	addFile(java.lang.String name, java.lang.String filePath) Add a file to be uploaded in the multipart request
MultiPartRequest<T>	addMultipartParam(java.lang.String name, java.lang.String contentType, java.lang.String value) Add a parameter to be sent in the multipart request
MultiPartRequest<T>	addStringParam(java.lang.String name, java.lang.String value) Add a string parameter to be sent in the multipart request
protected void	deliverResponse(T response) Subclasses must implement this to perform delivery of the parsed response to their listeners.
java.util.Map<java.lang.String,java.lang.String>	getFilesToUpload() Get all the files to be uploaded for this request
java.util.Map<java.lang.String,MultiPartRequest.MultiPartParam>	getMultipartParams() Get all the multipart params for this request
java.lang.String	getProtocolCharset() Get the protocol charset
boolean	isFixedStreamingMode()
void	onProgress(long transferredBytes, long totalSize) Callback method thats called on each byte transfer.
protected abstract Response<T>	parseNetworkResponse(NetworkResponse response) Subclasses must implement this to parse the raw network response and return an appropriate response type.
void	setFixedStreamingMode(boolean isFixedStreamingMode)
void	setOnProgressListener(Response.ProgressListener listener) Set listener for tracking download progress

Methods inherited from class com.android.volley.Request

addMarker, cancel, compareTo, deliverError, getBody, getBodyContentType, getCacheEntry, getCacheKey, getEncodedUrlParams, getErrorListener, getHeaders, getMethod, getParams, getParamsEncoding, getPostBody, getPostBodyContentType, getPostParams, getPostParamsEncoding, getPriority, getRetryPolicy, getSequence, getTag, getTimeoutMs, getTrafficStatsTag, getUrl, hasHadResponseDelivered, isCanceled, markDelivered, overridePatch, parseNetworkError, setCacheEntry, setHeaders, setParams, setPriority, setRequestQueue, setRetryPolicy, setSequence, setShouldCache, setTag, shouldCache, shouldOverridePatch, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TIMEOUT_MS

public static final int TIMEOUT_MS

See Also:

Constant Field Values

Constructor Detail

MultiPartRequest

public MultiPartRequest(int method,
                java.lang.String url,
                Response.Listener<T> listener,
                Response.ErrorListener errorListener)

Creates a new request with the given method.

Parameters:

method - the request Method to use

url - URL to fetch the string at

listener - Listener to receive the String response

errorListener - Error listener, or null to ignore errors

Method Detail

addMultipartParam

public MultiPartRequest<T> addMultipartParam(java.lang.String name,
                                    java.lang.String contentType,
                                    java.lang.String value)

Add a parameter to be sent in the multipart request

Parameters:

name - The name of the paramter

contentType - The content type of the paramter

value - the value of the paramter

Returns:

The Multipart request for chaining calls

addStringParam

public MultiPartRequest<T> addStringParam(java.lang.String name,
                                 java.lang.String value)

Add a string parameter to be sent in the multipart request

Parameters:

name - The name of the paramter

value - the value of the paramter

Returns:

The Multipart request for chaining calls

addFile

public MultiPartRequest<T> addFile(java.lang.String name,
                          java.lang.String filePath)

Add a file to be uploaded in the multipart request

Parameters:

name - The name of the file key

filePath - The path to the file. This file MUST exist.

Returns:

The Multipart request for chaining method calls

parseNetworkResponse

protected abstract Response<T> parseNetworkResponse(NetworkResponse response)

Description copied from class: Request

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.

Specified by:

parseNetworkResponse in class Request<T>

Parameters:

response - Response from the network

Returns:

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

deliverResponse

protected void deliverResponse(T response)

Description copied from class: Request

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.

Specified by:

deliverResponse in class Request<T>

Parameters:

response - The parsed response returned by Request.parseNetworkResponse(NetworkResponse)

setOnProgressListener

public void setOnProgressListener(Response.ProgressListener listener)

Set listener for tracking download progress

Parameters:

listener -

onProgress

public void onProgress(long transferredBytes,
              long totalSize)

Description copied from interface: Response.ProgressListener

Callback method thats called on each byte transfer.

Specified by:

onProgress in interface Response.ProgressListener

getMultipartParams

public java.util.Map<java.lang.String,MultiPartRequest.MultiPartParam> getMultipartParams()

Get all the multipart params for this request

Returns:

A map of all the multipart params NOT including the file uploads

getFilesToUpload

public java.util.Map<java.lang.String,java.lang.String> getFilesToUpload()

Get all the files to be uploaded for this request

Returns:

A map of all the files to be uploaded for this request

getProtocolCharset

public java.lang.String getProtocolCharset()

Get the protocol charset

isFixedStreamingMode

public boolean isFixedStreamingMode()

setFixedStreamingMode

public void setFixedStreamingMode(boolean isFixedStreamingMode)