Jump to top

Reference API

Page containing the full index of all React Native Firebase reference API types. All reference pages are automatically generated from the TypeScript ambient declaration files found in the GitHub repository.

All contributions to help improve the TypeScript implementation of the library are welcome!

admob

APITypeDescription
InterstitialAd
interface

A class for interacting and showing Interstitial Ads.

MobileAd
interface

Base class for InterstitialAd, RewardedAd, NativeAd and BannerAd.

admob
interface

The Firebase Admob service interface.

RewardedAd
interface

A class for interacting and showing Rewarded Ads.

AdEventType
interface

Common event types for ads.

AdProvider
interface

A AdProvider interface returned from AdsConsent.getProviders.

AdShowOptions
interface

A AdShowOptions interface used when showing an ad.

AdsConsent
interface

Under the Google EU User Consent Policy, you must make certain disclosures to your users in the European Economic Area (EEA) and obtain their consent to use cookies or other local storage, where legally required, and to use personal data (such as AdID) to serve ads. This policy reflects the requirements of the EU ePrivacy Directive and the General Data Protection Regulation (GDPR).

AdsConsentDebugGeography
interface

AdsConsentDebugGeography interface.

AdsConsentFormOptions
interface

The options used to show on the Google-rendered consent form. At least one of withAdFree, withPersonalizedAds and WithNonPersonalizedAds needs to be set to true.

AdsConsentFormResult
interface

The result of a Google-rendered consent form.

AdsConsentInfo
interface

The result of requesting info about a users consent status.

AdsConsentStatus
interface

AdsConsentStatus interface.

BannerAd
interface

An interface for a Banner advert component.

BannerAdSize
interface

Used to sets the size of an Advert.

MaxAdContentRating
interface

The MaxAdContentRating interface used when setting global advert request options.

RequestConfiguration
interface

The RequestConfiguration used when setting global ad settings via setRequestConfiguration.

RequestOptions
interface

The RequestOptions interface. Used when passing additional request options before an advert is loaded.

RewardedAdEventType
interface

Ad event types specially for RewardedAd.

RewardedAdReward
interface

A RewardedAdReward returned from rewarded ads.

TestIds
interface

Ad Unit IDs used for testing purposes. These should not be used in production apps.

AdEventListener
alias

A callback interface for all ad events.

analytics

APITypeDescription
analytics
interface

The Firebase Analytics service interface.

AddToCartEventParameters
interface
AddToWishlistEventParameters
interface
BeginCheckoutEventParameters
interface
CampaignDetailsEventParameters
interface
EarnVirtualCurrencyEventParameters
interface
EcommercePurchaseEventParameters
interface
GenerateLeadEventParameters
interface
JoinGroupEventParameters
interface
LevelEndEventParameters
interface
LevelStartEventParameters
interface
LevelUpEventParameters
interface
LoginEventParameters
interface
PostScoreEventParameters
interface
PresentOfferEventParameters
interface
PurchaseRefundEventParameters
interface
RemoveFromCartEventParameters
interface
SearchEventParameters
interface
SelectContentEventParameters
interface
SetCheckoutOptionEventParameters
interface
ShareEventParameters
interface
SignUpEventParameters
interface
SpendVirtualCurrencyEventParameters
interface
UnlockAchievementEventParameters
interface
ViewItemEventParameters
interface
ViewItemListEventParameters
interface
ViewSearchResults
interface

auth

APITypeDescription
auth
interface

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

ActionCodeInfo
interface

The interface returned from a auth#checkActionCode call.

ActionCodeInfoData
interface

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.

ActionCodeSettings
interface

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

ActionCodeSettingsAndroid
interface

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

ActionCodeSettingsIos
interface

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

AdditionalUserInfo
interface

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

AuthCredential
interface

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

AuthProvider
interface

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

AuthSettings
interface

Interface for module auth settings.

ConfirmationResult
interface

A result from a auth#signInWithPhoneNumber call.

EmailAuthProvider
interface

Email and password auth provider implementation.

IdTokenResult
interface

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.

PhoneAuthError
interface

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

PhoneAuthListener
interface

The listener function returned from a auth#verifyPhoneNumber call.

PhoneAuthSnapshot
interface

A snapshot interface of the current phone auth state.

PhoneAuthState
interface
UpdateProfile
interface

Request used to update user profile information.

User
interface

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.

UserCredential
interface

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.

UserInfo
interface

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.

UserMetadata
interface

Holds the user metadata for the current User.

AuthListenerCallback
alias

An auth listener callback function for auth#onAuthStateChanged.

crashlytics

APITypeDescription
crashlytics
interface

The Firebase Crashlytics service interface.

database

APITypeDescription
database
interface

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

DataSnapshot
interface

A DataSnapshot contains data from a Database location.

OnDisconnect
interface

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.

Query
interface

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.

Reference
interface

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

ServerValue
interface

The ServerValue interface provides access to Firebase server values.

TransactionResult
interface
EventType
alias
ThenableReference
alias

dynamic-links

APITypeDescription
ShortLinkType
enum

ShortLinkType determines the type of dynamic short link which Firebase creates. Used when building a new short link via buildShortLink().

