Firebase C++ API Reference

firebase

Classes

firebase::AppFirebase application object.
firebase::AppOptionsOptions that control the creation of a FirebaseApp.
firebase::FutureType-specific version ofFutureBase.
firebase::FutureBaseType-independent return type of asynchronous calls.
firebase::FutureHandleClass that provides more context to FutureHandleId, which allows the underlying API to track handles, perform reference counting, etc.
firebase::ModuleInitializerUtility class to help with initializing Firebase modules.
firebase::TimestampATimestamp 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::VariantVariant data type used by Firebase libraries.

firebase::analytics

Structs

firebase::analytics::ParameterEvent parameter.

firebase::app_check

Classes

firebase::app_check::AppAttestProviderFactoryImplementation of anAppCheckProviderFactory that builds AppAttestProviders.
firebase::app_check::AppCheckFirebaseApp Check object.
firebase::app_check::AppCheckListenerBase class used to receive messages whenAppCheck token changes.
firebase::app_check::AppCheckProviderInterface for a provider that generatesAppCheckTokens.
firebase::app_check::AppCheckProviderFactoryInterface for a factory that generatesAppCheckProviders.
firebase::app_check::DebugAppCheckProviderFactoryImplementation of anAppCheckProviderFactory that builds DebugAppCheckProviders.
firebase::app_check::DeviceCheckProviderFactoryImplementation of anAppCheckProviderFactory that builds DeviceCheckProviders.
firebase::app_check::PlayIntegrityProviderFactoryImplementation of anAppCheckProviderFactory that builds PlayIntegrityProviders.

Structs

firebase::app_check::AppCheckTokenStruct to hold tokens emitted by the FirebaseApp Check service which are minted upon a successful application verification.

firebase::auth

Classes

firebase::auth::AuthFirebase authentication object.
firebase::auth::Auth::FetchProvidersResultResults of calls FetchProvidersForEmail.
firebase::auth::AuthStateListenerListener called when there is a change in the authentication state.
firebase::auth::CredentialAuthentication credentials for an authentication provider.
firebase::auth::EmailAuthProviderUse email and password to authenticate.
firebase::auth::FacebookAuthProviderUse an access token provided by Facebook to authenticate.
firebase::auth::FederatedAuthProviderUsed to authenticate with FederatedAuth Providers.
firebase::auth::FederatedOAuthProviderAuthenticates with Federated OAuth Providers via thefirebase::auth::Auth andfirebase::auth::User classes.
firebase::auth::GameCenterAuthProviderGameCenter (Apple) auth provider.
firebase::auth::GitHubAuthProviderUse an access token provided by GitHub to authenticate.
firebase::auth::GoogleAuthProviderUse an ID token and access token provided by Google to authenticate.
firebase::auth::IdTokenListenerListener called when there is a change in the ID token.
firebase::auth::MicrosoftAuthProviderUse an access token provided by Microsoft to authenticate.
firebase::auth::OAuthProviderOAuth2.0+UserInfo auth provider (OIDC compliant and non-compliant).
firebase::auth::PhoneAuthCredentialWraps phone number and verification information for authentication purposes.
firebase::auth::PhoneAuthProviderUse phone number text messages to authenticate.
firebase::auth::PhoneAuthProvider::ForceResendingTokenToken to maintain current phone number verification session.
firebase::auth::PhoneAuthProvider::ListenerReceive callbacks fromVerifyPhoneNumber events.
firebase::auth::PlayGamesAuthProviderUse a server auth code provided by Google Play Games to authenticate.
firebase::auth::TwitterAuthProviderUse a token and secret provided by Twitter to authenticate.
firebase::auth::UserFirebase user account object.
firebase::auth::User::UserProfileParameters to theUpdateUserProfile() function.
firebase::auth::UserInfoInterfaceInterface implemented by each identity provider.
firebase::auth::YahooAuthProviderUse an access token provided by Yahoo to authenticate.

Structs

firebase::auth::AdditionalUserInfoAdditional user data returned from an identity provider.
firebase::auth::AuthResultThe result of operations that can affect authentication state.
firebase::auth::FederatedOAuthProviderDataContains information to identify an OAuth povider.
firebase::auth::FederatedProviderDataContains information required to authenticate with a third party provider.
firebase::auth::PhoneAuthOptionsOptions object for configuring phone validation flows inPhoneAuthProvider.
firebase::auth::UserMetadataMetadata corresponding to a Firebase user.

firebase::database

Classes

firebase::database::ChildListenerChild listener interface.
firebase::database::DatabaseEntry point for the Firebase RealtimeDatabase C++ SDK.
firebase::database::DatabaseReferenceDatabaseReference represents a particular location in yourDatabase and can be used for reading or writing data to thatDatabase location.
firebase::database::DataSnapshotADataSnapshot instance contains data from a FirebaseDatabase location.
firebase::database::DisconnectionHandlerAllows you to register server-side actions to occur when the client disconnects.
firebase::database::MutableDataInstances of this class encapsulate the data and priority at a location.
firebase::database::QueryTheQuery class is used for reading data.
firebase::database::ValueListenerValue listener interface.

