firebase-storage/com.google.firebase.storage/FileDownloadTask

FileDownloadTask

actual abstract class FileDownloadTask : StorageTask<FileDownloadTask.TaskSnapshot> (source)

A download to a file, as the Android SDK's FileDownloadTask; TaskSnapshot reports its progress.

actual abstract class FileDownloadTask : StorageTask<FileDownloadTask.TaskSnapshot> (source)

Leaves the members it inherits from StorageTask to FileDownloadTaskImpl, as the expect class does: implementing them here makes their modality differ from the expect class's, which the shared Apple metadata compilation rejects.

expect abstract class FileDownloadTask : StorageTask<FileDownloadTask.TaskSnapshot> (source)

A download to a file, as the Android SDK's FileDownloadTask; TaskSnapshot reports its progress.

actual abstract class FileDownloadTask : StorageTask<FileDownloadTask.TaskSnapshot> (source)

A download to a file on JS, which the SDK cannot do: the task fails at once with UnsupportedOperationException.

actual abstract class FileDownloadTask : StorageTask<FileDownloadTask.TaskSnapshot> (source)

A download to a file on JS, which the SDK cannot do: the task fails at once with UnsupportedOperationException.

Types

TaskSnapshot

actual inner class TaskSnapshot : StorageTask.SnapshotBase

The state of a download.

actual inner class TaskSnapshot : StorageTask.SnapshotBase

The state of a download.

expect inner class TaskSnapshot : StorageTask.SnapshotBase

The state of a download.

actual inner class TaskSnapshot : StorageTask.SnapshotBase

The state of a download.

actual inner class TaskSnapshot : StorageTask.SnapshotBase

The state of a download.

Properties

exception

@get:Nullable

abstract override val exception: Exception?

abstract val exception: Exception?

expect abstract val exception: Exception?

abstract val exception: Exception?

isCanceled

abstract override val isCanceled: Boolean

abstract val isCanceled: Boolean

expect abstract val isCanceled: Boolean

abstract val isCanceled: Boolean

isComplete

abstract override val isComplete: Boolean

abstract val isComplete: Boolean

expect abstract val isComplete: Boolean

abstract val isComplete: Boolean

isInProgress

actual 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).

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 isInProgress: Boolean

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

isPaused

actual open override val isPaused: Boolean

Whether the task is 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.

actual open override val isPaused: Boolean

Whether the task is paused.

isSuccessful

abstract override val isSuccessful: Boolean

abstract val isSuccessful: Boolean

expect abstract val isSuccessful: Boolean

abstract val isSuccessful: Boolean

result

abstract override val result: FileDownloadTask.TaskSnapshot?

abstract val result: FileDownloadTask.TaskSnapshot

expect abstract val result: FileDownloadTask.TaskSnapshot

abstract val result: FileDownloadTask.TaskSnapshot

snapshot

actual val snapshot: FileDownloadTask.TaskSnapshot

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

actual val snapshot: FileDownloadTask.TaskSnapshot

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

expect val snapshot: FileDownloadTask.TaskSnapshot

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

actual val snapshot: FileDownloadTask.TaskSnapshot

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

actual val snapshot: FileDownloadTask.TaskSnapshot

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

taskState

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

@NonNull

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

@NonNull

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

actual open override fun addOnCanceledListener(listener: OnCanceledListener): StorageTask<FileDownloadTask.TaskSnapshot>

expect open override fun addOnCanceledListener(listener: OnCanceledListener): StorageTask<FileDownloadTask.TaskSnapshot>

actual open override fun addOnCanceledListener(listener: OnCanceledListener): StorageTask<FileDownloadTask.TaskSnapshot>

addOnCompleteListener

@NonNull

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

@NonNull

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

actual open override fun addOnCompleteListener(listener: OnCompleteListener<FileDownloadTask.TaskSnapshot>): StorageTask<FileDownloadTask.TaskSnapshot>

expect open override fun addOnCompleteListener(listener: OnCompleteListener<FileDownloadTask.TaskSnapshot>): StorageTask<FileDownloadTask.TaskSnapshot>

actual open override fun addOnCompleteListener(listener: OnCompleteListener<FileDownloadTask.TaskSnapshot>): StorageTask<FileDownloadTask.TaskSnapshot>