dynamic-links
interface

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

DynamicLink
interface

A received Dynamic Link from either onLink or getInitialLink.

DynamicLinkAnalyticsParameters
interface

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

DynamicLinkAndroidParameters
interface

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

DynamicLinkIOSParameters
interface

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

DynamicLinkITunesParameters
interface

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

DynamicLinkNavigationParameters
interface

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

DynamicLinkParameters
interface

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

DynamicLinkSocialParameters
interface

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

firestore

APITypeDescription
Blob
interface

An immutable object representing an array of bytes.

FieldPath
interface

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).

FieldValue
interface

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

GeoPoint
interface

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

firestore
interface

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

Timestamp
interface

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.

CollectionReference
interface

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

DocumentChange
interface

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

DocumentReference
interface

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.

DocumentSnapshot
interface

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.

GetOptions
interface

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).

Query
interface

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.

QueryDocumentSnapshot
interface

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.

QuerySnapshot
interface

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.

SetOptions
interface

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.

Settings
interface

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

SnapshotListenOptions
interface

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.

SnapshotMetadata
interface

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

Transaction
interface

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().

WriteBatch
interface

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

DocumentChangeType
alias

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

DocumentFieldType
alias

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

WhereFilterOp
alias

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

functions

APITypeDescription
functions
interface

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

HttpsCallable
interface

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

HttpsCallableOptions
interface

An HttpsCallableOptions object that can be passed as the second argument to firebase.functions().httpsCallable(name, HttpsCallableOptions).

HttpsCallableResult
interface

An HttpsCallableResult wraps a single result from a function call.

HttpsError
interface

An HttpsError wraps a single error from a function call.

HttpsErrorCode
interface

The HttpsErrorCode interface provides access to all FunctionsErrorCode type aliases.

FunctionsErrorCode
alias

iid

APITypeDescription
iid
interface

The Firebase Instance ID service interface.

in-app-messaging

APITypeDescription
in-app-messaging
interface

The Firebase In-App Messaging service interface.

ml-natural-language

APITypeDescription
ml-natural-language
interface

The Firebase ML Kit service interface.

IdentifiedLanguage
interface

An identified language for the given input text. Returned as an Array of IdentifiedLanguage from identifyPossibleLanguages.

LanguageIdentificationOptions
interface

An interface representing the language identification options to be used with the identifyLanguage and identifyPossibleLanguages methods.

SuggestedReply
interface

An interface representing a suggested reply, an array of these are returned from suggestReplies.

TextMessage
interface

A TextMessage interface provided to suggestReplies().

messaging

APITypeDescription
AuthorizationStatus
enum

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

NotificationAndroidPriority
enum

The enum representing a notification priority.

NotificationAndroidVisibility
enum

The enum representing the visibility of a notification.

messaging
interface

The Firebase Messaging service interface.

IOSPermissions
interface

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

Notification
interface
NotificationIOSCriticalSound
interface

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

RemoteMessage
interface

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

SendErrorEvent
interface

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

perf

APITypeDescription
HttpMetric
interface

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

perf
interface

The Firebase Performance Monitoring service interface.

Trace
interface

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

HttpMethod
alias

Valid HTTP methods.

remote-config

APITypeDescription
remote-config
interface

The Firebase Remote RemoteConfig service interface.

ConfigDefaults
interface

An Interface representing a RemoteConfig Defaults object.

ConfigSettings
interface

An Interface representing settable config settings.

ConfigValue
interface

An Interface representing a Remote RemoteConfig value.

ConfigValues
interface

An Interface representing multiple RemoteConfig Values.

LastFetchStatus
interface

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

ValueSource
interface

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

storage

APITypeDescription
storage
interface

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

FullMetadata
interface

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

ListOptions
interface

The options list() accepts.

ListResult
interface

Result returned by list().

Reference
interface

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

SettableMetadata
interface

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

StringFormat
interface

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

Task
interface

Storage Task used for Uploading or Downloading files.

TaskEvent
interface

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

TaskSnapshot
interface

A TaskSnapshot provides information about a storage tasks state.

TaskSnapshotObserver
interface

The snapshot observer returned from a Task#on listener.

TaskState
interface

A collection of properties that indicates the current tasks state.

ml-vision

APITypeDescription
VisionCloudLandmarkRecognizerModelType
enum

Model types for cloud landmark recognition.

VisionCloudTextRecognizerModelType
enum

The cloud model type used for in VisionCloudTextRecognizerOptions & VisionCloudDocumentTextRecognizerOptions

VisionDocumentTextRecognizedBreakType
enum

Enum representing the detected break type.

VisionFaceContourType
enum

Countour type for a face.

VisionFaceDetectorClassificationMode
enum

Indicates whether to run additional classifiers for characterizing attributes such as "smiling" and "eyes open".

VisionFaceDetectorContourMode
enum

Sets whether to detect contours or not. Processing time increases as the number of contours to search for increases, so detecting all contours will increase the overall detection time.

VisionFaceDetectorLandmarkMode
enum

