net.gotev.uploadservice

Class UploadServiceBroadcastReceiver

java.lang.Object

android.content.BroadcastReceiver

net.gotev.uploadservice.UploadServiceBroadcastReceiver

public class UploadServiceBroadcastReceiver
extends BroadcastReceiver

Broadcast receiver to sublass to create a receiver for UploadService events. It provides the boilerplate code to properly handle broadcast messages coming from the upload service and dispatch them to the proper handler method.

Nested Class Summary

Nested classes/interfaces inherited from class android.content.BroadcastReceiver

BroadcastReceiver.PendingResult

Constructor Summary

Constructors

Constructor and Description
UploadServiceBroadcastReceiver()

Method Summary

Modifier and Type	Method and Description
void	onCancelled(String uploadId) Called when the upload is cancelled.
void	onCompleted(String uploadId, int serverResponseCode, byte[] serverResponseBody) Called when the upload is completed successfully.
void	onError(String uploadId, Exception exception) Called when an error happens during the upload.
void	onProgress(String uploadId, int progress) Called when the upload progress changes.
void	onProgress(String uploadId, long uploadedBytes, long totalBytes) Called when the upload progress changes.
void	onReceive(Context context, Intent intent)
void	register(Context context) Register this upload receiver. If you use this receiver in an Activity, you have to call this method inside Activity.onResume(), after super.onResume();. If you use it in a Service, you have to call this method inside Service.onCreate(), after super.onCreate();.
void	unregister(Context context) Unregister this upload receiver. If you use this receiver in an Activity, you have to call this method inside Activity.onPause(), after super.onPause();. If you use it in a Service, you have to call this method inside Service.onDestroy().

Methods inherited from class android.content.BroadcastReceiver

abortBroadcast, clearAbortBroadcast, getAbortBroadcast, getDebugUnregister, getResultCode, getResultData, getResultExtras, goAsync, isInitialStickyBroadcast, isOrderedBroadcast, peekService, setDebugUnregister, setOrderedHint, setResult, setResultCode, setResultData, setResultExtras

Methods inherited from class java.lang.Object

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

Constructor Detail

UploadServiceBroadcastReceiver

public UploadServiceBroadcastReceiver()

Method Detail

onReceive

public void onReceive(Context context,
                      Intent intent)

Specified by:

onReceive in class BroadcastReceiver

register

public void register(Context context)

Register this upload receiver.
If you use this receiver in an Activity, you have to call this method inside Activity.onResume(), after super.onResume();.
If you use it in a Service, you have to call this method inside Service.onCreate(), after super.onCreate();.

Parameters:

context - context in which to register this receiver

unregister

public void unregister(Context context)

Unregister this upload receiver.
If you use this receiver in an Activity, you have to call this method inside Activity.onPause(), after super.onPause();.
If you use it in a Service, you have to call this method inside Service.onDestroy().

Parameters:

context - context in which to unregister this receiver

onProgress

public void onProgress(String uploadId,
                       int progress)

Called when the upload progress changes. Override this method to add your own logic.

Parameters:

uploadId - unique ID of the upload request

progress - value from 0 to 100

onProgress

public void onProgress(String uploadId,
                       long uploadedBytes,
                       long totalBytes)

Called when the upload progress changes. Override this method to add your own logic.

Parameters:

uploadId - unique ID of the upload request

uploadedBytes - the count of the bytes uploaded so far

totalBytes - the total expected bytes to upload

onError

public void onError(String uploadId,
                    Exception exception)

Called when an error happens during the upload. Override this method to add your own logic.

Parameters:

uploadId - unique ID of the upload request

exception - exception that caused the error

onCompleted

public void onCompleted(String uploadId,
                        int serverResponseCode,
                        byte[] serverResponseBody)

Called when the upload is completed successfully. Override this method to add your own logic.

Parameters:

uploadId - unique ID of the upload request

serverResponseCode - status code returned by the server

serverResponseBody - byte array containing the response body received from the server. If your server responds with a string, you can get it with new String(serverResponseBody). If the string is a JSON, you can parse it using a library such as org.json (embedded in Android) or google's gson

onCancelled

public void onCancelled(String uploadId)

Called when the upload is cancelled. Override this method to add your own logic.

Parameters:

uploadId - unique ID of the upload request