MultipartUploadRequest (Android Upload Service 3.1 Reference)

java.lang.Object
- net.gotev.uploadservice.UploadRequest
- - net.gotev.uploadservice.HttpUploadRequest
  - - net.gotev.uploadservice.MultipartUploadRequest

```
public class MultipartUploadRequest
extends HttpUploadRequest
```
HTTP/Multipart upload request. This is the most common way to upload files on a server. It's the same kind of request that browsers do when you use the <form> tag with one or more files.

Constructor Summary

Constructors
Constructor and Description
`MultipartUploadRequest(Context context, String serverUrl)` Creates a new multipart upload request and automatically generates an upload id, that will be returned when you call `UploadRequest.startUpload()`.
`MultipartUploadRequest(Context context, String uploadId, String serverUrl)` Creates a new multipart upload request.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MultipartUploadRequest`	`addArrayParameter(String paramName, List<String> list)` Adds a parameter with multiple values to this upload request.
`MultipartUploadRequest`	`addArrayParameter(String paramName, String... array)` Adds a parameter with multiple values to this upload request.
`MultipartUploadRequest`	`addFileToUpload(String path, String parameterName)` Adds a file to this upload request, without setting file name and content type.
`MultipartUploadRequest`	`addFileToUpload(String path, String parameterName, String fileName)` Adds a file to this upload request, without setting the content type, which will be automatically detected from the file extension.
`MultipartUploadRequest`	`addFileToUpload(String filePath, String parameterName, String fileName, String contentType)` Adds a file to this upload request.
`MultipartUploadRequest`	`addHeader(String headerName, String headerValue)` Adds a header to this upload request.
`MultipartUploadRequest`	`addParameter(String paramName, String paramValue)` Adds a parameter to this upload request.
`MultipartUploadRequest`	`setAutoDeleteFilesAfterSuccessfulUpload(boolean autoDeleteFiles)` Sets the automatic file deletion after successful upload.
`MultipartUploadRequest`	`setBasicAuth(String username, String password)` Sets the HTTP Basic Authentication header.
`MultipartUploadRequest`	`setCustomUserAgent(String customUserAgent)` Sets the custom user agent to use for this upload request.
`MultipartUploadRequest`	`setMaxRetries(int maxRetries)` Sets the maximum number of retries that the library will try if an error occurs, before returning an error.
`MultipartUploadRequest`	`setMethod(String method)` Sets the HTTP method to use.
`MultipartUploadRequest`	`setNotificationConfig(UploadNotificationConfig config)` Sets custom notification configuration.
`MultipartUploadRequest`	`setUsesFixedLengthStreamingMode(boolean fixedLength)` Sets if this upload request is using fixed length streaming mode.
`MultipartUploadRequest`	`setUtf8Charset()` Sets the charset for this multipart request to UTF-8.

Methods inherited from class net.gotev.uploadservice.UploadRequest
setDelegate, startUpload

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MultipartUploadRequest
```
public MultipartUploadRequest(Context context,
                              String uploadId,
                              String serverUrl)
```
    Creates a new multipart upload request.
    
    Parameters:
    
    context - application context
    
    uploadId - unique ID to assign to this upload request.
    It can be whatever string you want, as long as it's unique. If you set it to null or an empty string, an UUID will be automatically generated.
    It's advised to keep a reference to it in your code, so when you receive status updates in UploadServiceBroadcastReceiver, you know to which upload they refer to.
    
    serverUrl - URL of the server side script that will handle the multipart form upload. E.g.: http://www.yourcompany.com/your/script
  - MultipartUploadRequest
```
public MultipartUploadRequest(Context context,
                              String serverUrl)
```
    Creates a new multipart upload request and automatically generates an upload id, that will be returned when you call UploadRequest.startUpload().
    
    Parameters:
    
    context - application context
    
    serverUrl - URL of the server side script that will handle the multipart form upload. E.g.: http://www.yourcompany.com/your/script
- Method Detail
  - addFileToUpload
```
public MultipartUploadRequest addFileToUpload(String filePath,
                                              String parameterName,
                                              String fileName,
                                              String contentType)
                                       throws FileNotFoundException,
                                              IllegalArgumentException
