BinaryUploadRequest (Android Upload Service 2.1 Reference)

java.lang.Object
- net.gotev.uploadservice.HttpUploadRequest
- - net.gotev.uploadservice.BinaryUploadRequest

```
public class BinaryUploadRequest
extends HttpUploadRequest
```
Binary file upload request. The binary upload uses a single file as the raw body of the upload request.

Constructor Summary

Constructors
Constructor and Description
`BinaryUploadRequest(Context context, String serverUrl)` Creates a new binaryupload request and automatically generates an upload id, that will be returned when you call `HttpUploadRequest.startUpload()`.
`BinaryUploadRequest(Context context, String uploadId, String serverUrl)` Creates a binary file upload request.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpUploadRequest`	`addArrayParameter(String paramName, List<String> list)` Adds a parameter with multiple values to this upload request.
`HttpUploadRequest`	`addArrayParameter(String paramName, String... array)` Adds a parameter with multiple values to this upload request.
`BinaryUploadRequest`	`addHeader(String headerName, String headerValue)` Adds a header to this upload request.
`HttpUploadRequest`	`addParameter(String paramName, String paramValue)` Adds a parameter to this upload request.
`BinaryUploadRequest`	`setAutoDeleteFilesAfterSuccessfulUpload(boolean autoDeleteFiles)` Sets the automatic file deletion after successful upload.
`BinaryUploadRequest`	`setBasicAuth(String username, String password)` Sets the HTTP Basic Authentication header.
`BinaryUploadRequest`	`setCustomUserAgent(String customUserAgent)` Sets the custom user agent to use for this upload request.
`BinaryUploadRequest`	`setFileToUpload(String path)` Sets the file used as raw body of the upload request.
`BinaryUploadRequest`	`setMaxRetries(int maxRetries)` Sets the maximum number of retries that the library will do if an error occurs, before returning an error.
`BinaryUploadRequest`	`setMethod(String method)` Sets the HTTP method to use.
`BinaryUploadRequest`	`setNotificationConfig(UploadNotificationConfig config)` Sets custom notification configuration.
`BinaryUploadRequest`	`setUsesFixedLengthStreamingMode(boolean fixedLength)` Sets if this upload request is using fixed length streaming mode.

Methods inherited from class net.gotev.uploadservice.HttpUploadRequest
startUpload

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

- Constructor Detail
  - BinaryUploadRequest
```
public BinaryUploadRequest(Context context,
                           String uploadId,
                           String serverUrl)
```
    Creates a binary file 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
  - BinaryUploadRequest
```
public BinaryUploadRequest(Context context,
                           String serverUrl)
```
    Creates a new binaryupload request and automatically generates an upload id, that will be returned when you call HttpUploadRequest.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
  - setFileToUpload
```
public BinaryUploadRequest setFileToUpload(String path)
                                    throws FileNotFoundException
```
    Sets the file used as raw body of the upload request.
    
    Parameters:
    
    path - Absolute path to the file that you want to upload
    
    Returns:
    
    BinaryUploadRequest
    
    Throws:
    
    FileNotFoundException - if the file to upload does not exist
  - setNotificationConfig
```
public BinaryUploadRequest setNotificationConfig(UploadNotificationConfig config)
```
    Description copied from class: HttpUploadRequest
    
    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 HttpUploadRequest
    
    Parameters:
    
    config - the upload configuration object or null if you don't want a notification to be displayed
    
    Returns:
    
    HttpUploadRequest
  - setAutoDeleteFilesAfterSuccessfulUpload
```
public BinaryUploadRequest setAutoDeleteFilesAfterSuccessfulUpload(boolean autoDeleteFiles)
```
    Description copied from class: HttpUploadRequest
    
    Sets the automatic file deletion after successful upload.
    
    Overrides:
    
    setAutoDeleteFilesAfterSuccessfulUpload in class HttpUploadRequest
    
    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:
    
    HttpUploadRequest
  - addHeader
```
public BinaryUploadRequest 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 BinaryUploadRequest 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
  - setMethod
```
public BinaryUploadRequest 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 BinaryUploadRequest 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 BinaryUploadRequest setMaxRetries(int maxRetries)
```
    Description copied from class: HttpUploadRequest
    
    Sets the maximum number of retries that the library will do if an error occurs, before returning an error.
    
    Overrides:
    
    setMaxRetries in class HttpUploadRequest
    
    Parameters:
    
    maxRetries - number of maximum retries on error
    
    Returns:
    
    HttpUploadRequest
  - setUsesFixedLengthStreamingMode
```
public BinaryUploadRequest 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
  - addParameter
```
public HttpUploadRequest 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 HttpUploadRequest 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 HttpUploadRequest 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

Class BinaryUploadRequest

Constructor Summary

Method Summary

Methods inherited from class net.gotev.uploadservice.HttpUploadRequest

Methods inherited from class java.lang.Object

Constructor Detail

BinaryUploadRequest

BinaryUploadRequest

Method Detail

setFileToUpload

setNotificationConfig

setAutoDeleteFilesAfterSuccessfulUpload

addHeader

setBasicAuth

setMethod

setCustomUserAgent

setMaxRetries

setUsesFixedLengthStreamingMode

addParameter

addArrayParameter

addArrayParameter