UploadTask

Also: Google Play services

public class UploadTask extends StorageTask<UploadTask.TaskSnapshot>

An controllable task that uploads and fires events for success, progress and failure. It also allows pause and resume to control the upload operation.

Nested Class Summary

class

UploadTask.TaskSnapshot

Encapsulates state about the running UploadTask

Inherited Field Summary

From class com.google.firebase.storage.StorageTask

protected final Object

syncObject

Protected Method Summary

void	onCanceled()
void	resetState()
void	schedule()

Inherited Method Summary

From class com.google.firebase.storage.StorageTask

StorageTask<UploadTask.TaskSnapshot>	addOnCanceledListener(OnCanceledListener listener) Adds a listener that is called if the Task is canceled.
StorageTask<UploadTask.TaskSnapshot>	addOnCanceledListener(Executor executor, OnCanceledListener listener) Adds a listener that is called if the Task is canceled.
StorageTask<UploadTask.TaskSnapshot>	addOnCanceledListener(Activity activity, OnCanceledListener listener) Adds an Activity-scoped listener that is called if the Task is canceled.
StorageTask<UploadTask.TaskSnapshot>	addOnCompleteListener(Activity activity, OnCompleteListener<UploadTask.TaskSnapshot> listener) Adds a listener that is called when the Task succeeds or fails.
StorageTask<UploadTask.TaskSnapshot>	addOnCompleteListener(OnCompleteListener<UploadTask.TaskSnapshot> listener) Adds a listener that is called when the Task succeeds or fails.
StorageTask<UploadTask.TaskSnapshot>	addOnCompleteListener(Executor executor, OnCompleteListener<UploadTask.TaskSnapshot> listener) Adds a listener that is called when the Task succeeds or fails.
StorageTask<UploadTask.TaskSnapshot>	addOnFailureListener(Activity activity, OnFailureListener listener) Adds a listener that is called if the Task fails.
StorageTask<UploadTask.TaskSnapshot>	addOnFailureListener(OnFailureListener listener) Adds a listener that is called if the Task fails.
StorageTask<UploadTask.TaskSnapshot>	addOnFailureListener(Executor executor, OnFailureListener listener) Adds a listener that is called if the Task fails.
StorageTask<UploadTask.TaskSnapshot>	addOnPausedListener(Executor executor, OnPausedListener<? super ResultT> listener) Adds a listener that is called when the Task becomes paused.
StorageTask<UploadTask.TaskSnapshot>	addOnPausedListener(OnPausedListener<? super ResultT> listener) Adds a listener that is called when the Task becomes paused.
StorageTask<UploadTask.TaskSnapshot>	addOnPausedListener(Activity activity, OnPausedListener<? super ResultT> listener) Adds a listener that is called when the Task becomes paused.
StorageTask<UploadTask.TaskSnapshot>	addOnProgressListener(OnProgressListener<? super ResultT> listener) Adds a listener that is called periodically while the ControllableTask executes.
StorageTask<UploadTask.TaskSnapshot>	addOnProgressListener(Activity activity, OnProgressListener<? super ResultT> listener) Adds a listener that is called periodically while the ControllableTask executes.
StorageTask<UploadTask.TaskSnapshot>	addOnProgressListener(Executor executor, OnProgressListener<? super ResultT> listener) Adds a listener that is called periodically while the ControllableTask executes.
StorageTask<UploadTask.TaskSnapshot>	addOnSuccessListener(OnSuccessListener<? super ResultT> listener) Adds a listener that is called if the Task completes successfully.
StorageTask<UploadTask.TaskSnapshot>	addOnSuccessListener(Executor executor, OnSuccessListener<? super ResultT> listener) Adds a listener that is called if the Task completes successfully.
StorageTask<UploadTask.TaskSnapshot>	addOnSuccessListener(Activity activity, OnSuccessListener<? super ResultT> listener) Adds a listener that is called if the Task completes successfully.
boolean	cancel() Attempts to cancel the task.
<ContinuationResultT> Task<ContinuationResultT>	continueWith(Continuation<UploadTask.TaskSnapshot, ContinuationResultT> continuation) Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
<ContinuationResultT> Task<ContinuationResultT>	continueWith(Executor executor, Continuation<UploadTask.TaskSnapshot, ContinuationResultT> continuation) Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
<ContinuationResultT> Task<ContinuationResultT>	continueWithTask(Executor executor, Continuation<UploadTask.TaskSnapshot, Task<ContinuationResultT>> continuation) Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
<ContinuationResultT> Task<ContinuationResultT>	continueWithTask(Continuation<UploadTask.TaskSnapshot, Task<ContinuationResultT>> continuation) Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
Exception	getException() Returns the exception that caused the Task to fail.
UploadTask.TaskSnapshot	getResult() Gets the result of the Task, if it has already completed.
<X extends Throwable> UploadTask.TaskSnapshot	getResult(Class<X> exceptionType) Gets the result of the Task, if it has already completed.
UploadTask.TaskSnapshot	getSnapshot() Returns the current state of the task.
boolean	isCanceled() Returns true if the task has been canceled.
boolean	isComplete() Returns true if the Task is complete; false otherwise.
boolean	isInProgress() Returns true if the task is currently running.
boolean	isPaused() Returns true if the task has been paused.
boolean	isSuccessful() Returns true if the Task has completed successfully; false otherwise.
void	onCanceled()
void	onFailure()
void	onPaused()
void	onProgress()
void	onQueued()
void	onSuccess()
<ContinuationResultT> Task<ContinuationResultT>	onSuccessTask(SuccessContinuation<UploadTask.TaskSnapshot, ContinuationResultT> continuation) Returns a new Task that will be completed with the result of applying the specified SuccessContinuation to this Task when this Task completes successfully.
<ContinuationResultT> Task<ContinuationResultT>	onSuccessTask(Executor executor, SuccessContinuation<UploadTask.TaskSnapshot, ContinuationResultT> continuation) Returns a new Task that will be completed with the result of applying the specified SuccessContinuation to this Task when this Task completes successfully.
boolean	pause() Attempts to pause the task.
StorageTask<UploadTask.TaskSnapshot>	removeOnCanceledListener(OnCanceledListener listener) Removes a listener.
StorageTask<UploadTask.TaskSnapshot>	removeOnCompleteListener(OnCompleteListener<UploadTask.TaskSnapshot> listener) Removes a listener.
StorageTask<UploadTask.TaskSnapshot>	removeOnFailureListener(OnFailureListener listener) Removes a listener.
StorageTask<UploadTask.TaskSnapshot>	removeOnPausedListener(OnPausedListener<? super ResultT> listener) Removes a listener.
StorageTask<UploadTask.TaskSnapshot>	removeOnProgressListener(OnProgressListener<? super ResultT> listener) Removes a listener.
StorageTask<UploadTask.TaskSnapshot>	removeOnSuccessListener(OnSuccessListener<? super ResultT> listener) Removes a listener.
boolean	resume() Attempts to resume a paused task.