```
    Adds a file to this upload request.
    
    Parameters:
    
    filePath - path to the file that you want to upload
    
    parameterName - Name of the form parameter that will contain file's data
    
    fileName - File name seen by the server side script. If null, the original file name will be used
    
    contentType - Content type of the file. You can use constants defined in ContentType class. Set this to null or empty string to try to automatically detect the mime type from the file. If the mime type can't be detected, application/octet-stream will be used by default
    
    Returns:
    
    MultipartUploadRequest
    
    Throws:
    
    FileNotFoundException - if the file does not exist at the specified path
    
    IllegalArgumentException - if one or more parameters are not valid
  - addFileToUpload
```
public MultipartUploadRequest addFileToUpload(String path,
                                              String parameterName,
                                              String fileName)
                                       throws FileNotFoundException,
                                              IllegalArgumentException
```
    Adds a file to this upload request, without setting the content type, which will be automatically detected from the file extension. If you want to manually set the content type, use addFileToUpload(String, String, String, String).
    
    Parameters:
    
    path - Absolute path to the file that you want to upload
    
    parameterName - Name of the form parameter that will contain file's data
    
    fileName - File name seen by the server side script. If null, the original file name will be used
    
    Returns:
    
    MultipartUploadRequest
    
    Throws:
    
    FileNotFoundException - if the file does not exist at the specified path
    
    IllegalArgumentException - if one or more parameters are not valid
  - addFileToUpload
```
public MultipartUploadRequest addFileToUpload(String path,
                                              String parameterName)
                                       throws FileNotFoundException,
                                              IllegalArgumentException
```
    Adds a file to this upload request, without setting file name and content type. The original file name will be used instead. If you want to manually set the file name seen by the server side script and the content type, use addFileToUpload(String, String, String, String)
    
    Parameters:
    
    path - Absolute path to the file that you want to upload
    
    parameterName - Name of the form parameter that will contain file's data
    
    Returns:
    
    MultipartUploadRequest
    
    Throws:
    
    FileNotFoundException - if the file does not exist at the specified path
    
    IllegalArgumentException - if one or more parameters are not valid
  - setNotificationConfig
```
public MultipartUploadRequest setNotificationConfig(UploadNotificationConfig config)
```
    Description copied from class: UploadRequest
    
    Sets custom notification configuration. If you don't want to display a notification in Notification Center, either pass null as argument or don't call this method.
    
    Overrides:
    
    setNotificationConfig in class UploadRequest
    
    Parameters:
    
    config - the upload configuration object or null if you don't want a notification to be displayed
    
    Returns:
    
    UploadRequest
  - setAutoDeleteFilesAfterSuccessfulUpload
```
public MultipartUploadRequest setAutoDeleteFilesAfterSuccessfulUpload(boolean autoDeleteFiles)
```
    Description copied from class: UploadRequest
    
    Sets the automatic file deletion after successful upload.
    
    Overrides:
    
    setAutoDeleteFilesAfterSuccessfulUpload in class UploadRequest
    
    Parameters:
    
    autoDeleteFiles - true to auto delete files included in the request when the upload is completed successfully. By default this setting is set to false, and nothing gets deleted.
    
    Returns:
    
    UploadRequest
  - addHeader
```
public MultipartUploadRequest addHeader(String headerName,
                                        String headerValue)
```
    Description copied from class: HttpUploadRequest
    
    Adds a header to this upload request.
    
    Overrides:
    
    addHeader in class HttpUploadRequest
    
    Parameters:
    
    headerName - header name
    
    headerValue - header value
    
    Returns:
    
    HttpUploadRequest
  - setBasicAuth
```
public MultipartUploadRequest setBasicAuth(String username,
                                           String password)
```
    Description copied from class: HttpUploadRequest
    
    Sets the HTTP Basic Authentication header.
    
    Overrides:
    
    setBasicAuth in class HttpUploadRequest
    
    Parameters:
    
    username - HTTP Basic Auth username
    
    password - HTTP Basic Auth password
    
    Returns:
    
    HttpUploadRequest
  - addParameter
```
public MultipartUploadRequest addParameter(String paramName,
                                           String paramValue)
