firebase-storage/dev.gitlive.firebase.storage/StorageReference

StorageReference

Represents a reference to a Google Cloud Storage object. Developers can upload and download objects, get/set object metadata, and delete an object at a specified path.

actual class StorageReference(source)

Constructors

StorageReference

constructor(android: StorageReference)

constructor(ios: FIRStorageReference)

constructor(js: StorageReference)

constructor()

Properties

android

val StorageReference.android: StorageReference

bucket

actual val bucket: String

expect val bucket: String

Return the Google Cloud Storage bucket that holds this object.

actual val bucket: String

ios

val StorageReference.ios: FIRStorageReference

val StorageReference.js: StorageReference

name

actual val name: String

expect val name: String

Returns the short name of this object.

actual val name: String

parent

actual val parent: StorageReference?

expect val parent: StorageReference?

Returns a new instance of StorageReference pointing to the parent location or null if this instance references the root location. For example:

actual val parent: StorageReference?

path

actual val path: String

expect val path: String

Returns the full path to this object, not including the Google Cloud Storage bucket.

actual val path: String

root

actual val root: StorageReference

expect val root: StorageReference

Returns a new instance of {@link StorageReference} pointing to the root location.

actual val root: StorageReference

storage

actual val storage: FirebaseStorage

expect val storage: FirebaseStorage

Returns the FirebaseStorage service which created this reference.

actual val storage: FirebaseStorage

Functions

child

actual fun child(path: String): StorageReference

expect fun child(path: String): StorageReference

Returns a new instance of StorageReference pointing to a child location of the current reference. All leading and trailing slashes will be removed, and consecutive slashes will be compressed to single slashes. For example:

actual fun child(path: String): StorageReference

delete

actual suspend fun delete()

expect suspend fun delete()

Deletes the object at this {@link StorageReference}.

actual suspend fun delete()

getDownloadUrl

actual suspend fun getDownloadUrl(): String

expect suspend fun getDownloadUrl(): String

Asynchronously retrieves a long lived download URL with a revokable token. This can be used to share the file with others, but can be revoked by a developer in the Firebase Console if desired.

actual suspend fun getDownloadUrl(): String