addOnFailureListener

@NonNull

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

@NonNull

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

actual open override fun addOnFailureListener(listener: OnFailureListener): StorageTask<FileDownloadTask.TaskSnapshot>

expect open override fun addOnFailureListener(listener: OnFailureListener): StorageTask<FileDownloadTask.TaskSnapshot>

actual open override fun addOnFailureListener(listener: OnFailureListener): StorageTask<FileDownloadTask.TaskSnapshot>

addOnPausedListener

actual open override fun addOnPausedListener(listener: OnPausedListener<FileDownloadTask.TaskSnapshot>): StorageTask<FileDownloadTask.TaskSnapshot>

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

actual open override fun addOnPausedListener(listener: OnPausedListener<FileDownloadTask.TaskSnapshot>): StorageTask<FileDownloadTask.TaskSnapshot>

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

expect open override fun addOnPausedListener(listener: OnPausedListener<FileDownloadTask.TaskSnapshot>): StorageTask<FileDownloadTask.TaskSnapshot>

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

actual open override fun addOnPausedListener(listener: OnPausedListener<FileDownloadTask.TaskSnapshot>): StorageTask<FileDownloadTask.TaskSnapshot>

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

actual open override fun addOnPausedListener(listener: OnPausedListener<FileDownloadTask.TaskSnapshot>): StorageTask<FileDownloadTask.TaskSnapshot>

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

addOnProgressListener

actual open override fun addOnProgressListener(listener: OnProgressListener<FileDownloadTask.TaskSnapshot>): StorageTask<FileDownloadTask.TaskSnapshot>

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

actual open override fun addOnProgressListener(listener: OnProgressListener<FileDownloadTask.TaskSnapshot>): StorageTask<FileDownloadTask.TaskSnapshot>

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

expect open override fun addOnProgressListener(listener: OnProgressListener<FileDownloadTask.TaskSnapshot>): StorageTask<FileDownloadTask.TaskSnapshot>

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

actual open override fun addOnProgressListener(listener: OnProgressListener<FileDownloadTask.TaskSnapshot>): StorageTask<FileDownloadTask.TaskSnapshot>

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

actual open override fun addOnProgressListener(listener: OnProgressListener<FileDownloadTask.TaskSnapshot>): StorageTask<FileDownloadTask.TaskSnapshot>

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

addOnSuccessListener

@NonNull

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

@NonNull

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

actual open override fun addOnSuccessListener(listener: OnSuccessListener<in FileDownloadTask.TaskSnapshot>): StorageTask<FileDownloadTask.TaskSnapshot>

expect open override fun addOnSuccessListener(listener: OnSuccessListener<in FileDownloadTask.TaskSnapshot>): StorageTask<FileDownloadTask.TaskSnapshot>

actual open override fun addOnSuccessListener(listener: OnSuccessListener<in FileDownloadTask.TaskSnapshot>): StorageTask<FileDownloadTask.TaskSnapshot>

cancel

actual 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.

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.

actual open override fun cancel(): Boolean

Cancels the task; true if it was running.

continueWith

@NonNull

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

actual open override fun <ContinuationResultT> continueWith(continuation: Continuation<FileDownloadTask.TaskSnapshot, ContinuationResultT>): Task<ContinuationResultT>

expect open override fun <ContinuationResultT> continueWith(continuation: Continuation<FileDownloadTask.TaskSnapshot, ContinuationResultT>): Task<ContinuationResultT>

actual open override fun <ContinuationResultT> continueWith(continuation: Continuation<FileDownloadTask.TaskSnapshot, ContinuationResultT>): Task<ContinuationResultT>

continueWithTask

@NonNull

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

actual open override fun <ContinuationResultT> continueWithTask(continuation: Continuation<FileDownloadTask.TaskSnapshot, Task<ContinuationResultT>>): Task<ContinuationResultT>

expect open override fun <ContinuationResultT> continueWithTask(continuation: Continuation<FileDownloadTask.TaskSnapshot, Task<ContinuationResultT>>): Task<ContinuationResultT>

