Package-level declarations

Types

Link copied to clipboard
actual abstract class CancellableTask<StateT> : Task<StateT>

A Task that can be cancelled and reports progress, as the Android SDK's CancellableTask.

expect abstract class CancellableTask<StateT> : Task<StateT>

A Task that can be cancelled and reports progress, as the Android SDK's CancellableTask.

actual abstract class CancellableTask<StateT> : Task<StateT>

A Task that can be cancelled and reports progress, as the Android SDK's CancellableTask.

Link copied to clipboard
actual abstract class ControllableTask<StateT> : CancellableTask<StateT>

A CancellableTask that can also be paused and resumed, as the Android SDK's ControllableTask.

expect abstract class ControllableTask<StateT> : CancellableTask<StateT>

A CancellableTask that can also be paused and resumed, as the Android SDK's ControllableTask.

actual abstract class ControllableTask<StateT> : CancellableTask<StateT>

A CancellableTask that can also be paused and resumed, as the Android SDK's ControllableTask.

Link copied to clipboard

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

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.

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

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

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

Link copied to clipboard
actual class FirebaseStorage

Cloud Storage for Firebase, as the Android SDK's com.google.firebase.storage.FirebaseStorage. The download retry time, file downloads and FileDownloadTask exist on Android, the JVM and Apple platforms (nonJsMain); the JS SDK downloads through URLs only.

actual class FirebaseStorage
expect class FirebaseStorage

Cloud Storage for Firebase, as the Android SDK's com.google.firebase.storage.FirebaseStorage. The download retry time, file downloads and FileDownloadTask exist on Android, the JVM and Apple platforms (nonJsMain); the JS SDK downloads through URLs only.

actual class FirebaseStorage
actual class FirebaseStorage
Link copied to clipboard
actual class ListResult

A page of the items and prefixes (folders) under a reference, as the Android SDK's ListResult.

expect class ListResult

A page of the items and prefixes (folders) under a reference, as the Android SDK's ListResult.

actual class ListResult

A page of the items and prefixes (folders) under a reference, as the Android SDK's ListResult.

Link copied to clipboard
fun interface OnPausedListener<in ProgressT>

Receives the snapshots of a paused task; the Android SDK's OnPausedListener.

Link copied to clipboard
fun interface OnProgressListener<in ProgressT>

Receives the snapshots of a task as it makes progress; the Android SDK's OnProgressListener.

Link copied to clipboard

An error of Cloud Storage, as the Android SDK's StorageException; errorCode is one of the ERROR_* constants.

An error of Cloud Storage, as the Android SDK's StorageException; errorCode is one of the ERROR_* constants.

An error of Cloud Storage, as the Android SDK's StorageException; errorCode is one of the ERROR_* constants.

Link copied to clipboard
actual class StorageMetadata

The metadata of an object in Cloud Storage, as the Android SDK's StorageMetadata: the server-set fields are read from a fetched object, the settable fields are built with Builder (chained setters or, from Kotlin, properties: storageMetadata { contentType = "text/plain" }).

expect class StorageMetadata

The metadata of an object in Cloud Storage, as the Android SDK's StorageMetadata: the server-set fields are read from a fetched object, the settable fields are built with Builder (chained setters or, from Kotlin, properties: storageMetadata { contentType = "text/plain" }).

actual class StorageMetadata

The metadata of an object in Cloud Storage, as the Android SDK's StorageMetadata: the server-set fields are read from a fetched object, the settable fields are built with Builder (chained setters or, from Kotlin, properties: storageMetadata { contentType = "text/plain" }).

Link copied to clipboard

A reference to an object or folder in Cloud Storage, as the Android SDK's StorageReference. Uploads from a file and downloads to a file are the putFile / getFile extensions, which take the platform's file type.

A reference to an object or folder in Cloud Storage, as the Android SDK's StorageReference. Uploads from a file and downloads to a file are the putFile / getFile extensions, which take the platform's file type.

