StreamDownloadTask

public class StreamDownloadTask extends StorageTask<StreamDownloadTask.TaskSnapshot>

A task that downloads bytes of a GCS blob.

Nested Class Summary

interface	StreamDownloadTask.StreamProcessor		A callback that is used to handle the stream download
class	StreamDownloadTask.TaskSnapshot		Encapsulates state about the running `StreamDownloadTask`

Inherited Field Summary

From class com.google.firebase.storage.StorageTask

protected final Object mSyncObject

Protected Method Summary

void	onCanceled()
void	onProgress()

Inherited Method Summary

From class com.google.firebase.storage.StorageTask

StorageTask<StreamDownloadTask.TaskSnapshot>	addOnCanceledListener(OnCanceledListener listener) Adds a listener that is called if the Task is canceled.
StorageTask<StreamDownloadTask.TaskSnapshot>	addOnCanceledListener(Executor executor, OnCanceledListener listener) Adds a listener that is called if the Task is canceled.
StorageTask<StreamDownloadTask.TaskSnapshot>	addOnCanceledListener(Activity activity, OnCanceledListener listener) Adds an Activity-scoped listener that is called if the Task is canceled.
StorageTask<StreamDownloadTask.TaskSnapshot>	addOnCompleteListener(OnCompleteListener<StreamDownloadTask.TaskSnapshot> listener) Adds a listener that is called when the Task succeeds or fails.
StorageTask<StreamDownloadTask.TaskSnapshot>	addOnCompleteListener(Activity activity, OnCompleteListener<StreamDownloadTask.TaskSnapshot> listener) Adds a listener that is called when the Task succeeds or fails.
StorageTask<StreamDownloadTask.TaskSnapshot>	addOnCompleteListener(Executor executor, OnCompleteListener<StreamDownloadTask.TaskSnapshot> listener) Adds a listener that is called when the Task succeeds or fails.
StorageTask<StreamDownloadTask.TaskSnapshot>	addOnFailureListener(Activity activity, OnFailureListener listener) Adds a listener that is called if the Task fails.
StorageTask<StreamDownloadTask.TaskSnapshot>	addOnFailureListener(OnFailureListener listener) Adds a listener that is called if the Task fails.
StorageTask<StreamDownloadTask.TaskSnapshot>	addOnFailureListener(Executor executor, OnFailureListener listener) Adds a listener that is called if the Task fails.
StorageTask<StreamDownloadTask.TaskSnapshot>	addOnPausedListener(Executor executor, OnPausedListener<? super TResult> listener) Adds a listener that is called when the Task becomes paused.
StorageTask<StreamDownloadTask.TaskSnapshot>	addOnPausedListener(Activity activity, OnPausedListener<? super TResult> listener) Adds a listener that is called when the Task becomes paused.
StorageTask<StreamDownloadTask.TaskSnapshot>	addOnPausedListener(OnPausedListener<? super TResult> listener) Adds a listener that is called when the Task becomes paused.
StorageTask<StreamDownloadTask.TaskSnapshot>	addOnProgressListener(Executor executor, OnProgressListener<? super TResult> listener) Adds a listener that is called periodically while the ControllableTask executes.
StorageTask<StreamDownloadTask.TaskSnapshot>	addOnProgressListener(OnProgressListener<? super TResult> listener) Adds a listener that is called periodically while the ControllableTask executes.
StorageTask<StreamDownloadTask.TaskSnapshot>	addOnProgressListener(Activity activity, OnProgressListener<? super TResult> listener) Adds a listener that is called periodically while the ControllableTask executes.
StorageTask<StreamDownloadTask.TaskSnapshot>	addOnSuccessListener(OnSuccessListener<? super TResult> listener) Adds a listener that is called if the Task completes successfully.
StorageTask<StreamDownloadTask.TaskSnapshot>	addOnSuccessListener(Activity activity, OnSuccessListener<? super TResult> listener) Adds a listener that is called if the Task completes successfully.
StorageTask<StreamDownloadTask.TaskSnapshot>	addOnSuccessListener(Executor executor, OnSuccessListener<? super TResult> listener) Adds a listener that is called if the Task completes successfully.
boolean	cancel() Attempts to cancel the task.
<TContinuationResult> Task<TContinuationResult>	continueWith(Continuation<StreamDownloadTask.TaskSnapshot, TContinuationResult> continuation) Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
<TContinuationResult> Task<TContinuationResult>	continueWith(Executor executor, Continuation<StreamDownloadTask.TaskSnapshot, TContinuationResult> continuation) Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
<TContinuationResult> Task<TContinuationResult>	continueWithTask(Executor executor, Continuation<StreamDownloadTask.TaskSnapshot, Task<TContinuationResult>> continuation) Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
<TContinuationResult> Task<TContinuationResult>	continueWithTask(Continuation<StreamDownloadTask.TaskSnapshot, Task<TContinuationResult>> 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.
StreamDownloadTask.TaskSnapshot	getResult() Gets the result of the Task, if it has already completed.
<X extends Throwable> StreamDownloadTask.TaskSnapshot	getResult(Class<X> exceptionType) Gets the result of the Task, if it has already completed.
StreamDownloadTask.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()
<TContinuationResult> Task<TContinuationResult>	onSuccessTask(Executor executor, SuccessContinuation<StreamDownloadTask.TaskSnapshot, TContinuationResult> 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.
<TContinuationResult> Task<TContinuationResult>	onSuccessTask(SuccessContinuation<StreamDownloadTask.TaskSnapshot, TContinuationResult> 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<StreamDownloadTask.TaskSnapshot>	removeOnCanceledListener(OnCanceledListener listener) Removes a listener.
StorageTask<StreamDownloadTask.TaskSnapshot>	removeOnCompleteListener(OnCompleteListener<StreamDownloadTask.TaskSnapshot> listener) Removes a listener.
StorageTask<StreamDownloadTask.TaskSnapshot>	removeOnFailureListener(OnFailureListener listener) Removes a listener.
StorageTask<StreamDownloadTask.TaskSnapshot>	removeOnPausedListener(OnPausedListener<? super TResult> listener) Removes a listener.
StorageTask<StreamDownloadTask.TaskSnapshot>	removeOnProgressListener(OnProgressListener<? super TResult> listener) Removes a listener.
StorageTask<StreamDownloadTask.TaskSnapshot>	removeOnSuccessListener(OnSuccessListener<? super TResult> listener) Removes a listener.
boolean	resume() Attempts to resume a paused task.

From class com.google.firebase.storage.ControllableTask

abstract ControllableTask<TResult extends StorageTask.ProvideError>	addOnPausedListener(Activity activity, OnPausedListener<? super TState> listener) Adds a listener that is called when the Task becomes paused.
abstract ControllableTask<TResult extends StorageTask.ProvideError>	addOnPausedListener(OnPausedListener<? super TState> listener) Adds a listener that is called when the Task becomes paused.
abstract ControllableTask<TResult extends StorageTask.ProvideError>	addOnPausedListener(Executor executor, OnPausedListener<? super TState> 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<TResult extends StorageTask.ProvideError>	addOnProgressListener(OnProgressListener<? super TState> listener) Adds a listener that is called periodically while the ControllableTask executes.
abstract CancellableTask<TResult extends StorageTask.ProvideError>	addOnProgressListener(Executor executor, OnProgressListener<? super TState> listener) Adds a listener that is called periodically while the ControllableTask executes.
abstract CancellableTask<TResult extends StorageTask.ProvideError>	addOnProgressListener(Activity activity, OnProgressListener<? super TState> 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<TResult>	addOnCanceledListener(OnCanceledListener arg0)
Task<TResult>	addOnCanceledListener(Executor arg0, OnCanceledListener arg1)
Task<TResult>	addOnCanceledListener(Activity arg0, OnCanceledListener arg1)
Task<TResult>	addOnCompleteListener(OnCompleteListener<TResult> arg0)
Task<TResult>	addOnCompleteListener(Activity arg0, OnCompleteListener<TResult> arg1)
Task<TResult>	addOnCompleteListener(Executor arg0, OnCompleteListener<TResult> arg1)
abstract Task<TResult>	addOnFailureListener(Activity arg0, OnFailureListener arg1)
abstract Task<TResult>	addOnFailureListener(OnFailureListener arg0)
abstract Task<TResult>	addOnFailureListener(Executor arg0, OnFailureListener arg1)
abstract Task<TResult>	addOnSuccessListener(Executor arg0, OnSuccessListener<? super TResult> arg1)
abstract Task<TResult>	addOnSuccessListener(OnSuccessListener<? super TResult> arg0)
abstract Task<TResult>	addOnSuccessListener(Activity arg0, OnSuccessListener<? super TResult> arg1)
<TContinuationResult> Task<TContinuationResult>	continueWith(Continuation<TResult, TContinuationResult> arg0)
<TContinuationResult> Task<TContinuationResult>	continueWith(Executor arg0, Continuation<TResult, TContinuationResult> arg1)
<TContinuationResult> Task<TContinuationResult>	continueWithTask(Continuation<TResult, Task<TContinuationResult>> arg0)
<TContinuationResult> Task<TContinuationResult>	continueWithTask(Executor arg0, Continuation<TResult, Task<TContinuationResult>> arg1)
abstract Exception	getException()
abstract TResult	getResult()
abstract <X extends Throwable> TResult	getResult(Class<X> arg0)
abstract boolean	isCanceled()
abstract boolean	isComplete()
abstract boolean	isSuccessful()
<TContinuationResult> Task<TContinuationResult>	onSuccessTask(Executor arg0, SuccessContinuation<TResult, TContinuationResult> arg1)
<TContinuationResult> Task<TContinuationResult>	onSuccessTask(SuccessContinuation<TResult, 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 ()

protected void onProgress ()

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License, and code samples are licensed under the Apache 2.0 License. For details, see our Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated May 23, 2018.