firebase-storage/io.github.corneloaie.firebase.storage/StorageReference

StorageReference

class StorageReference(source)

A reference to an object or folder in Cloud Storage.

Properties

android

val StorageReference.android: StorageReference

The underlying Firebase Android SDK object.

bucket

val bucket: String

compat

val compat: StorageReference

The Android-SDK-shaped com.google.firebase.storage.StorageReference this wraps.

ios

val StorageReference.ios: FIRStorageReference

The underlying Firebase iOS SDK object.

val StorageReference.js: StorageReference

The underlying Firebase JS SDK object.

val StorageReference.js: StorageReference

The underlying Firebase JS SDK object.

name

val name: String

parent

val parent: StorageReference?

path

val path: String

root

val root: StorageReference

storage

val storage: FirebaseStorage

Functions

child

fun child(path: String): StorageReference

delete

suspend fun delete()

Deletes the object.

equals

open operator override fun equals(other: Any?): Boolean

getData

suspend fun getData(maxDownloadSizeBytes: Long): Data

Downloads the object into memory, failing if it is larger than maxDownloadSizeBytes.

getDownloadUrl

suspend fun getDownloadUrl(): String

The public download URL of the object.

getMetadata

suspend fun getMetadata(): FirebaseStorageMetadata?

The object's metadata.

hashCode

open override fun hashCode(): Int

list

suspend fun list(maxResults: Int, pageToken: String? = null): ListResult

Lists up to maxResults items and prefixes, continuing from pageToken if given.

listAll

suspend fun listAll(): ListResult

Lists every item and prefix under this reference.

putData

suspend fun putData(data: Data, metadata: FirebaseStorageMetadata? = null)

Uploads data and suspends until the upload completes.

putDataResumable

fun putDataResumable(data: Data, metadata: FirebaseStorageMetadata? = null): ProgressFlow

Uploads data, reporting progress through the returned ProgressFlow, which can pause, resume and cancel it.

putFile

suspend fun putFile(file: File, metadata: FirebaseStorageMetadata? = null)

Uploads file and suspends until the upload completes.

putFileResumable

fun putFileResumable(file: File, metadata: FirebaseStorageMetadata? = null): ProgressFlow

Uploads file, reporting progress through the returned ProgressFlow, which can pause, resume and cancel it.

toString

open override fun toString(): String

updateMetadata

suspend fun updateMetadata(metadata: FirebaseStorageMetadata): FirebaseStorageMetadata?

Updates the object's settable metadata.