Sets whether to detect no landmarks or all landmarks. Processing time increases as the number of landmarks to search for increases, so detecting all landmarks will increase the overall detection time. Detecting landmarks can improve pose estimation.

VisionFaceDetectorPerformanceMode
enum

Extended option for controlling additional accuracy / speed trade-offs in performing face detection. In general, choosing the more accurate mode will generally result in longer runtime, whereas choosing the faster mode will generally result in detecting fewer faces.

VisionFaceLandmarkType
enum

Landmark types for a face.

ml-vision
interface

The Firebase ML Kit service interface.

VisionCloudDocumentTextRecognizerOptions
interface

Options for the cloud document text recognizer.

VisionCloudImageLabelerOptions
interface

Options for cloud image labeler. Confidence threshold could be provided for the label detection.

VisionCloudLandmarkRecognizerOptions
interface

Detector for finding popular natural and man-made structures within an image.

VisionCloudTextRecognizerOptions
interface

Options for cloud text recognizer.

VisionDocumentText
interface

A hierarchical representation of document text recognized in an image.

VisionDocumentTextBase
interface

A shared type that all VisionDocumentText components inherit from

VisionDocumentTextBlock
interface

Represents a block of text.

VisionDocumentTextParagraph
interface

A structural unit of text representing a number of words in certain order.

VisionDocumentTextRecognizedBreak
interface

A recognized break is the detected start or end of a structural component.

VisionDocumentTextWord
interface

A single word representation.

VisionFace
interface

Represents a face returned from faceDetectorProcessImage().

VisionFaceContour
interface

Represent a face contour. A contour is a list of points on a detected face, such as the mouth. When 'left' and 'right' are used, they are relative to the subject in the image. For example, the LEFT_EYE landmark is the subject's left eye, not the eye that is on the left when viewing the image.

VisionFaceDetectorOptions
interface

Options for vision face detector.

VisionFaceLandmark
interface

Represent a face landmark. A landmark is a point on a detected face, such as an eye, nose, or mouth.

VisionImageLabel
interface

Represents an image label return from imageLabelerProcessImage() and cloudImageLabelerProcessImage().

VisionImageLabelerOptions
interface

Options for on device image labeler. Confidence threshold could be provided for the label detection.

VisionLandmark
interface

Represents a detected landmark returned from cloudLandmarkRecognizerProcessImage().

VisionText
interface

A hierarchical representation of texts recognized in an image.

VisionTextBase
interface

A shared type that all Vision Text components inherit from

VisionTextBlock
interface

Represents a block of text (similar to a paragraph).

VisionTextLine
interface

Represents a line of text.

VisionDocumentTextSymbol
alias

A single symbol representation.

VisionGeoPoint
alias

A representation of a latitude/longitude pair.

VisionPoint
alias

A point holds two number coordinates relative to the processed image. Points are represented as [x, y].

VisionRectangle
alias

A Rectangle holds four number coordinates relative to the processed image. Rectangle are represented as [left, top, right, bottom].

VisionTextElement
alias

Roughly equivalent to a space-separated "word" in most Latin languages, or a character in others. For instance, if a word is split between two lines by a hyphen, each part is encoded as a separate Element.

VisionBarcodeAddressType
enum

The type of a address detected in a barcode.

VisionBarcodeEmailType
enum

The type of an email detected in a barcode.

VisionBarcodeFormat
enum

Barcode format constants - enumeration of supported barcode formats.

VisionBarcodePhoneType
enum

The type of a phone number detected in a barcode.

VisionBarcodeValueType
enum

Barcode value type constants - enumeration of supported barcode content value types.

VisionBarcodeWifiEncryptionType
enum

The type of wifi encryption used for a VisionBarcodeWifi instance.

VisionBarcode
interface

A representation of a barcode detected in an image.

VisionBarcodeAddress
interface

A contacts address.

VisionBarcodeCalendarEvent
interface

A calendar event extracted from QRCode.

VisionBarcodeContactInfo
interface

A persons or organization's business card. For example a VCARD.

VisionBarcodeDetectorOptions
interface

Custom options for barcode detection.

VisionBarcodeDriverLicense
interface

A driver license or ID card.

VisionBarcodeEmail
interface

An email message from a 'MAILTO:' or similar QRCode type, or from a ContactInfo/VCARD.

VisionBarcodePersonName
interface

A persons name, both formatted version and their individual name components.

VisionBarcodePhone
interface

A phone number and it's detected type, e.g. VisionBarcodePhoneType.MOBILE

VisionBarcodeSms
interface

An sms message from an 'SMS:' or similar QRCode type.

VisionBarcodeUrl
interface

A URL and title from a 'MEBKM:' or similar QRCode type.

VisionBarcodeWifi
interface

Wifi network parameters from a 'WIFI:' or similar QRCode type.

app

APITypeDescription
FirebaseModule
interface

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

FirebaseApp
interface
FirebaseAppConfig
interface
FirebaseAppOptions
interface
FirebaseJsonConfig
interface

React Native Firebase firebase.json config

app
interface
NativeFirebaseError
interface
FirebaseModuleWithStatics
alias
FirebaseModuleWithStaticsAndApp
alias