firebase

Namespace that encompasses all Firebase APIs.

Summary

Enumerations
FutureStatus{
  kFutureStatusComplete,
  kFutureStatusPending,
  kFutureStatusInvalid
} 		enum
Asynchronous call status.
InitResult{
  kInitResultSuccess = 0,
  kInitResultFailedMissingDependency
} 		enum
Reports whether a Firebase module initialized successfully.
LogLevel{
  kLogLevelVerbose = 0,
  kLogLevelDebug,
  kLogLevelInfo,
  kLogLevelWarning,
  kLogLevelError,
  kLogLevelAssert
} 		enum
Levels used when logging messages.

Typedefs
FutureHandleId typedef
uintptr_t
Handle that the API uses to identify an asynchronous call.

Functions
GetLogLevel()
Gets the logging verbosity.
SetLogLevel(LogLevel level)
void
Sets the logging verbosity.
operator!=(const Timestamp & lhs, const Timestamp & rhs)
bool
Checks lhs and rhs for inequality.
operator<(const Timestamp & lhs, const Timestamp & rhs)
bool
Checks whether lhs and rhs are in ascending order.
operator<=(const Timestamp & lhs, const Timestamp & rhs)
bool
Checks whether lhs and rhs are in non-descending order.
operator==(const Timestamp & lhs, const Timestamp & rhs)
bool
Checks lhs and rhs for equality.
operator>(const Timestamp & lhs, const Timestamp & rhs)
bool
Checks whether lhs and rhs are in descending order.
operator>=(const Timestamp & lhs, const Timestamp & rhs)
bool
Checks whether lhs and rhs are in non-ascending order.

Classes
firebase::App

Firebase application object.

firebase::AppOptions

Options that control the creation of a Firebase App.

firebase::Future

Type-specific version of FutureBase.

firebase::FutureBase

Type-independent return type of asynchronous calls.

firebase::FutureHandle

Class that provides more context to FutureHandleId, which allows the underlying API to track handles, perform reference counting, etc.

firebase::ModuleInitializer

Utility class to help with initializing Firebase modules.

firebase::Timestamp

A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time.

firebase::Variant

Variant data type used by Firebase libraries.

Namespaces
firebase::analytics

Firebase Analytics API.

firebase::app_check
firebase::auth

Firebase Authentication API.

firebase::database

Namespace for the Firebase Realtime Database C++ SDK.

firebase::dynamic_links

Firebase Dynamic Links API.

firebase::firestore

Cloud Firestore API.

firebase::functions

Namespace for the Firebase C++ SDK for Cloud Functions.

firebase::gma

API for Google Mobile Ads with Firebase.

firebase::installations
firebase::messaging

Firebase Cloud Messaging API.

firebase::remote_config

Firebase Remote Config API.

firebase::storage

Namespace for the Firebase C++ SDK for Cloud Storage.

firebase::ump

API for User Messaging Platform.

Enumerations

FutureStatus

 FutureStatus

Asynchronous call status.

Properties
kFutureStatusComplete

Results are ready.

kFutureStatusInvalid

No result is pending.

FutureBase::Release() or move operator was called.

kFutureStatusPending

Result is still being processed.

InitResult

 InitResult

Reports whether a Firebase module initialized successfully.

Properties
kInitResultFailedMissingDependency

The given library failed to initialize due to a missing dependency.

On Android, this typically means that Google Play services is not available and the library requires it. Use google_play_services::CheckAvailability() and google_play_services::MakeAvailable() to resolve this issue.

Also, on Android, this value can be returned if the Java dependencies of a Firebase component are not included in the application, causing initialization to fail. This means that the application's build environment is not configured correctly. To resolve the problem, see the SDK setup documentation for the set of Java dependencies (AARs) required for the component that failed to initialize.

kInitResultSuccess

The given library was successfully initialized.

LogLevel

 LogLevel

Levels used when logging messages.

Properties
kLogLevelAssert

Assert Log Level.

kLogLevelDebug

Debug Log Level.

kLogLevelError

Error Log Level.

kLogLevelInfo

Info Log Level.

kLogLevelVerbose

Verbose Log Level.

kLogLevelWarning

Warning Log Level.

Typedefs

FutureHandleId

uintptr_t FutureHandleId

Handle that the API uses to identify an asynchronous call.

The exact interpretation of the handle is up to the API.

Functions

GetLogLevel

LogLevel GetLogLevel()

Gets the logging verbosity.

Details
Returns
Get the currently configured logging verbosity.

SetLogLevel

void SetLogLevel(
  LogLevel level
)

Sets the logging verbosity.

All log messages at or above the specific log level.

Details
Parameters
level
Log level to display, by default this is set to kLogLevelInfo.

operator!=

bool operator!=(
  const Timestamp & lhs,
  const Timestamp & rhs
)

Checks lhs and rhs for inequality.

operator<

bool operator<(
  const Timestamp & lhs,
  const Timestamp & rhs
)

Checks whether lhs and rhs are in ascending order.

operator<=

bool operator<=(
  const Timestamp & lhs,
  const Timestamp & rhs
)

Checks whether lhs and rhs are in non-descending order.

operator==

bool operator==(
  const Timestamp & lhs,
  const Timestamp & rhs
)

Checks lhs and rhs for equality.

operator>

bool operator>(
  const Timestamp & lhs,
  const Timestamp & rhs
)

Checks whether lhs and rhs are in descending order.

operator>=

bool operator>=(
  const Timestamp & lhs,
  const Timestamp & rhs
)

Checks whether lhs and rhs are in non-ascending order.