From class com.google.firebase.storage.ControllableTask

abstract ControllableTask<ResultT extends StorageTask.ProvideError>	addOnPausedListener(Activity activity, OnPausedListener<? super StateT> listener) Adds a listener that is called when the Task becomes paused.
abstract ControllableTask<ResultT extends StorageTask.ProvideError>	addOnPausedListener(OnPausedListener<? super StateT> listener) Adds a listener that is called when the Task becomes paused.
abstract ControllableTask<ResultT extends StorageTask.ProvideError>	addOnPausedListener(Executor executor, OnPausedListener<? super StateT> listener) Adds a listener that is called when the Task becomes paused.
abstract boolean	isPaused()
abstract boolean	pause() Attempts to pause the task.
abstract boolean	resume() Attempts to resume this task.

From class com.google.firebase.storage.CancellableTask

abstract CancellableTask<ResultT extends StorageTask.ProvideError>	addOnProgressListener(OnProgressListener<? super StateT> listener) Adds a listener that is called periodically while the ControllableTask executes.
abstract CancellableTask<ResultT extends StorageTask.ProvideError>	addOnProgressListener(Activity activity, OnProgressListener<? super StateT> listener) Adds a listener that is called periodically while the ControllableTask executes.
abstract CancellableTask<ResultT extends StorageTask.ProvideError>	addOnProgressListener(Executor executor, OnProgressListener<? super StateT> listener) Adds a listener that is called periodically while the ControllableTask executes.
abstract boolean	cancel() Attempts to cancel the task.
abstract boolean	isCanceled()
abstract boolean	isInProgress()