```
    Description copied from class: HttpUploadRequest
    
    Adds a parameter to this upload request.
    
    Overrides:
    
    addParameter in class HttpUploadRequest
    
    Parameters:
    
    paramName - parameter name
    
    paramValue - parameter value
    
    Returns:
    
    HttpUploadRequest
  - addArrayParameter
```
public MultipartUploadRequest addArrayParameter(String paramName,
                                                String... array)
```
    Description copied from class: HttpUploadRequest
    
    Adds a parameter with multiple values to this upload request.
    
    Overrides:
    
    addArrayParameter in class HttpUploadRequest
    
    Parameters:
    
    paramName - parameter name
    
    array - values
    
    Returns:
    
    HttpUploadRequest
  - addArrayParameter
```
public MultipartUploadRequest addArrayParameter(String paramName,
                                                List<String> list)
```
    Description copied from class: HttpUploadRequest
    
    Adds a parameter with multiple values to this upload request.
    
    Overrides:
    
    addArrayParameter in class HttpUploadRequest
    
    Parameters:
    
    paramName - parameter name
    
    list - values
    
    Returns:
    
    HttpUploadRequest
  - setMethod
```
public MultipartUploadRequest setMethod(String method)
```
    Description copied from class: HttpUploadRequest
    
    Sets the HTTP method to use. By default it's set to POST.
    
    Overrides:
    
    setMethod in class HttpUploadRequest
    
    Parameters:
    
    method - new HTTP method to use
    
    Returns:
    
    HttpUploadRequest
  - setCustomUserAgent
```
public MultipartUploadRequest setCustomUserAgent(String customUserAgent)
```
    Description copied from class: HttpUploadRequest
    
    Sets the custom user agent to use for this upload request. Note! If you set the "User-Agent" header by using the "addHeader" method, that setting will be overwritten by the value set with this method.
    
    Overrides:
    
    setCustomUserAgent in class HttpUploadRequest
    
    Parameters:
    
    customUserAgent - custom user agent string
    
    Returns:
    
    HttpUploadRequest
  - setMaxRetries
```
public MultipartUploadRequest setMaxRetries(int maxRetries)
```
    Description copied from class: UploadRequest
    
    Sets the maximum number of retries that the library will try if an error occurs, before returning an error.
    
    Overrides:
    
    setMaxRetries in class UploadRequest
    
    Parameters:
    
    maxRetries - number of maximum retries on error
    
    Returns:
    
    UploadRequest
  - setUsesFixedLengthStreamingMode
```
public MultipartUploadRequest setUsesFixedLengthStreamingMode(boolean fixedLength)
```
    Description copied from class: HttpUploadRequest
    
    Sets if this upload request is using fixed length streaming mode. If it uses fixed length streaming mode, then the value returned by HttpUploadTask.getBodyLength() will be automatically used to properly set the underlying HttpURLConnection, otherwise chunked streaming mode will be used.
    
    Overrides:
    
    setUsesFixedLengthStreamingMode in class HttpUploadRequest
    
    Parameters:
    
    fixedLength - true to use fixed length streaming mode (this is the default setting) or false to use chunked streaming mode.
    
    Returns:
    
    HttpUploadRequest
  - setUtf8Charset
```
public MultipartUploadRequest setUtf8Charset()
```
    Sets the charset for this multipart request to UTF-8. If not set, the standard US-ASCII charset will be used.
    
    Returns:
    
    request instance

Class MultipartUploadRequest

Constructor Summary

Method Summary

Methods inherited from class net.gotev.uploadservice.UploadRequest

Methods inherited from class java.lang.Object

Constructor Detail

MultipartUploadRequest

MultipartUploadRequest

Method Detail

addFileToUpload

addFileToUpload

addFileToUpload

setNotificationConfig

setAutoDeleteFilesAfterSuccessfulUpload

addHeader

setBasicAuth

addParameter

addArrayParameter

addArrayParameter

setMethod

setCustomUserAgent

setMaxRetries

setUsesFixedLengthStreamingMode

setUtf8Charset