com.google.firebase.storage.ktx
Classes
TaskState |
This class is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration. |
TaskState.InProgress |
This class is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration. |
TaskState.Paused |
This class is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration. |
Top-level functions summary
StorageMetadata |
This function is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration. |
Extension functions summary
operator Long |
This function is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration. |
operator List<StorageReference> |
This function is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration. |
operator Long |
This function is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration. |
operator Long |
This function is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration. |
operator Long |
This function is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration. |
operator List<StorageReference> |
This function is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration. |
operator Long |
This function is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration. |
operator Long |
This function is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration. |
operator String? |
This function is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration. |
operator InputStream |
This function is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration. |
operator StorageMetadata? |
This function is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration. |
operator Uri? |
This function is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration. |
FirebaseStorage |
Firebase.storage(app: FirebaseApp, url: String)Accessing this object for Kotlin apps has changed; see the migration guide. |
FirebaseStorage |
Firebase.storage(app: FirebaseApp)Accessing this object for Kotlin apps has changed; see the migration guide. |
FirebaseStorage |
Accessing this object for Kotlin apps has changed; see the migration guide. |
Extension properties summary
FirebaseStorage |
Accessing this object for Kotlin apps has changed; see the migration guide. |
Flow<TaskState<T>> |
This property is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration. |
Top-level functions
storageMetadata
funstorageMetadata(init: StorageMetadata.Builder.() -> Unit): StorageMetadata
Returns a StorageMetadata object initialized using the init function.
Deprecation Notice: The Kotlin extensions (KTX) APIs have been added to their respective main modules, and the Kotlin extension (KTX) APIs in com.google.firebase.firebase-storage-ktx are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the FAQ about this initiative.
Extension functions
component1
operator fun FileDownloadTask.TaskSnapshot.component1(): Long
Destructuring declaration for FileDownloadTask.TaskSnapshot to provide bytesTransferred.
Deprecation Notice: The Kotlin extensions (KTX) APIs have been added to their respective main modules, and the Kotlin extension (KTX) APIs in com.google.firebase.firebase-storage-ktx are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the FAQ about this initiative.
| Returns | |
|---|---|
Long |
the bytesTransferred of the |
component1
operator fun ListResult.component1(): List<StorageReference>
Destructuring declaration for ListResult to provide its items.
Deprecation Notice: The Kotlin extensions (KTX) APIs have been added to their respective main modules, and the Kotlin extension (KTX) APIs in com.google.firebase.firebase-storage-ktx are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the FAQ about this initiative.
| Returns | |
|---|---|
List<StorageReference> |
the items of the |
component1
operator fun StreamDownloadTask.TaskSnapshot.component1(): Long
Destructuring declaration for StreamDownloadTask.TaskSnapshot to provide bytesTransferred.
Deprecation Notice: The Kotlin extensions (KTX) APIs have been added to their respective main modules, and the Kotlin extension (KTX) APIs in com.google.firebase.firebase-storage-ktx are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the FAQ about this initiative.
| Returns | |
|---|---|
Long |
the bytesTransferred of the |
component1
operator fun UploadTask.TaskSnapshot.component1(): Long
Destructuring declaration for UploadTask.TaskSnapshot to provide bytesTransferred.
Deprecation Notice: The Kotlin extensions (KTX) APIs have been added to their respective main modules, and the Kotlin extension (KTX) APIs in com.google.firebase.firebase-storage-ktx are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the FAQ about this initiative.
| Returns | |
|---|---|
Long |
the bytesTransferred of the |
component2
operator fun FileDownloadTask.TaskSnapshot.component2(): Long
Destructuring declaration for FileDownloadTask.TaskSnapshot to provide totalByteCount.
Deprecation Notice: The Kotlin extensions (KTX) APIs have been added to their respective main modules, and the Kotlin extension (KTX) APIs in com.google.firebase.firebase-storage-ktx are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the FAQ about this initiative.
| Returns | |
|---|---|
Long |
the totalByteCount of the |
component2
operator fun ListResult.component2(): List<StorageReference>
Destructuring declaration for ListResult to provide its prefixes.
Deprecation Notice: The Kotlin extensions (KTX) APIs have been added to their respective main modules, and the Kotlin extension (KTX) APIs in com.google.firebase.firebase-storage-ktx are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the FAQ about this initiative.
| Returns | |
|---|---|
List<StorageReference> |
the prefixes of the |
component2
operator fun StreamDownloadTask.TaskSnapshot.component2(): Long
Destructuring declaration for StreamDownloadTask.TaskSnapshot to provide totalByteCount.
Deprecation Notice: The Kotlin extensions (KTX) APIs have been added to their respective main modules, and the Kotlin extension (KTX) APIs in com.google.firebase.firebase-storage-ktx are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the FAQ about this initiative.
| Returns | |
|---|---|
Long |
the totalByteCount of the |
component2
operator fun UploadTask.TaskSnapshot.component2(): Long
Destructuring declaration for UploadTask.TaskSnapshot to provide totalByteCount.
Deprecation Notice: The Kotlin extensions (KTX) APIs have been added to their respective main modules, and the Kotlin extension (KTX) APIs in com.google.firebase.firebase-storage-ktx are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the FAQ about this initiative.
| Returns | |
|---|---|
Long |
the totalByteCount of the |
component3
operator fun ListResult.component3(): String?
Destructuring declaration for ListResult to provide its pageToken.
Deprecation Notice: The Kotlin extensions (KTX) APIs have been added to their respective main modules, and the Kotlin extension (KTX) APIs in com.google.firebase.firebase-storage-ktx are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the FAQ about this initiative.
| Returns | |
|---|---|
String? |
the pageToken of the |
component3
operator fun StreamDownloadTask.TaskSnapshot.component3(): InputStream
Destructuring declaration for StreamDownloadTask.TaskSnapshot to provide its stream.
Deprecation Notice: The Kotlin extensions (KTX) APIs have been added to their respective main modules, and the Kotlin extension (KTX) APIs in com.google.firebase.firebase-storage-ktx are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the FAQ about this initiative.
| Returns | |
|---|---|
InputStream |
the stream of the |
component3
operator fun UploadTask.TaskSnapshot.component3(): StorageMetadata?
Destructuring declaration for UploadTask.TaskSnapshot to provide its metadata.
Deprecation Notice: The Kotlin extensions (KTX) APIs have been added to their respective main modules, and the Kotlin extension (KTX) APIs in com.google.firebase.firebase-storage-ktx are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the FAQ about this initiative.
| Returns | |
|---|---|
StorageMetadata? |
the metadata of the |
component4
operator fun UploadTask.TaskSnapshot.component4(): Uri?
Destructuring declaration for UploadTask.TaskSnapshot to provide its uploadSessionUri.
Deprecation Notice: The Kotlin extensions (KTX) APIs have been added to their respective main modules, and the Kotlin extension (KTX) APIs in com.google.firebase.firebase-storage-ktx are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the FAQ about this initiative.
| Returns | |
|---|---|
Uri? |
the uploadSessionUri of the |
storage
fun Firebase.storage(app: FirebaseApp, url: String): FirebaseStorage
Accessing this object for Kotlin apps has changed; see the migration guide.
Returns the FirebaseStorage instance of a given FirebaseApp and storage bucket url.
Deprecation Notice: The Kotlin extensions (KTX) APIs have been added to their respective main modules, and the Kotlin extension (KTX) APIs in com.google.firebase.firebase-storage-ktx are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the FAQ about this initiative.
storage
fun Firebase.storage(app: FirebaseApp): FirebaseStorage
Accessing this object for Kotlin apps has changed; see the migration guide.
Returns the FirebaseStorage instance of a given FirebaseApp.
Deprecation Notice: The Kotlin extensions (KTX) APIs have been added to their respective main modules, and the Kotlin extension (KTX) APIs in com.google.firebase.firebase-storage-ktx are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the FAQ about this initiative.
storage
fun Firebase.storage(url: String): FirebaseStorage
Accessing this object for Kotlin apps has changed; see the migration guide.
Returns the FirebaseStorage instance for a custom storage bucket at url.
Deprecation Notice: The Kotlin extensions (KTX) APIs have been added to their respective main modules, and the Kotlin extension (KTX) APIs in com.google.firebase.firebase-storage-ktx are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the FAQ about this initiative.
Extension properties
storage
val Firebase.storage: FirebaseStorage
Accessing this object for Kotlin apps has changed; see the migration guide.
Returns the FirebaseStorage instance of the default FirebaseApp.
Deprecation Notice: The Kotlin extensions (KTX) APIs have been added to their respective main modules, and the Kotlin extension (KTX) APIs in com.google.firebase.firebase-storage-ktx are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the FAQ about this initiative.
taskState
val StorageTask<T>.taskState: Flow<TaskState<T>>
Starts listening to this task's progress and emits its values via a Flow.
-
When the returned flow starts being collected, it attaches the following listeners:
OnProgressListener,OnPausedListener,OnCompleteListener. -
When the flow completes the listeners will be removed.
Deprecation Notice: The Kotlin extensions (KTX) APIs have been added to their respective main modules, and the Kotlin extension (KTX) APIs in com.google.firebase.firebase-storage-ktx are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the FAQ about this initiative.