firebase::firestore

Classes

firebase::firestore::AggregateQueryA query that calculates aggregations over an underlying query.
firebase::firestore::AggregateQuerySnapshotThe results of executing anAggregateQuery.
firebase::firestore::CollectionReferenceACollectionReference can be used for adding documents, getting document references, and querying for documents (using the methods inherited fromQuery).
firebase::firestore::DocumentChangeADocumentChange represents a change to the documents matching a query.
firebase::firestore::DocumentReferenceADocumentReference refers to a document location in aFirestore database and can be used to write, read, or listen to the location.
firebase::firestore::DocumentSnapshotADocumentSnapshot contains data read from a document in yourFirestore database.
firebase::firestore::FieldPathAFieldPath refers to a field in a document.
firebase::firestore::FieldValueA field value represents variant datatypes as stored byFirestore.
firebase::firestore::FilterAFilter represents a restriction on one or more field values and can be used to refine the results of aQuery.
firebase::firestore::FirestoreEntry point for the FirebaseFirestore C++ SDK.
firebase::firestore::GeoPointAn immutable object representing a geographical point inFirestore.
firebase::firestore::ListenerRegistrationRepresents a listener that can be removed by callingRemove().
firebase::firestore::LoadBundleTaskProgressRepresents a progress update or the final state from loading bundles.
firebase::firestore::QueryAQuery which you can read or listen to.
firebase::firestore::QuerySnapshotAQuerySnapshot contains zero or moreDocumentSnapshot objects.
firebase::firestore::SetOptionsAn options object that configures the behavior of Set() calls.
firebase::firestore::SettingsSettings used to configure aFirestore instance.
firebase::firestore::SnapshotMetadataMetadata about a snapshot, describing the state of the snapshot.
firebase::firestore::TransactionTransaction provides methods to read and write data within a transaction.
firebase::firestore::TransactionOptionsOptions to customize transaction behavior forFirestore.runTransaction().
firebase::firestore::WriteBatchA write batch is used to perform multiple writes as a single atomic unit.

firebase::functions

Classes

firebase::functions::FunctionsEntry point for the Firebase C++ SDK for CloudFunctions.
firebase::functions::HttpsCallableReferenceRepresents a reference to a CloudFunctions object.
firebase::functions::HttpsCallableResultAnHttpsCallableResult contains the result of calling an HttpsCallable.

firebase::installations

Classes

firebase::installations::InstallationsInstallations provides a unique identifier for each app instance and a mechanism to authenticate and authorize actions (for example, sending an FCM message).

firebase::messaging

Classes

firebase::messaging::ListenerBase class used to receive messages from Firebase Cloud Messaging.
firebase::messaging::PollableListenerA listener that can be polled to consume pendingMessages.

Structs

firebase::messaging::AndroidNotificationParamsData structure for parameters that are unique to the Android implementation.
firebase::messaging::MessageData structure used to receive messages from cloud messaging.
firebase::messaging::MessagingOptionsA class to configure the behavior of Firebase Cloud Messaging.
firebase::messaging::NotificationUsed for messages that display a notification.

firebase::remote_config

Classes

firebase::remote_config::ConfigUpdateListenerRegistrationCalling Remove stops the listener from receiving config updates and unregisters itself.
firebase::remote_config::RemoteConfigEntry point for the Firebase C++ SDK for Remote Config.

Structs

firebase::remote_config::ConfigInfoDescribes the state of the most recent Fetch() call.
firebase::remote_config::ConfigKeyValueDescribes a mapping of a key to a string value.
firebase::remote_config::ConfigKeyValueVariantDescribes a mapping of a key to a value of any type.
firebase::remote_config::ConfigSettingsConfigurations for Remote Config behavior.
firebase::remote_config::ConfigUpdateInformation about the updated config.
firebase::remote_config::ValueInfoDescribes a retrieved value.

firebase::storage

Classes

firebase::storage::ControllerControls an ongoing operation, allowing the caller to Pause, Resume or Cancel an ongoing download or upload.
firebase::storage::ListenerBase class used to receive pause and progress events on a running read or write operation.
firebase::storage::MetadataMetadata stores default attributes such as size and content type.
firebase::storage::StorageEntry point for the Firebase C++ SDK for CloudStorage.
firebase::storage::StorageReferenceRepresents a reference to a CloudStorage object.

firebase::ump

Classes

firebase::ump::ConsentInfoConsent Information class for the User Messaging Platform SDK.

Structs

firebase::ump::ConsentDebugSettingsDebug settings forConsentInfo::RequestConsentInfoUpdate().
firebase::ump::ConsentRequestParametersParameters for theConsentInfo::RequestConsentInfoUpdate() operation.

std

Structs

std::hash< firebase::firestore::FieldPath >A convenient specialization of std::hash for FieldPath.

Additional Resources

Modules

Analytics EventsPredefined event names.
Analytics ParametersPredefined event parameter names.
Analytics User PropertiesPredefined user property names.

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 2025-07-23 UTC.