firebase::storage

Namespace for the Firebase C++ SDK for CloudStorage.

Summary

Enumerations

Error{
  kErrorNone = 0,
  kErrorUnknown,
  kErrorObjectNotFound,
  kErrorBucketNotFound,
  kErrorProjectNotFound,
  kErrorQuotaExceeded,
  kErrorUnauthenticated,
  kErrorUnauthorized,
  kErrorRetryLimitExceeded,
  kErrorNonMatchingChecksum,
  kErrorDownloadSizeExceeded,
  kErrorCancelled
}
enum
Error code returned by CloudStorage C++ functions.

Functions

GetErrorMessage(Error error)
const char *
Get the human-readable error message corresponding to an error code.

Classes

firebase::storage::Controller

Controls an ongoing operation, allowing the caller to Pause, Resume or Cancel an ongoing download or upload.

firebase::storage::Listener

Base class used to receive pause and progress events on a running read or write operation.

firebase::storage::Metadata

Metadata stores default attributes such as size and content type.

firebase::storage::Storage

Entry point for the Firebase C++ SDK for CloudStorage.

firebase::storage::StorageReference

Represents a reference to a CloudStorage object.

Enumerations

Error

Error

Error code returned by CloudStorage C++ functions.

Properties
kErrorBucketNotFound

No bucket is configured for CloudStorage.

kErrorCancelled

User cancelled the operation.

kErrorDownloadSizeExceeded

Size of the downloaded file exceeds the amount of memory allocated for the download.

kErrorNonMatchingChecksum

File on the client does not match the checksum of the file received by the server.

kErrorNone

The operation was a success, no error occurred.

kErrorObjectNotFound

No object exists at the desired reference.

kErrorProjectNotFound

No project is configured for CloudStorage.

kErrorQuotaExceeded

Quota on your CloudStorage bucket has been exceeded.

kErrorRetryLimitExceeded

The maximum time limit on an operation (upload, download, delete, etc.) has been exceeded.

kErrorUnauthenticated

User is unauthenticated.

kErrorUnauthorized

User is not authorized to perform the desired action.

kErrorUnknown

An unknown error occurred.

Functions

GetErrorMessage

constchar*GetErrorMessage(Errorerror)

Get the human-readable error message corresponding to an error code.

Details
Parameters
error
Error code to get the error message for.
Returns
Statically-allocated string describing the error.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2021-06-30 UTC.