firebase-storage/com.google.firebase.storage/StorageTask

StorageTask

actual abstract class StorageTask<ResultT : StorageTask.ProvideError> : ControllableTask<ResultT> (source)

A long-running Cloud Storage operation with progress, pause, resume and cancel, as the Android SDK's StorageTask. Listeners are called on the thread that completes or progresses the task on Apple platforms and JS. The Task members (isComplete, result, exception, ...) are inherited; the task subclasses are abstract, as instances only come from a StorageReference.

Inheritors

FileDownloadTask

expect abstract class StorageTask<ResultT : StorageTask.ProvideError> : ControllableTask<ResultT> (source)

A long-running Cloud Storage operation with progress, pause, resume and cancel, as the Android SDK's StorageTask. Listeners are called on the thread that completes or progresses the task on Apple platforms and JS. The Task members (isComplete, result, exception, ...) are inherited; the task subclasses are abstract, as instances only come from a StorageReference.

Inheritors

FileDownloadTask

actual abstract class StorageTask<ResultT : StorageTask.ProvideError> : ControllableTask<ResultT> (source)

A long-running Cloud Storage operation with progress, pause, resume and cancel, as the Android SDK's StorageTask. Listeners are called on the thread that completes or progresses the task on Apple platforms and JS. The Task members (isComplete, result, exception, ...) are inherited; the task subclasses are abstract, as instances only come from a StorageReference.

Inheritors

Types

actual interface ProvideError

What a task's result provides: the error it failed with, if any.

expect interface ProvideError

What a task's result provides: the error it failed with, if any.

actual interface ProvideError

What a task's result provides: the error it failed with, if any.

actual open inner class SnapshotBase : StorageTask.ProvideError

The base of a task's snapshots: the error, if any, and the task and reference they belong to.

expect open inner class SnapshotBase : StorageTask.ProvideError

The base of a task's snapshots: the error, if any, and the task and reference they belong to.

actual open inner class SnapshotBase : StorageTask.ProvideError

The base of a task's snapshots: the error, if any, and the task and reference they belong to.

Properties

abstract override val exception: Exception?

expect abstract val exception: Exception?

abstract val exception: Exception?

abstract override val isCanceled: Boolean

expect abstract val isCanceled: Boolean

abstract val isCanceled: Boolean

abstract override val isComplete: Boolean

expect abstract val isComplete: Boolean

abstract val isComplete: Boolean

actual open override val isInProgress: Boolean

Whether the task is running (not complete, cancelled or paused).

expect open override val isInProgress: Boolean

Whether the task is running (not complete, cancelled or paused).

actual open override val isInProgress: Boolean

Whether the task is running (not complete, cancelled or paused).

actual open override val isPaused: Boolean

Whether the task is paused.

expect open override val isPaused: Boolean

Whether the task is paused.

actual open override val isPaused: Boolean

Whether the task is paused.

abstract override val isSuccessful: Boolean

expect abstract val isSuccessful: Boolean

abstract val isSuccessful: Boolean

abstract override val result: ResultT?

expect abstract val result: ResultT

abstract val result: ResultT

actual val snapshot: ResultT

The current state of the task, whether or not it is complete.

expect val snapshot: ResultT

The current state of the task, whether or not it is complete.

actual val snapshot: ResultT

The current state of the task, whether or not it is complete.

val <T : StorageTask.ProvideError> StorageTask<T>.taskState: Flow<TaskState<T>>

The progress and pauses of this task as a Flow, which completes with the task.

Functions

addOnCanceledListener

open fun addOnCanceledListener(@NonNull p0: Activity, @NonNull p1: OnCanceledListener): Task<ResultT?>

open fun addOnCanceledListener(@NonNull p0: Executor, @NonNull p1: OnCanceledListener): Task<ResultT?>

actual open override fun addOnCanceledListener(listener: OnCanceledListener): StorageTask<ResultT>

expect open override fun addOnCanceledListener(listener: OnCanceledListener): StorageTask<ResultT>

