Reference API

The Firebase Analytics service interface.

Additional options that can be passed to Analytics method calls such as logEvent. Web only.

Analytics instance initialization options. Web only.

Consent status settings for each consent type. For more information, see {@link https://developers.google.com/tag-platform/tag-manager/templates/consent-apis | the GA4 reference documentation for consent state and consent types}.

Standard gtag.js event parameters. For more information, see the GA4 reference documentation. Web only.

A set of common Google Analytics config settings recognized by gtag.js. Web only.

Specifies custom options for your Firebase Analytics instance. You must set these before initializing firebase.analytics().

Any custom event name string not in the standard list of recommended event names.

Type for standard Google Analytics event names. logEvent also accepts any custom string and interprets it as a custom event name. See https://firebase.google.com/docs/reference/js/analytics.md#eventnamestring

Custom provider class.

The Firebase App Check service is available for the default app or a given app.

Options for App Check initialization.

An App Check provider. This can be either the built-in reCAPTCHA provider or a custom provider. For more on custom providers, see https://firebase.google.com/docs/app-check/web-custom-provider

The token returned from an AppCheckProvider.

Result returned by getToken().

The result return from onTokenChanged

The Firebase AppDistribution service interface.

The release information returned by the update check when a new version is available.

Identifies the type of a second factor.

The Firebase Authentication service is available for the default app or a given app.

The interface returned from a auth#checkActionCode call.

Additional data returned from a auth#checkActionCode call. For the PASSWORD_RESET, VERIFY_EMAIL, and RECOVER_EMAIL actions, this object contains an email field with the address the email was sent to. For the RECOVER_EMAIL action, which allows a user to undo an email address change, this object also contains a fromEmail field with the user account's new email address. After the action completes, the user's email address will revert to the value in the email field from the value in fromEmail field.

Options to be sent with requests such as User#sendEmailVerification.

Android specific options which can be attached to the ActionCodeSettings object to be sent with requests such as User#sendEmailVerification.

iOS specific options which can be attached to the ActionCodeSettings object to be sent with requests such as User#sendEmailVerification.

A structure containing additional user information from a federated identity provider via UserCredential.

Interface that represents the credentials returned by an auth provider. Implementations specify the details about each auth provider's credential requirements.

Interface that represents an auth provider. Implemented by other providers.

Interface for module auth settings.

A result from a auth#signInWithPhoneNumber call.

Email and password auth provider implementation.

Interface representing ID token result obtained from User#getIdTokenResult. It contains the ID token JWT string and other helper properties for getting different data associated with the token as well as all the decoded payload claims.

Holds information about the user's enrolled factors.

Facilitates the recovery when a user needs to provide a second factor to sign-in.

The entry point for most multi-factor operations.

Interface that represents an OAuth provider. Implemented by other providers.

Interface that represents an Open ID Connect auth provider. Implemented by other providers.

A custom error in the event verifying a phone number failed.

The listener function returned from a auth#verifyPhoneNumber call.

A snapshot interface of the current phone auth state.

Request used to update user profile information.

Represents a user's profile information in your Firebase project's user database. It also contains helper methods to change or retrieve profile information, as well as to manage that user's authentication state.

A structure containing a User, an AuthCredential, the operationType, and any additional user information that was returned from the identity provider. operationType could be 'signIn' for a sign-in operation, 'link' for a linking operation and 'reauthenticate' for a re-authentication operation.

Represents a collection of standard profile information for a user. Can be used to expose profile information returned by an identity provider, such as Google Sign-In or Facebook Login.

Holds the user metadata for the current User.

An auth listener callback function for auth#onAuthStateChanged.

Contains information about a second factor.

Try and obtain a #MultiFactorResolver instance based on an error. Returns null if no resolver object could be found.

Return the #MultiFactorUser instance for the current user.

The Firebase Crashlytics service interface.

The Firebase Database service is available for the default app or a given app.

A DataSnapshot contains data from a Database location.

The onDisconnect class allows you to write or clear data when your client disconnects from the Database server. These updates occur whether your client disconnects cleanly or not, so you can rely on them to clean up data even if a connection is dropped or a client crashes.

A Query sorts and filters the data at a Database location so only a subset of the child data is included. This can be used to order a collection of data by some attribute (for example, height of dinosaurs) as well as to restrict a large list of items (for example, chat messages) down to a number suitable for synchronizing to the client. Queries are created by chaining together one or more of the filter methods defined here.

A Reference represents a specific location in your Database and can be used for reading or writing data to that Database location.

The ServerValue interface provides access to Firebase server values.

ShortLinkType determines the type of dynamic short link which Firebase creates. Used when building a new short link via buildShortLink(). These are exported through statics connected to the module.

The Firebase Dynamic DynamicLinks service is available for the default app only.

A received Dynamic Link from either onLink or getInitialLink.

The DynamicLinkAnalyticsParameters interface provides functionality to add Google Analytic based parameters to a dynamic link.

The DynamicLinkAndroidParameters interface provides functionality to configure the behaviour of dynamic links for Android devices.

The DynamicLinkIOSParameters interface provides functionality to configure the behaviour of dynamic links for iOS devices.

The DynamicLinkITunesParameters interface provides functionality to add iTunes Connect Analytics based parameters to the created dynamic link.

The DynamicLinkNavigationParameters interface provides functionality to specify how the navigation of the created link is handled.

The DynamicLinkOtherPlatformParameters interface provides functionality to open a custom URL on platforms beside Android and iOS. This is useful to specify a different behavior on desktop, like displaying a full web page of the app content/payload (as specified by param link) with another dynamic link to install the app.

The DynamicLinkParameters interface provides access to the Dynamic Link builder classes used to configure a created link.

The DynamicLinkSocialParameters interface provides functionality to add additional social meta-data to the URL.

Represents an aggregation that can be performed by Firestore.

An immutable object representing an array of bytes.

A FieldPath refers to a field in a document. The path may consist of a single field name (referring to a top-level field in the document), or a list of field names (referring to a nested field in the document).

Sentinel values that can be used when writing document fields with set() or update().

An immutable object representing a geo point in Firestore. The geo point is represented as latitude/longitude pair.

The Firebase Cloud Firestore service is available for the default app or a given app.

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.

The results of requesting an aggregated query.

The results of executing an aggregation query.

A type whose property values are all AggregateField objects.

A CollectionReference object can be used for adding documents, getting document references, and querying for documents (using the methods inherited from Query).

A DocumentChange represents a change to the documents matching a query. It contains the document affected and the type of change that occurred.

A DocumentData object represents the data in a document.

A DocumentReference refers to a document location in a Firestore database and can be used to write, read, or listen to the location. The document at the referenced location may or may not exist. A DocumentReference can also be used to create a CollectionReference to a subcollection.

A DocumentSnapshot contains data read from a document in your Firestore database. The data can be extracted with .data() or .get(:field) to get a specific field.

The Filter functions used to generate an instance of Filter.

An options object that configures the behavior of get() calls on DocumentReference and Query. By providing a GetOptions object, these methods can be configured to fetch results only from the server, only from the local cache or attempt to fetch results from the server and fall back to the cache (which is the default).

Represents a progress update or a final state from loading bundles.

Returns the PersistentCache Index Manager used by the given Firestore object. The PersistentCacheIndexManager instance, or null if local persistent storage is not in use.

A Query refers to a Query which you can read or listen to. You can also construct refined Query objects by adding filters and ordering.

A QueryDocumentSnapshot contains data read from a document in your Firestore database as part of a query. The document is guaranteed to exist and its data can be extracted with .data() or .get(:field) to get a specific field.

A QuerySnapshot contains zero or more QueryDocumentSnapshot objects representing the results of a query. The documents can be accessed as an array via the docs property or enumerated using the forEach method. The number of documents can be determined via the empty and size properties.

An options object that configures the behavior of set() calls in DocumentReference, WriteBatch and Transaction. These calls can be configured to perform granular merges instead of overwriting the target documents in their entirety by providing a SetOptions with merge: true.

Specifies custom configurations for your Cloud Firestore instance. You must set these before invoking any other methods.

An options object that can be passed to DocumentReference.onSnapshot(), Query.onSnapshot() and QuerySnapshot.docChanges() to control which types of changes to include in the result set.

Metadata about a snapshot, describing the state of the snapshot.

A reference to a transaction. The Transaction object passed to a transaction's updateFunction provides the methods to read and write data within the transaction context. See Firestore.runTransaction().

A write batch, used to perform multiple writes as a single atomic unit.

The union of all AggregateField types that are supported by Firestore.

A type whose keys are taken from an AggregateSpec, and whose values are the result of the aggregation performed by the corresponding AggregateField from the input AggregateSpec.

The type of a DocumentChange may be 'added', 'removed', or 'modified'.

The types for a DocumentSnapshot field that are supported by Firestore.

An instance of Filter used to generate Firestore Filter queries.

Utility type to allow FieldValue and to allow Date in place of Timestamp objects.

Represents the state of bundle loading tasks.

Filter conditions in a Query.where() clause are specified using the strings '<', '<=', '==', '>=', '>', 'array-contains', 'array-contains-any' or 'in'.

The Firebase Cloud Functions service is available for the default app, a given app or a specified region.

An HttpsCallable is a reference to a "callable" http trigger in Google Cloud Functions.

An interface for metadata about how calls should be executed. An instance of HttpsCallableOptions can be passed as the second argument to firebase.functions().httpsCallable(name, httpsCallableOptions).

An HttpsCallableResult wraps a single result from a function call.

An HttpsError wraps a single error from a function call.

The HttpsErrorCode interface provides access to all FunctionsErrorCode type aliases.

The Firebase In-App Messaging service interface.

The Firebase Installations service is available for the default app or a given app.

An enum representing the notification authorization status for this app on the device.

The enum representing a notification priority.

The enum representing the visibility of a notification.

The Firebase Messaging service interface.

Options for features provided by the FCM SDK for Web.

Options for getToken()

An interface representing all the available permissions that can be requested by your app via the requestPermission API.

Options for getToken() and deleteToken()

Represents a critical sound configuration that can be included in the aps dictionary of an APNs payload.

The RemoteMessage interface describes an outgoing & incoming message from the remote FCM server.

An event that is received when a message fails to send.

NotificationPayload is an alias for Notification. This is to keep it the same as Firebase Web JS SDK v9 and to make it backwards compatible.

Metric used to collect data for network requests/responses. A new instance must be used for every request/response.

The Firebase Performance Monitoring service interface.

ScreenTrace allows you to record a custom screen rendering trace of slow and frozen frames. Throws on constructor if hardware acceleration is off or if Android is 9.0 or 9.1.

Trace allows you to time the beginning to end of a certain action in your app with additional metric values and attributes.

Valid HTTP methods.

The Firebase Remote RemoteConfig service interface.

Set default config values by updating defaultConfig with an object & the properties you require as default.

An Interface representing settable config settings.

An Interface representing a RemoteConfig value.

An Interface representing multiple RemoteConfig Values.

A pseudo-enum for usage with ConfigSettingsRead.lastFetchStatus to determine the last fetch status.

A pseudo-enum for usage with ConfigValue.source to determine the value source.

The status of the latest Remote RemoteConfig fetch action.

Defines levels of Remote Config logging. Web only.

The Cloud Storage service is available for the default app, a given app or a specific storage bucket.

Storage Emulator options. Web only.

The full readable metadata returned by TaskSnapshot.metadata or StorageReference.getMetadata().

The options list() accepts.

Result returned by list().

Represents a reference to a Google Cloud Storage object in React Native Firebase.

An interface representing all the metadata properties that can be set.

Possible string formats used for uploading via StorageReference.putString()

Storage Task used for Uploading or Downloading files.

An event to subscribe to that is triggered on a Upload or Download task.

Result returned from a non-resumable upload.

A TaskSnapshot provides information about a storage tasks state.

The snapshot observer returned from a Task#on listener.

A collection of properties that indicates the current tasks state.

A class that all React Native Firebase modules extend from to provide default behaviour.

Interface for a supplied AsyncStorage.