net.gotev.uploadservice

Class UploadServiceBroadcastReceiver

java.lang.Object

android.content.BroadcastReceiver

net.gotev.uploadservice.UploadServiceBroadcastReceiver

All Implemented Interfaces:

UploadStatusDelegate

Direct Known Subclasses:

UploadServiceSingleBroadcastReceiver

public class UploadServiceBroadcastReceiver
extends BroadcastReceiver
implements UploadStatusDelegate

Broadcast receiver to subclass 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(Context context, UploadInfo uploadInfo) Called when the upload is cancelled.
void	onCompleted(Context context, UploadInfo uploadInfo, ServerResponse serverResponse) Called when the upload is completed successfully.
void	onError(Context context, UploadInfo uploadInfo, ServerResponse serverResponse, Exception exception) Called when an error happens during the upload.
void	onProgress(Context context, UploadInfo uploadInfo) 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(Context context,
                       UploadInfo uploadInfo)

Description copied from interface: UploadStatusDelegate

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

Specified by:

onProgress in interface UploadStatusDelegate

Parameters:

context - context

uploadInfo - upload status information

onError

public void onError(Context context,
                    UploadInfo uploadInfo,
                    ServerResponse serverResponse,
                    Exception exception)

Description copied from interface: UploadStatusDelegate

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

Specified by:

onError in interface UploadStatusDelegate

Parameters:

context - context

uploadInfo - upload status information

serverResponse - response got from the server. It can be null if the server has not responded or if the request has not reached the server due to a networking problem.

exception - exception that caused the error. It can be null if the request successfully reached the server, but it responded with a 4xx or 5xx status code.

onCompleted

public void onCompleted(Context context,
                        UploadInfo uploadInfo,
                        ServerResponse serverResponse)

Description copied from interface: UploadStatusDelegate

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

Specified by:

onCompleted in interface UploadStatusDelegate

Parameters:

context - context

uploadInfo - upload status information

serverResponse - response got from the server

onCancelled

public void onCancelled(Context context,
                        UploadInfo uploadInfo)

Description copied from interface: UploadStatusDelegate

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

Specified by:

onCancelled in interface UploadStatusDelegate

Parameters:

context - context

uploadInfo - upload status information