net.gotev.uploadservice

Class UploadRequest

java.lang.Object

net.gotev.uploadservice.UploadRequest

Direct Known Subclasses:

HttpUploadRequest

public abstract class UploadRequest
extends Object

Base class to extend to create an upload request. If you are implementing an HTTP based upload, extend HttpUploadRequest instead.

Constructor Summary

Constructors

Constructor and Description
UploadRequest(Context context, String uploadId, String serverUrl) Creates a new upload request.

Method Summary

Modifier and Type	Method and Description
UploadRequest	setAutoDeleteFilesAfterSuccessfulUpload(boolean autoDeleteFiles) Sets the automatic file deletion after successful upload.
UploadRequest	setDelegate(UploadStatusDelegate delegate) Sets the delegate which will receive the events for this upload request.
UploadRequest	setMaxRetries(int maxRetries) Sets the maximum number of retries that the library will try if an error occurs, before returning an error.
UploadRequest	setNotificationConfig(UploadNotificationConfig config) Sets custom notification configuration.
String	startUpload() Start the background file upload service.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UploadRequest

public UploadRequest(Context context,
                     String uploadId,
                     String serverUrl)

Creates a new upload request.

Parameters:

context - application context

uploadId - unique ID to assign to this upload request. If is null or empty, a random UUID will be automatically generated. It's used in the broadcast receiver when receiving updates.

serverUrl - URL of the server side script that handles the request

Method Detail

startUpload

public final String startUpload()
                         throws IllegalArgumentException,
                                MalformedURLException

Start the background file upload service.

Returns:

the uploadId string

Throws:

IllegalArgumentException - if one or more arguments passed are invalid

MalformedURLException - if the server URL is not valid

setNotificationConfig

public UploadRequest setNotificationConfig(UploadNotificationConfig config)

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.

Parameters:

config - the upload configuration object or null if you don't want a notification to be displayed

Returns:

UploadRequest

setAutoDeleteFilesAfterSuccessfulUpload

public UploadRequest setAutoDeleteFilesAfterSuccessfulUpload(boolean autoDeleteFiles)

Sets the automatic file deletion after successful upload.

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

setMaxRetries

public UploadRequest setMaxRetries(int maxRetries)

Sets the maximum number of retries that the library will try if an error occurs, before returning an error.

Parameters:

maxRetries - number of maximum retries on error

Returns:

UploadRequest

setDelegate

public UploadRequest setDelegate(UploadStatusDelegate delegate)

Sets the delegate which will receive the events for this upload request. The events will be sent only to the delegate and not in broadcast. Delegate methods will be called on your main thread, so you can safely update your UI from them. If you want to send events for this upload in broadcast, and handle them in the UploadServiceBroadcastReceiver, do not set the delegate or set it to null.

Parameters:

delegate - instance of the delegate which will receive the events

Returns:

UploadRequest