actual open override fun <ContinuationResultT> continueWithTask(continuation: Continuation<FileDownloadTask.TaskSnapshot, Task<ContinuationResultT>>): Task<ContinuationResultT>

getResult

abstract fun getResult(): FileDownloadTask.TaskSnapshot?

abstract fun <X : Throwable?> getResult(@NonNull p0: Class<X?>): FileDownloadTask.TaskSnapshot?

onSuccessTask

@NonNull

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

actual open override fun <ContinuationResultT> onSuccessTask(successContinuation: SuccessContinuation<FileDownloadTask.TaskSnapshot, ContinuationResultT>): Task<ContinuationResultT>

expect open override fun <ContinuationResultT> onSuccessTask(successContinuation: SuccessContinuation<FileDownloadTask.TaskSnapshot, ContinuationResultT>): Task<ContinuationResultT>

actual open override fun <ContinuationResultT> onSuccessTask(successContinuation: SuccessContinuation<FileDownloadTask.TaskSnapshot, ContinuationResultT>): Task<ContinuationResultT>

pause

actual 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.

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.

actual open override fun pause(): Boolean

Pauses the task; true if it was running.

removeOnCanceledListener

actual fun removeOnCanceledListener(listener: OnCanceledListener): StorageTask<FileDownloadTask.TaskSnapshot>

expect fun removeOnCanceledListener(listener: OnCanceledListener): StorageTask<FileDownloadTask.TaskSnapshot>

actual fun removeOnCanceledListener(listener: OnCanceledListener): StorageTask<FileDownloadTask.TaskSnapshot>

removeOnCompleteListener

actual fun removeOnCompleteListener(listener: OnCompleteListener<FileDownloadTask.TaskSnapshot>): StorageTask<FileDownloadTask.TaskSnapshot>

expect fun removeOnCompleteListener(listener: OnCompleteListener<FileDownloadTask.TaskSnapshot>): StorageTask<FileDownloadTask.TaskSnapshot>

actual fun removeOnCompleteListener(listener: OnCompleteListener<FileDownloadTask.TaskSnapshot>): StorageTask<FileDownloadTask.TaskSnapshot>

removeOnFailureListener

actual fun removeOnFailureListener(listener: OnFailureListener): StorageTask<FileDownloadTask.TaskSnapshot>

expect fun removeOnFailureListener(listener: OnFailureListener): StorageTask<FileDownloadTask.TaskSnapshot>

actual fun removeOnFailureListener(listener: OnFailureListener): StorageTask<FileDownloadTask.TaskSnapshot>

removeOnPausedListener

actual fun removeOnPausedListener(listener: OnPausedListener<FileDownloadTask.TaskSnapshot>): StorageTask<FileDownloadTask.TaskSnapshot>

expect fun removeOnPausedListener(listener: OnPausedListener<FileDownloadTask.TaskSnapshot>): StorageTask<FileDownloadTask.TaskSnapshot>

actual fun removeOnPausedListener(listener: OnPausedListener<FileDownloadTask.TaskSnapshot>): StorageTask<FileDownloadTask.TaskSnapshot>

removeOnProgressListener

actual fun removeOnProgressListener(listener: OnProgressListener<FileDownloadTask.TaskSnapshot>): StorageTask<FileDownloadTask.TaskSnapshot>

expect fun removeOnProgressListener(listener: OnProgressListener<FileDownloadTask.TaskSnapshot>): StorageTask<FileDownloadTask.TaskSnapshot>

actual fun removeOnProgressListener(listener: OnProgressListener<FileDownloadTask.TaskSnapshot>): StorageTask<FileDownloadTask.TaskSnapshot>

removeOnSuccessListener

actual fun removeOnSuccessListener(listener: OnSuccessListener<in FileDownloadTask.TaskSnapshot>): StorageTask<FileDownloadTask.TaskSnapshot>

expect fun removeOnSuccessListener(listener: OnSuccessListener<in FileDownloadTask.TaskSnapshot>): StorageTask<FileDownloadTask.TaskSnapshot>

actual fun removeOnSuccessListener(listener: OnSuccessListener<in FileDownloadTask.TaskSnapshot>): StorageTask<FileDownloadTask.TaskSnapshot>

resume

actual open override fun resume(): Boolean