From class com.google.android.gms.tasks.Task

Task<ResultT extends StorageTask.ProvideError>	addOnCanceledListener(OnCanceledListener arg0)
Task<ResultT extends StorageTask.ProvideError>	addOnCanceledListener(Executor arg0, OnCanceledListener arg1)
Task<ResultT extends StorageTask.ProvideError>	addOnCanceledListener(Activity arg0, OnCanceledListener arg1)
Task<ResultT extends StorageTask.ProvideError>	addOnCompleteListener(OnCompleteListener<ResultT extends StorageTask.ProvideError> arg0)
Task<ResultT extends StorageTask.ProvideError>	addOnCompleteListener(Activity arg0, OnCompleteListener<ResultT extends StorageTask.ProvideError> arg1)
Task<ResultT extends StorageTask.ProvideError>	addOnCompleteListener(Executor arg0, OnCompleteListener<ResultT extends StorageTask.ProvideError> arg1)
abstract Task<ResultT extends StorageTask.ProvideError>	addOnFailureListener(Activity arg0, OnFailureListener arg1)
abstract Task<ResultT extends StorageTask.ProvideError>	addOnFailureListener(OnFailureListener arg0)
abstract Task<ResultT extends StorageTask.ProvideError>	addOnFailureListener(Executor arg0, OnFailureListener arg1)
abstract Task<ResultT extends StorageTask.ProvideError>	addOnSuccessListener(Executor arg0, OnSuccessListener<? super TResult> arg1)
abstract Task<ResultT extends StorageTask.ProvideError>	addOnSuccessListener(OnSuccessListener<? super TResult> arg0)
abstract Task<ResultT extends StorageTask.ProvideError>	addOnSuccessListener(Activity arg0, OnSuccessListener<? super TResult> arg1)
<TContinuationResult> Task<TContinuationResult>	continueWith(Continuation<ResultT extends StorageTask.ProvideError, TContinuationResult> arg0)
<TContinuationResult> Task<TContinuationResult>	continueWith(Executor arg0, Continuation<ResultT extends StorageTask.ProvideError, TContinuationResult> arg1)
<TContinuationResult> Task<TContinuationResult>	continueWithTask(Continuation<ResultT extends StorageTask.ProvideError, Task<TContinuationResult>> arg0)
<TContinuationResult> Task<TContinuationResult>	continueWithTask(Executor arg0, Continuation<ResultT extends StorageTask.ProvideError, Task<TContinuationResult>> arg1)
abstract Exception	getException()
abstract ResultT extends StorageTask.ProvideError	getResult()
abstract <X extends Throwable> ResultT extends StorageTask.ProvideError	getResult(Class<X> arg0)
abstract boolean	isCanceled()
abstract boolean	isComplete()
abstract boolean	isSuccessful()
<TContinuationResult> Task<TContinuationResult>	onSuccessTask(Executor arg0, SuccessContinuation<ResultT extends StorageTask.ProvideError, TContinuationResult> arg1)
<TContinuationResult> Task<TContinuationResult>	onSuccessTask(SuccessContinuation<ResultT extends StorageTask.ProvideError, TContinuationResult> arg0)

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

Protected Methods

protected void onCanceled ()

Also: Google Play services

protected void resetState ()

Also: Google Play services

protected void schedule ()

Also: Google Play services