java.lang.Object | |
↳ | com.google.firebase.storage.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. (see Google Cloud Storage)
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns a new instance of
StorageReference pointing to a child location of the current
reference. | |||||||||||
Deletes the object at this
StorageReference . | |||||||||||
Return the Google Cloud Storage bucket that holds this object.
| |||||||||||
Asynchronously downloads the object from this
StorageReference
A byte array will be allocated large enough to hold the entire file in memory. | |||||||||||
Asynchronously retrieves a long lived download URL with a revokable token.
| |||||||||||
Asynchronously downloads the object at this
StorageReference to a specified system
filepath. | |||||||||||
Asynchronously downloads the object at this
StorageReference to a specified system
filepath. | |||||||||||
Retrieves metadata associated with an object at this
StorageReference . | |||||||||||
Returns the short name of this object.
| |||||||||||
Returns a new instance of
StorageReference pointing to the parent location or null
if this instance references the root location. | |||||||||||
Returns the full path to this object, not including the Google Cloud Storage bucket.
| |||||||||||
Returns a new instance of
StorageReference pointing to the root location. | |||||||||||
Returns the
FirebaseStorage service which created this reference. | |||||||||||
Asynchronously downloads the object at this
StorageReference via a InputStream . | |||||||||||
Asynchronously downloads the object at this
StorageReference via a InputStream . | |||||||||||
Asynchronously uploads byte data to this
StorageReference . | |||||||||||
Asynchronously uploads byte data to this
StorageReference . | |||||||||||
Asynchronously uploads from a content URI to this
StorageReference . | |||||||||||
Asynchronously uploads from a content URI to this
StorageReference . | |||||||||||
Asynchronously uploads from a content URI to this
StorageReference . | |||||||||||
Asynchronously uploads a stream of data to this
StorageReference . | |||||||||||
Asynchronously uploads a stream of data to this
StorageReference . | |||||||||||
Updates the metadata associated with this
StorageReference . |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
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:
child = /foo/bar path = foo/bar
child = foo/bar/ path = foo/bar
child = foo///bar path = foo/bar
Parameters | |
---|---|
pathString |
String :
The relative path from this reference. |
Returns | |
---|---|
StorageReference |
the child StorageReference .
|
Deletes the object at this StorageReference
.
Returns | |
---|---|
Task<Void> |
a Task that indicates whether the operation succeeded or failed.
|
Parameters | |
---|---|
other |
Object
|
Returns | |
---|---|
boolean |
Returns | |
---|---|
List<FileDownloadTask> |
the set of active download tasks currently in progress or recently completed. |
Returns | |
---|---|
List<UploadTask> |
the set of active upload tasks currently in progress or recently completed. |
Return the Google Cloud Storage bucket that holds this object.
Returns | |
---|---|
String |
the bucket. |
Asynchronously downloads the object from this StorageReference
A byte array will be allocated large enough to hold the entire file in memory.
Therefore, using this method will impact memory usage of your process. If you are
downloading many large files,
getStream(StreamDownloadTask.StreamProcessor)
may be a better option.
Parameters | |
---|---|
maxDownloadSizeBytes |
long :
The maximum allowed size in bytes that will be allocated.
Set this parameter to prevent out of memory conditions from
occurring. If the download exceeds this limit, the task will
fail and an IndexOutOfBoundsException will be returned. |
Returns | |
---|---|
Task<byte[]> |
The bytes downloaded. |
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.
Returns | |
---|---|
Task<Uri> |
The Uri representing the download URL. You can feed this URL into a
URL and download the object via openStream() .
|
Asynchronously downloads the object at this StorageReference
to a specified system
filepath.
Parameters | |
---|---|
destinationFile |
File :
A File representing the path the object should be
downloaded to. |
Returns | |
---|---|
FileDownloadTask |
A FileDownloadTask that can be used to monitor or manage the download.
|
Asynchronously downloads the object at this StorageReference
to a specified system
filepath.
Parameters | |
---|---|
destinationUri |
Uri :
A file system URI representing the path the object should be
downloaded to. |
Returns | |
---|---|
FileDownloadTask |
A FileDownloadTask that can be used to monitor or manage the download.
|
Retrieves metadata associated with an object at this StorageReference
.
Returns | |
---|---|
Task<StorageMetadata> |
the metadata. |
Returns the short name of this object.
Returns | |
---|---|
String |
the name. |
Returns a new instance of StorageReference
pointing to the parent location or null
if this instance references the root location.
For example:
path = foo/bar/baz parent = foo/bar
path = foo parent = (root)
path = (root) parent = (null)
Returns | |
---|---|
StorageReference |
the parent StorageReference .
|
Returns the full path to this object, not including the Google Cloud Storage bucket.
Returns | |
---|---|
String |
the path. |
Returns a new instance of StorageReference
pointing to the root location.
Returns | |
---|---|
StorageReference |
the root StorageReference .
|
Returns the FirebaseStorage
service which created this reference.
Returns | |
---|---|
FirebaseStorage |
The FirebaseStorage service.
|
Asynchronously downloads the object at this StorageReference
via a InputStream
.
Parameters | |
---|---|
processor |
StreamDownloadTask.StreamProcessor :
A StreamDownloadTask.StreamProcessor that is responsible for
reading data from the InputStream .
The StreamDownloadTask.StreamProcessor is called on a background
thread and checked exceptions thrown from this object will be returned as
a failure to the OnFailureListener registered on the
StreamDownloadTask . |
Returns | |
---|---|
StreamDownloadTask |
A FileDownloadTask that can be used to monitor or manage the download.
|
Asynchronously downloads the object at this StorageReference
via a InputStream
.
The InputStream should be read on an OnSuccessListener
registered to run on a
background thread via
addOnSuccessListener(Executor, OnSuccessListener)
Returns | |
---|---|
StreamDownloadTask |
A FileDownloadTask that can be used to monitor or manage the download.
|
Returns | |
---|---|
int |
Asynchronously uploads byte data to this StorageReference
.
This is not recommended for large files. Instead upload a file via
putFile(Uri)
or a Stream via putStream(InputStream)
.
Parameters | |
---|---|
bytes |
byte :
The byte[] to upload. |
metadata |
StorageMetadata :
StorageMetadata containing additional information (MIME type, etc.)
about the object being uploaded. |
Returns | |
---|---|
UploadTask |
An instance of UploadTask which can be used to monitor and manage the upload.
|
Asynchronously uploads byte data to this StorageReference
.
This is not recommended for large files. Instead upload a file via
putFile(Uri)
or an InputStream
via putStream(InputStream)
.
Parameters | |
---|---|
bytes |
byte :
The byte array to upload. |
Returns | |
---|---|
UploadTask |
An instance of UploadTask which can be used to monitor and manage the upload.
|
Asynchronously uploads from a content URI to this StorageReference
.
Parameters | |
---|---|
uri |
Uri :
The source of the upload. This can be a file:// scheme or any
content URI. A content resolver will be used to load the data. |
metadata |
StorageMetadata :
StorageMetadata containing additional information (MIME
type, etc.) about the object being uploaded. |
existingUploadUri |
Uri :
If set, an attempt is made to resume an existing upload
session as defined by
getUploadSessionUri() . |
Returns | |
---|---|
UploadTask |
An instance of UploadTask which can be used to monitor or manage the upload.
|
Asynchronously uploads from a content URI to this StorageReference
.
Parameters | |
---|---|
uri |
Uri :
The source of the upload. This can be a file:// scheme or any
content URI. A content resolver will be used to load the data. |
metadata |
StorageMetadata :
StorageMetadata containing additional information (MIME
type, etc.) about the object being uploaded. |
Returns | |
---|---|
UploadTask |
An instance of UploadTask which can be used to monitor or manage the upload.
|
Asynchronously uploads from a content URI to this StorageReference
.
Parameters | |
---|---|
uri |
Uri :
The source of the upload. This can be a file:// scheme or any
content URI. A content resolver will be used to load the data. |
Returns | |
---|---|
UploadTask |
An instance of UploadTask which can be used to monitor or manage the upload.
|
Asynchronously uploads a stream of data to this StorageReference
.
The stream will remain open at the end of the upload.
Parameters | |
---|---|
stream |
InputStream :
The InputStream to upload. |
metadata |
StorageMetadata :
StorageMetadata containing additional information (MIME type, etc.)
about the object being uploaded. |
Returns | |
---|---|
UploadTask |
An instance of UploadTask which can be used to monitor and manage the upload.
|
Asynchronously uploads a stream of data to this StorageReference
.
The stream will remain open at the end of the upload.
Parameters | |
---|---|
stream |
InputStream :
The InputStream to upload. |
Returns | |
---|---|
UploadTask |
An instance of UploadTask which can be used to monitor and manage the upload.
|
Returns | |
---|---|
String |
This object in URI form, which can then be shared and passed into
getReferenceFromUrl(String) .
|
Updates the metadata associated with this StorageReference
.
Parameters | |
---|---|
metadata |
StorageMetadata :
A StorageMetadata object with the metadata to update. |
Returns | |
---|---|
Task<StorageMetadata> |
a Task that will return the final StorageMetadata once the operation
is complete.
|