firebase-storage/com.google.firebase.storage/StorageReference

StorageReference

actual class StorageReference : Comparable<StorageReference> (source)

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.

actual class StorageReference : Comparable<StorageReference> (source)
expect class StorageReference : Comparable<StorageReference> (source)

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.

actual class StorageReference : Comparable<StorageReference> (source)
actual class StorageReference : Comparable<StorageReference> (source)

Properties

Link copied to clipboard
Link copied to clipboard
actual val StorageReference.activeDownloadTasks: List<FileDownloadTask>

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

actual val StorageReference.activeDownloadTasks: List<FileDownloadTask>

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

expect val StorageReference.activeDownloadTasks: List<FileDownloadTask>

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

actual val StorageReference.activeDownloadTasks: List<FileDownloadTask>

Always empty: the JS SDK has no file downloads.

actual val StorageReference.activeDownloadTasks: List<FileDownloadTask>

Always empty: the JS SDK has no file downloads.

Link copied to clipboard
actual val activeUploadTasks: List<UploadTask>

The uploads to this reference that have not completed.

actual val activeUploadTasks: List<UploadTask>

The uploads to this reference that have not completed.

expect val activeUploadTasks: List<UploadTask>

The uploads to this reference that have not completed.

actual val activeUploadTasks: List<UploadTask>

The uploads to this reference that have not completed.

actual val activeUploadTasks: List<UploadTask>

The uploads to this reference that have not completed.

Link copied to clipboard
actual val bucket: String

The bucket.

actual val bucket: String

The bucket.

expect val bucket: String

The bucket.

actual val bucket: String

The bucket.

actual val bucket: String

The bucket.

Link copied to clipboard
val ios: FIRStorageReference

The underlying Firebase iOS SDK object.

Link copied to clipboard
val js: StorageReference

The underlying Firebase JS SDK object.

val js: StorageReference

The underlying Firebase JS SDK object.

Link copied to clipboard
actual val name: String

The last path segment.

actual val name: String

The last path segment.

expect val name: String

The last path segment.

actual val name: String

The last path segment.

actual val name: String

The last path segment.

Link copied to clipboard
actual val parent: StorageReference?

The parent folder, or null at the root.

actual val parent: StorageReference?

The parent folder, or null at the root.

expect val parent: StorageReference?

The parent folder, or null at the root.

actual val parent: StorageReference?

The parent folder, or null at the root.

actual val parent: StorageReference?

The parent folder, or null at the root.

Link copied to clipboard
actual val path: String

The full path inside the bucket.

actual val path: String

With a leading slash, as the Android SDK's getPath().

expect val path: String

The full path inside the bucket.

actual val path: String

With a leading slash, as the Android SDK's getPath().

actual val path: String

With a leading slash, as the Android SDK's getPath().

Link copied to clipboard
actual val root: StorageReference

The root of the bucket.

actual val root: StorageReference

The root of the bucket.

expect val root: StorageReference

The root of the bucket.

actual val root: StorageReference

The root of the bucket.

actual val root: StorageReference

The root of the bucket.

Link copied to clipboard
actual val storage: FirebaseStorage

The FirebaseStorage this reference belongs to.

actual val storage: FirebaseStorage

The FirebaseStorage this reference belongs to.

expect val storage: FirebaseStorage

The FirebaseStorage this reference belongs to.

actual val storage: FirebaseStorage

The FirebaseStorage this reference belongs to.

actual val storage: FirebaseStorage

The FirebaseStorage this reference belongs to.

Functions

Link copied to clipboard
actual fun child(pathString: String): StorageReference

A reference to pathString under this reference.

actual fun child(pathString: String): StorageReference

A reference to pathString under this reference.

expect fun child(pathString: String): StorageReference

A reference to pathString under this reference.

actual fun child(pathString: String): StorageReference

A reference to pathString under this reference.

actual fun child(pathString: String): StorageReference

A reference to pathString under this reference.

Link copied to clipboard
actual open operator override fun compareTo(other: StorageReference): Int
actual open operator override fun compareTo(other: StorageReference): Int
expect open operator override fun compareTo(other: StorageReference): Int
actual open operator override fun compareTo(other: StorageReference): Int
actual open operator override fun compareTo(other: StorageReference): Int
Link copied to clipboard
actual fun delete(): Task<Nothing?>

Deletes the object.

actual fun delete(): Task<Nothing?>

Deletes the object.

expect fun delete(): Task<Nothing?>

Deletes the object.

actual fun delete(): Task<Nothing?>

Deletes the object.

actual fun delete(): Task<Nothing?>

Deletes the object.

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
open operator override fun equals(other: Any?): Boolean
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
actual fun getBytes(maxDownloadSizeBytes: Long): Task<ByteArray>

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

actual fun getBytes(maxDownloadSizeBytes: Long): Task<ByteArray>

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

expect fun getBytes(maxDownloadSizeBytes: Long): Task<ByteArray>

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

actual fun getBytes(maxDownloadSizeBytes: Long): Task<ByteArray>

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

actual fun getBytes(maxDownloadSizeBytes: Long): Task<ByteArray>

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

Link copied to clipboard
actual fun getDownloadUrl(): Task<Any>

The public download URL of the object. The Android SDK's task carries an android.net.Uri; here the result is typed as Any so that common code can call toString() on it (the Uri on Android, the URL string elsewhere).

actual fun getDownloadUrl(): Task<Any>

The public download URL of the object. The Android SDK's task carries an android.net.Uri; here the result is typed as Any so that common code can call toString() on it (the Uri on Android, the URL string elsewhere).

expect fun getDownloadUrl(): Task<Any>