Link copied to clipboard

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.

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.

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.

Link copied to clipboard
abstract class TaskState<T>

The state of a StorageTask as emitted by taskState.

Link copied to clipboard

An upload to a StorageReference, as the Android SDK's UploadTask; TaskSnapshot reports its progress.

An upload to a StorageReference, as the Android SDK's UploadTask; TaskSnapshot reports its progress.

An upload to a StorageReference, as the Android SDK's UploadTask; TaskSnapshot reports its progress.

Properties

Link copied to clipboard

The downloads from this reference that have not completed; always empty on JS.

The downloads from this reference that have not completed; always empty on JS.

The downloads from this reference that have not completed; always empty on JS.

Always empty: the JS SDK has no file downloads.

Always empty: the JS SDK has no file downloads.

Link copied to clipboard

The maximum time to retry downloads, in milliseconds; no effect on JS.

The maximum time to retry downloads, in milliseconds; no effect on JS.

The maximum time to retry downloads, in milliseconds; no effect on JS.

Kept in memory with no effect: the JS SDK has no file downloads.

Kept in memory with no effect: the JS SDK has no file downloads.

Link copied to clipboard

The FirebaseStorage of the default FirebaseApp; the Android SDK's Firebase.storage.

Link copied to clipboard

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

Link copied to clipboard

The URL of the resumable upload session, if the SDK exposes it (the Android SDK returns an android.net.Uri, which common code cannot name; on Android the SDK's member binds for Android code and this String form is shipped).

The URL of the resumable upload session, if the SDK exposes it (the Android SDK returns an android.net.Uri, which common code cannot name; on Android the SDK's member binds for Android code and this String form is shipped).

The Apple and JS SDKs do not expose the resumable upload session.

Functions

Link copied to clipboard

The bytes downloaded so far.

The items of the page.

The bytes uploaded so far.

Link copied to clipboard

The total size of the download.

The prefixes of the page.

The total size of the upload.

Link copied to clipboard
operator fun ListResult.component3(): String?

The token of the next page.

The metadata of the uploaded object, once complete.

Link copied to clipboard
actual fun StorageReference.getFile(destination: Any): FileDownloadTask

destination is an android.net.Uri, a java.io.File or a String path.

actual fun StorageReference.getFile(destination: Any): FileDownloadTask

destination is an NSURL or a String path.

expect fun StorageReference.getFile(destination: Any): FileDownloadTask

Downloads the object to the file destination (see the platform file types above). Fails on JS, whose SDK has no file downloads.

actual fun StorageReference.getFile(destination: Any): FileDownloadTask

Fails: the JS SDK downloads through URLs, not to files; use StorageReference.getBytes or StorageReference.getDownloadUrl.

actual fun StorageReference.getFile(destination: Any): FileDownloadTask

Fails: the JS SDK downloads through URLs, not to files; use StorageReference.getBytes or StorageReference.getDownloadUrl.

Link copied to clipboard

file is an android.net.Uri, a java.io.File or a String URI.

actual fun StorageReference.putFile(file: Any, metadata: StorageMetadata): UploadTask

Uploads the file file to this reference with metadata.

file is an NSURL or a String path.

actual fun StorageReference.putFile(file: Any, metadata: StorageMetadata): UploadTask

Uploads the file file to this reference with metadata.

Uploads the file file (see the platform file types above) to this reference.

expect fun StorageReference.putFile(file: Any, metadata: StorageMetadata): UploadTask

Uploads the file file to this reference with metadata.

file is a File or Blob, or a String file URL is not supported (the browser cannot read files by path).

actual fun StorageReference.putFile(file: Any, metadata: StorageMetadata): UploadTask

Uploads the file file to this reference with metadata.

file is a File or Blob, or a String file URL is not supported (the browser cannot read files by path).

actual fun StorageReference.putFile(file: Any, metadata: StorageMetadata): UploadTask

Uploads the file file to this reference with metadata.

Link copied to clipboard
Link copied to clipboard