firebase::storage::StorageReference

#include <storage_reference.h>

Represents a reference to a Cloud Storage object.

Summary

Developers can upload and download objects, get/set object metadata, and delete an object at a specified path.

Constructors and Destructors

StorageReference()
Default constructor.
StorageReference(const StorageReference & reference)
Copy constructor.
StorageReference(StorageReference && other)
Move constructor.
~StorageReference()

Public functions

Child(const char *path) const
Gets a reference to a location relative to this one.
Child(const std::string & path) const
Gets a reference to a location relative to this one.
Delete()
Future< void >
Deletes the object at the current path.
DeleteLastResult()
Future< void >
Returns the result of the most recent call to RemoveValue();.
GetBytes(void *buffer, size_t buffer_size, Listener *listener, Controller *controller_out)
Future< size_t >
Asynchronously downloads the object from this StorageReference.
GetBytesLastResult()
Future< size_t >
Returns the result of the most recent call to GetBytes();.
GetDownloadUrl()
Future< std::string >
Asynchronously retrieves a long lived download URL with a revokable token.
GetDownloadUrlLastResult()
Future< std::string >
Returns the result of the most recent call to GetDownloadUrl();.
GetFile(const char *path, Listener *listener, Controller *controller_out)
Future< size_t >
Asynchronously downloads the object from this StorageReference.
GetFileLastResult()
Future< size_t >
Returns the result of the most recent call to GetFile();.
GetMetadata()
Retrieves metadata associated with an object at this StorageReference.
GetMetadataLastResult()
Returns the result of the most recent call to GetMetadata();.
GetParent()
Returns a new instance of StorageReference pointing to the parent location or null if this instance references the root location.
PutBytes(const void *buffer, size_t buffer_size, Listener *listener, Controller *controller_out)
Asynchronously uploads data to the currently specified StorageReference, without additional metadata.
PutBytes(const void *buffer, size_t buffer_size, const Metadata & metadata, Listener *listener, Controller *controller_out)
Asynchronously uploads data to the currently specified StorageReference, without additional metadata.
PutBytesLastResult()
Returns the result of the most recent call to PutBytes();.
PutFile(const char *path, Listener *listener, Controller *controller_out)
Asynchronously uploads data to the currently specified StorageReference, without additional metadata.
PutFile(const char *path, const Metadata & metadata, Listener *listener, Controller *controller_out)
Asynchronously uploads data to the currently specified StorageReference, without additional metadata.
PutFileLastResult()
Returns the result of the most recent call to PutFile();.
UpdateMetadata(const Metadata & metadata)
Updates the metadata associated with this StorageReference.
UpdateMetadataLastResult()
Returns the result of the most recent call to UpdateMetadata();.
bucket()
std::string
Return the Google Cloud Storage bucket that holds this object.
full_path()
std::string
Return the full path of the storage reference, not including the Google Cloud Storage bucket.
is_valid() const
bool
Returns true if this StorageReference is valid, false if it is not valid.
name()
std::string
Returns the short name of this object.
operator=(const StorageReference & reference)
Copy assignment operator.
operator=(StorageReference && other)
Move assignment operator.
storage()
Gets the firebase::storage::Storage instance to which we refer.

Public functions

Child

StorageReference Child(
  const char *path
) const 

Gets a reference to a location relative to this one.

Details
Parameters
path
Path relative to this reference's location. The pointer only needs to be valid during this call.
Returns
Child relative to this location.

Child

StorageReference Child(
  const std::string & path
) const 

Gets a reference to a location relative to this one.

Details
Parameters
path
Path relative to this reference's location.
Returns
Child relative to this location.

Delete

Future< void > Delete()

Deletes the object at the current path.

Details
Returns
A Future result, which will complete when the operation either succeeds or fails. When the Future is completed, if its Error is kErrorNone, the operation succeeded.

DeleteLastResult

Future< void > DeleteLastResult()

Returns the result of the most recent call to RemoveValue();.

Details
Returns
The result of the most recent call to RemoveValue();