StorageKt
public final class StorageKt
Summary
Public fields |
|
|---|---|
final @NonNull FirebaseStorage |
Accessing this object for Kotlin apps has changed; see the migration guide. |
final @NonNull Flow<@NonNull TaskState<@NonNull T>> |
This field is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration. |
Public methods |
|
|---|---|
static final long |
StorageKt.This method is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration. |
static final @NonNull List<@NonNull StorageReference> |
StorageKt.This method is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration. |
static final long |
This method is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration. |
static final long |
StorageKt.This method is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration. |
static final long |
StorageKt.This method is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration. |
static final @NonNull List<@NonNull StorageReference> |
StorageKt.This method is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration. |
static final long |
This method is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration. |
static final long |
StorageKt.This method is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration. |
static final String |
StorageKt.This method is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration. |
static final @NonNull InputStream |
This method is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration. |
static final StorageMetadata |
StorageKt.This method is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration. |
static final Uri |
StorageKt.This method is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration. |
static final @NonNull FirebaseStorage |
Accessing this object for Kotlin apps has changed; see the migration guide. |
static final @NonNull FirebaseStorage |
Accessing this object for Kotlin apps has changed; see the migration guide. |
static final @NonNull FirebaseStorage |
Accessing this object for Kotlin apps has changed; see the migration guide. |
static final @NonNull StorageMetadata |
This method is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration. |
Public fields
storage
public final @NonNull FirebaseStorage storage
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
public final @NonNull Flow<@NonNull TaskState<@NonNull T>> taskState
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.
Public methods
StorageKt.component1
public static final long StorageKt.component1(@NonNull FileDownloadTask.TaskSnapshot receiver)
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 |
StorageKt.component1
public static final @NonNull List<@NonNull StorageReference> StorageKt.component1(@NonNull ListResult receiver)
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 | |
|---|---|
@NonNull List<@NonNull StorageReference> |
the items of the |
StorageKt.component1
public static final long StorageKt.component1(@NonNull StreamDownloadTask.TaskSnapshot receiver)
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 |
StorageKt.component1
public static final long StorageKt.component1(@NonNull UploadTask.TaskSnapshot receiver)
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 |
StorageKt.component2
public static final long StorageKt.component2(@NonNull FileDownloadTask.TaskSnapshot receiver)
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 |
StorageKt.component2
public static final @NonNull List<@NonNull StorageReference> StorageKt.component2(@NonNull ListResult receiver)
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 | |
|---|---|
@NonNull List<@NonNull StorageReference> |
the prefixes of the |
StorageKt.component2
public static final long StorageKt.component2(@NonNull StreamDownloadTask.TaskSnapshot receiver)
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 |
StorageKt.component2
public static final long StorageKt.component2(@NonNull UploadTask.TaskSnapshot receiver)
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 |
StorageKt.component3
public static final String StorageKt.component3(@NonNull ListResult receiver)
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 |
StorageKt.component3
public static final @NonNull InputStream StorageKt.component3(@NonNull StreamDownloadTask.TaskSnapshot receiver)
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 | |
|---|---|
@NonNull InputStream |
the stream of the |
StorageKt.component3
public static final StorageMetadata StorageKt.component3(@NonNull UploadTask.TaskSnapshot receiver)
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 |
StorageKt.component4
public static final Uri StorageKt.component4(@NonNull UploadTask.TaskSnapshot receiver)
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 |
StorageKt.storage
public static final @NonNull FirebaseStorage StorageKt.storage(@NonNull Firebase receiver, @NonNull FirebaseApp app)
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.
StorageKt.storage
public static final @NonNull FirebaseStorage StorageKt.storage(@NonNull Firebase receiver, @NonNull String url)
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.
StorageKt.storage
public static final @NonNull FirebaseStorage StorageKt.storage(
@NonNull Firebase receiver,
@NonNull FirebaseApp app,
@NonNull String url
)
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.
storageMetadata
public static final @NonNull StorageMetadatastorageMetadata(
@ExtensionFunctionType @NonNull Function1<@NonNull StorageMetadata.Builder, Unit> init
)
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.