actual open override fun addOnCanceledListener(listener: OnCanceledListener): StorageTask<ResultT>

addOnCompleteListener

open fun addOnCompleteListener(@NonNull p0: Activity, @NonNull p1: OnCompleteListener<ResultT?>): Task<ResultT?>

open fun addOnCompleteListener(@NonNull p0: Executor, @NonNull p1: OnCompleteListener<ResultT?>): Task<ResultT?>

actual open override fun addOnCompleteListener(listener: OnCompleteListener<ResultT>): StorageTask<ResultT>

expect open override fun addOnCompleteListener(listener: OnCompleteListener<ResultT>): StorageTask<ResultT>

actual open override fun addOnCompleteListener(listener: OnCompleteListener<ResultT>): StorageTask<ResultT>

addOnFailureListener

abstract fun addOnFailureListener(@NonNull p0: Activity, @NonNull p1: OnFailureListener): Task<ResultT?>

abstract fun addOnFailureListener(@NonNull p0: Executor, @NonNull p1: OnFailureListener): Task<ResultT?>

actual open override fun addOnFailureListener(listener: OnFailureListener): StorageTask<ResultT>

expect open override fun addOnFailureListener(listener: OnFailureListener): StorageTask<ResultT>

actual open override fun addOnFailureListener(listener: OnFailureListener): StorageTask<ResultT>

addOnPausedListener

actual open override fun addOnPausedListener(listener: OnPausedListener<ResultT>): StorageTask<ResultT>

Adds a listener called with a snapshot when the task is paused.

expect open override fun addOnPausedListener(listener: OnPausedListener<ResultT>): StorageTask<ResultT>

Adds a listener called with a snapshot when the task is paused.

actual open override fun addOnPausedListener(listener: OnPausedListener<ResultT>): StorageTask<ResultT>

Adds a listener called with a snapshot when the task is paused.

addOnProgressListener

actual open override fun addOnProgressListener(listener: OnProgressListener<ResultT>): StorageTask<ResultT>

Adds a listener called with a snapshot whenever progress is made.

expect open override fun addOnProgressListener(listener: OnProgressListener<ResultT>): StorageTask<ResultT>

Adds a listener called with a snapshot whenever progress is made.

actual open override fun addOnProgressListener(listener: OnProgressListener<ResultT>): StorageTask<ResultT>

Adds a listener called with a snapshot whenever progress is made.

addOnSuccessListener

abstract fun addOnSuccessListener(@NonNull p0: Activity, @NonNull p1: OnSuccessListener<in ResultT?>): Task<ResultT?>

abstract fun addOnSuccessListener(@NonNull p0: Executor, @NonNull p1: OnSuccessListener<in ResultT?>): Task<ResultT?>

actual open override fun addOnSuccessListener(listener: OnSuccessListener<in ResultT>): StorageTask<ResultT>

expect open override fun addOnSuccessListener(listener: OnSuccessListener<in ResultT>): StorageTask<ResultT>

actual open override fun addOnSuccessListener(listener: OnSuccessListener<in ResultT>): StorageTask<ResultT>

actual open override fun cancel(): Boolean

Cancels the task; true if it was running.

expect open override fun cancel(): Boolean

Cancels the task; true if it was running.

actual open override fun cancel(): Boolean

Cancels the task; true if it was running.

open fun <TContinuationResult : Any?> continueWith(@NonNull p0: Executor, @NonNull p1: Continuation<ResultT?, TContinuationResult?>): Task<TContinuationResult?>

actual open override fun <ContinuationResultT> continueWith(continuation: Continuation<ResultT, ContinuationResultT>): Task<ContinuationResultT>

expect open override fun <ContinuationResultT> continueWith(continuation: Continuation<ResultT, ContinuationResultT>): Task<ContinuationResultT>

actual open override fun <ContinuationResultT> continueWith(continuation: Continuation<ResultT, ContinuationResultT>): Task<ContinuationResultT>

continueWithTask