The public download URL of the object. The Android SDK's task carries an android.net.Uri; here the result is typed as Any so that common code can call toString() on it (the Uri on Android, the URL string elsewhere).

actual fun getDownloadUrl(): Task<Any>

The public download URL of the object. The Android SDK's task carries an android.net.Uri; here the result is typed as Any so that common code can call toString() on it (the Uri on Android, the URL string elsewhere).

actual fun getDownloadUrl(): Task<Any>

The public download URL of the object. The Android SDK's task carries an android.net.Uri; here the result is typed as Any so that common code can call toString() on it (the Uri on Android, the URL string elsewhere).

Link copied to clipboard
fun getFile(destinationUri: Uri): FileDownloadTask
fun getFile(destinationFile: File): FileDownloadTask
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
actual fun getMetadata(): Task<StorageMetadata>

The object's metadata.

actual fun getMetadata(): Task<StorageMetadata>

The object's metadata.

expect fun getMetadata(): Task<StorageMetadata>

The object's metadata.

actual fun getMetadata(): Task<StorageMetadata>

The object's metadata.

actual fun getMetadata(): Task<StorageMetadata>

The object's metadata.

Link copied to clipboard
open override fun hashCode(): Int
open override fun hashCode(): Int
open override fun hashCode(): Int
Link copied to clipboard
actual fun list(maxResults: Int): Task<ListResult>

Lists up to maxResults items and prefixes under this reference.

actual fun list(maxResults: Int, pageToken: String): Task<ListResult>

Lists the next page of up to maxResults items and prefixes, continuing from pageToken.

actual fun list(maxResults: Int): Task<ListResult>

Lists up to maxResults items and prefixes under this reference.

actual fun list(maxResults: Int, pageToken: String): Task<ListResult>

Lists the next page of up to maxResults items and prefixes, continuing from pageToken.

expect fun list(maxResults: Int): Task<ListResult>

Lists up to maxResults items and prefixes under this reference.

expect fun list(maxResults: Int, pageToken: String): Task<ListResult>

Lists the next page of up to maxResults items and prefixes, continuing from pageToken.

actual fun list(maxResults: Int): Task<ListResult>

Lists up to maxResults items and prefixes under this reference.

actual fun list(maxResults: Int, pageToken: String): Task<ListResult>

Lists the next page of up to maxResults items and prefixes, continuing from pageToken.

actual fun list(maxResults: Int): Task<ListResult>

Lists up to maxResults items and prefixes under this reference.

actual fun list(maxResults: Int, pageToken: String): Task<ListResult>

Lists the next page of up to maxResults items and prefixes, continuing from pageToken.

Link copied to clipboard
actual fun listAll(): Task<ListResult>

Lists every item and prefix under this reference.

actual fun listAll(): Task<ListResult>

Lists every item and prefix under this reference.

expect fun listAll(): Task<ListResult>

Lists every item and prefix under this reference.

actual fun listAll(): Task<ListResult>

Lists every item and prefix under this reference.

actual fun listAll(): Task<ListResult>

Lists every item and prefix under this reference.

Link copied to clipboard
actual fun putBytes(bytes: ByteArray): UploadTask

Uploads bytes to this reference.

actual fun putBytes(bytes: ByteArray, metadata: StorageMetadata): UploadTask

Uploads bytes to this reference with metadata.

actual fun putBytes(bytes: ByteArray): UploadTask

Uploads bytes to this reference.

actual fun putBytes(bytes: ByteArray, metadata: StorageMetadata): UploadTask

Uploads bytes to this reference with metadata.

expect fun putBytes(bytes: ByteArray): UploadTask

Uploads bytes to this reference.

expect fun putBytes(bytes: ByteArray, metadata: StorageMetadata): UploadTask

Uploads bytes to this reference with metadata.

actual fun putBytes(bytes: ByteArray): UploadTask

Uploads bytes to this reference.

actual fun putBytes(bytes: ByteArray, metadata: StorageMetadata): UploadTask

Uploads bytes to this reference with metadata.

actual fun putBytes(bytes: ByteArray): UploadTask

Uploads bytes to this reference.

actual fun putBytes(bytes: ByteArray, metadata: StorageMetadata): UploadTask

Uploads bytes to this reference with metadata.

Link copied to clipboard
fun putFile(uri: Uri): UploadTask

The SDK's file members; the shipped extensions of common code bind to these.

fun putFile(uri: Uri, metadata: StorageMetadata): UploadTask
Link copied to clipboard
actual fun StorageReference.putFile(file: Any): UploadTask

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.

actual fun StorageReference.putFile(file: Any): UploadTask

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.

expect fun StorageReference.putFile(file: Any): UploadTask

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.

actual fun StorageReference.putFile(file: Any): UploadTask

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.

actual fun StorageReference.putFile(file: Any): UploadTask

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
open override fun toString(): String
open override fun toString(): String
open override fun toString(): String
Link copied to clipboard
actual fun updateMetadata(metadata: StorageMetadata): Task<StorageMetadata>

Updates the object's mutable metadata (the settable fields of metadata).

actual fun updateMetadata(metadata: StorageMetadata): Task<StorageMetadata>

Updates the object's mutable metadata (the settable fields of metadata).

expect fun updateMetadata(metadata: StorageMetadata): Task<StorageMetadata>

Updates the object's mutable metadata (the settable fields of metadata).

actual fun updateMetadata(metadata: StorageMetadata): Task<StorageMetadata>

Updates the object's mutable metadata (the settable fields of metadata).

actual fun updateMetadata(metadata: StorageMetadata): Task<StorageMetadata>

Updates the object's mutable metadata (the settable fields of metadata).

Generated by Dokka
firebase-multiplatform, Apache License 2.0. Based on GitLive's firebase-kotlin-sdk.