open fun <TContinuationResult : Any?> continueWithTask(@NonNull p0: Executor, @NonNull p1: Continuation<ResultT?, Task<TContinuationResult?>?>): Task<TContinuationResult?>

actual open override fun <ContinuationResultT> continueWithTask(continuation: Continuation<ResultT, Task<ContinuationResultT>>): Task<ContinuationResultT>

expect open override fun <ContinuationResultT> continueWithTask(continuation: Continuation<ResultT, Task<ContinuationResultT>>): Task<ContinuationResultT>

actual open override fun <ContinuationResultT> continueWithTask(continuation: Continuation<ResultT, Task<ContinuationResultT>>): Task<ContinuationResultT>

abstract fun getResult(): ResultT?

abstract fun <X : Throwable?> getResult(@NonNull p0: Class<X?>): ResultT?

open fun <TContinuationResult : Any?> onSuccessTask(@NonNull p0: Executor, @NonNull p1: SuccessContinuation<ResultT?, TContinuationResult?>): Task<TContinuationResult?>

actual open override fun <ContinuationResultT> onSuccessTask(successContinuation: SuccessContinuation<ResultT, ContinuationResultT>): Task<ContinuationResultT>

expect open override fun <ContinuationResultT> onSuccessTask(successContinuation: SuccessContinuation<ResultT, ContinuationResultT>): Task<ContinuationResultT>

actual open override fun <ContinuationResultT> onSuccessTask(successContinuation: SuccessContinuation<ResultT, ContinuationResultT>): Task<ContinuationResultT>

actual open override fun pause(): Boolean

Pauses the task; true if it was running.

expect open override fun pause(): Boolean

Pauses the task; true if it was running.

actual open override fun pause(): Boolean

Pauses the task; true if it was running.

removeOnCanceledListener

actual fun removeOnCanceledListener(listener: OnCanceledListener): StorageTask<ResultT>

expect fun removeOnCanceledListener(listener: OnCanceledListener): StorageTask<ResultT>

actual fun removeOnCanceledListener(listener: OnCanceledListener): StorageTask<ResultT>

removeOnCompleteListener

actual fun removeOnCompleteListener(listener: OnCompleteListener<ResultT>): StorageTask<ResultT>

expect fun removeOnCompleteListener(listener: OnCompleteListener<ResultT>): StorageTask<ResultT>

actual fun removeOnCompleteListener(listener: OnCompleteListener<ResultT>): StorageTask<ResultT>

removeOnFailureListener

actual fun removeOnFailureListener(listener: OnFailureListener): StorageTask<ResultT>

expect fun removeOnFailureListener(listener: OnFailureListener): StorageTask<ResultT>

actual fun removeOnFailureListener(listener: OnFailureListener): StorageTask<ResultT>

removeOnPausedListener

actual fun removeOnPausedListener(listener: OnPausedListener<ResultT>): StorageTask<ResultT>

expect fun removeOnPausedListener(listener: OnPausedListener<ResultT>): StorageTask<ResultT>

actual fun removeOnPausedListener(listener: OnPausedListener<ResultT>): StorageTask<ResultT>

removeOnProgressListener

actual fun removeOnProgressListener(listener: OnProgressListener<ResultT>): StorageTask<ResultT>

expect fun removeOnProgressListener(listener: OnProgressListener<ResultT>): StorageTask<ResultT>

actual fun removeOnProgressListener(listener: OnProgressListener<ResultT>): StorageTask<ResultT>

removeOnSuccessListener

actual fun removeOnSuccessListener(listener: OnSuccessListener<in ResultT>): StorageTask<ResultT>

expect fun removeOnSuccessListener(listener: OnSuccessListener<in ResultT>): StorageTask<ResultT>

actual fun removeOnSuccessListener(listener: OnSuccessListener<in ResultT>): StorageTask<ResultT>

actual open override fun resume(): Boolean

Resumes the task; true if it was paused.

expect open override fun resume(): Boolean

Resumes the task; true if it was paused.

actual open override fun resume(): Boolean

Resumes the task; true if it was paused.