FirebaseFirebase
  • Home
  • Features
  • Pricing
  • Docs
  • Case Studies
  • Support
Go to Console
Sign in
  • Documentation
  • Overview
  • Guides
  • Reference
  • Samples
  • Libraries
  • Home
  • Features
  • Pricing
  • Docs
    • Overview
    • Guides
    • Reference
    • Samples
    • Libraries
  • Case Studies
  • Support
  • API Reference
  • CLI Reference
    • Overview
    • auth:import
  • iOS
    • FirebaseCore
    • Classes
      • Overview
      • FIRAnalyticsConfiguration
      • FIRApp
      • FIRConfiguration
      • FIROptions
    • Enums
      • Overview
      • FIRLogLevel
    • Type Definitions
      • Overview
      • FIRAppVoidBoolCallback
    • FirebaseAnalytics
    • Classes
      • Overview
      • FIRAnalytics
    • Constants
      • Overview
      • kFIREventAddPaymentInfo
      • kFIREventAddToCart
      • kFIREventAddToWishlist
      • kFIREventAppOpen
      • kFIREventBeginCheckout
      • kFIREventEarnVirtualCurrency
      • kFIREventEcommercePurchase
      • kFIREventGenerateLead
      • kFIREventJoinGroup
      • kFIREventLevelUp
      • kFIREventLogin
      • kFIREventPostScore
      • kFIREventPresentOffer
      • kFIREventPurchaseRefund
      • kFIREventSearch
      • kFIREventSelectContent
      • kFIREventShare
      • kFIREventSignUp
      • kFIREventSpendVirtualCurrency
      • kFIREventTutorialBegin
      • kFIREventTutorialComplete
      • kFIREventUnlockAchievement
      • kFIREventViewItem
      • kFIREventViewItemList
      • kFIREventViewSearchResults
      • kFIRParameterAchievementID
      • kFIRParameterCharacter
      • kFIRParameterContentType
      • kFIRParameterCoupon
      • kFIRParameterCurrency
      • kFIRParameterDestination
      • kFIRParameterEndDate
      • kFIRParameterFlightNumber
      • kFIRParameterGroupID
      • kFIRParameterItemCategory
      • kFIRParameterItemID
      • kFIRParameterItemLocationID
      • kFIRParameterItemName
      • kFIRParameterLevel
      • kFIRParameterLocation
      • kFIRParameterNumberOfNights
      • kFIRParameterNumberOfPassengers
      • kFIRParameterNumberOfRooms
      • kFIRParameterOrigin
      • kFIRParameterPrice
      • kFIRParameterQuantity
      • kFIRParameterScore
      • kFIRParameterSearchTerm
      • kFIRParameterShipping
      • kFIRParameterSignUpMethod
      • kFIRParameterStartDate
      • kFIRParameterTax
      • kFIRParameterTransactionID
      • kFIRParameterTravelClass
      • kFIRParameterValue
      • kFIRParameterVirtualCurrencyName
      • kFIRUserPropertySignUpMethod
    • FirebaseAppIndexing
    • Classes
      • Overview
      • FIRAppIndexing
    • FirebaseAuth
    • Classes
      • Overview
      • FIRActionCodeInfo
      • FIRAuth
      • FIRAuthCredential
      • FIRAuthErrors
      • FIREmailPasswordAuthProvider
      • FIRFacebookAuthProvider
      • FIRGitHubAuthProvider
      • FIRGoogleAuthProvider
      • FIRTwitterAuthProvider
      • FIRUser
      • FIRUserProfileChangeRequest
    • Constants
      • Overview
      • FIRAuthErrorDomain
      • FIRAuthErrorNameKey
      • FIRAuthStateDidChangeNotification
      • FIREmailPasswordAuthProviderID
      • FIRFacebookAuthProviderID
      • FIRGitHubAuthProviderID
      • FIRGoogleAuthProviderID
      • FIRTwitterAuthProviderID
      • FirebaseAuthVersionNumber
      • FirebaseAuthVersionString
    • Enums
      • Overview
      • FIRActionCodeOperation
      • FIRActionDataKey
      • FIRAuthErrorCode
    • Protocols
      • Overview
      • FIRUserInfo
    • Type Definitions
      • Overview
      • FIRApplyActionCodeCallback
      • FIRAuthResultCallback
      • FIRAuthStateDidChangeListenerBlock
      • FIRAuthStateDidChangeListenerHandle
      • FIRAuthTokenCallback
      • FIRCheckActionCodeCallBack
      • FIRConfirmPasswordResetCallback
      • FIRProviderQueryCallback
      • FIRSendEmailVerificationCallback
      • FIRSendPasswordResetCallback
      • FIRUserProfileChangeCallback
      • FIRVerifyPasswordResetCodeCallback
    • FirebaseDatabase
    • Classes
      • Overview
      • FIRDataSnapshot
      • FIRDatabase
      • FIRDatabaseQuery
      • FIRDatabaseReference
      • FIRMutableData
      • FIRServerValue
      • FIRTransactionResult
    • Enums
      • Overview
      • FIRDataEventType
    • Type Definitions
      • Overview
      • FIRDatabaseHandle
    • FirebaseDynamicLinks
    • Classes
      • Overview
      • FIRDynamicLink
      • FIRDynamicLinks
    • Enums
      • Overview
      • FIRDynamicLinkMatchConfidence
    • Type Definitions
      • Overview
      • FIRDynamicLinkResolverHandler
      • FIRDynamicLinkUniversalLinkHandler
    • FirebaseInstanceID
    • Classes
      • Overview
      • FIRInstanceID
    • Constants
      • Overview
      • kFIRInstanceIDScopeFirebaseMessaging
      • kFIRInstanceIDTokenRefreshNotification
    • Enums
      • Overview
      • FIRInstanceIDAPNSTokenType
      • FIRInstanceIDError
    • Type Definitions
      • Overview
      • FIRInstanceIDDeleteHandler
      • FIRInstanceIDDeleteTokenHandler
      • FIRInstanceIDHandler
      • FIRInstanceIDTokenHandler
    • FirebaseInvites
    • Classes
      • Overview
      • FIRInvites
      • FIRInvitesTargetApplication
      • FIRReceivedInvite
    • Constants
      • Overview
      • kFIRInvitesErrorDomain
    • Enums
      • Overview
      • FIRInvitesErrorCode
      • FIRReceivedInviteMatchType
    • Protocols
      • Overview
      • FIRInviteBuilder
      • FIRInviteDelegate
    • FirebaseMessaging
    • Classes
      • Overview
      • FIRMessaging
      • FIRMessagingMessageInfo
      • FIRMessagingRemoteMessage
    • Constants
      • Overview
      • FIRMessagingMessagesDeletedNotification
      • FIRMessagingSendErrorNotification
      • FIRMessagingSendSuccessNotification
    • Enums
      • Overview
      • FIRMessagingError
      • FIRMessagingMessageStatus
    • Protocols
      • Overview
      • FIRMessagingDelegate
    • Type Definitions
      • Overview
      • FIRMessagingConnectCompletion
    • FirebaseCrash
    • Functions
      • Overview
      • FIRCrashLog
      • FIRCrashLogv
      • FIRCrashMessage
      • FIRCrashNSLog
      • FIRCrashNSLogv
    • FirebaseRemoteConfig
    • Classes
      • Overview
      • FIRRemoteConfig
      • FIRRemoteConfigSettings
      • FIRRemoteConfigValue
    • Constants
      • Overview
      • FIRNamespaceGoogleMobilePlatform
      • FIRRemoteConfigErrorDomain
      • FIRRemoteConfigThrottledEndTimeInSecondsKey
    • Enums
      • Overview
      • FIRRemoteConfigError
      • FIRRemoteConfigFetchStatus
      • FIRRemoteConfigSource
    • Type Definitions
      • Overview
      • FIRRemoteConfigFetchCompletion
    • FirebaseStorage
    • Classes
      • Overview
      • FIRStorage
      • FIRStorageDownloadTask
      • FIRStorageMetadata
      • FIRStorageObservableTask
      • FIRStorageReference
      • FIRStorageTask
      • FIRStorageTaskSnapshot
      • FIRStorageUploadTask
    • Constants
      • Overview
      • FIRStorageErrorDomain
      • FirebaseStorageVersionString
    • Enums
      • Overview
      • FIRStorageErrorCode
      • FIRStorageTaskStatus
    • Protocols
      • Overview
      • FIRStorageTaskManagement
    • Type Definitions
      • Overview
      • FIRStorageHandle
      • FIRStorageVoidDataError
      • FIRStorageVoidError
      • FIRStorageVoidMetadata
      • FIRStorageVoidMetadataError
      • FIRStorageVoidSnapshot
      • FIRStorageVoidURLError
    • GoogleMobileAds
    • Classes
      • Overview
      • DFPBannerView
      • DFPCustomRenderedAd
      • DFPInterstitial
      • DFPRequest
      • GADAdChoicesView
      • GADAdLoader
      • GADAdLoaderOptions
      • GADAdReward
      • GADBannerView
      • GADCorrelator
      • GADCorrelatorAdLoaderOptions
      • GADCustomEventExtras
      • GADCustomEventRequest
      • GADDebugOptionsViewController
      • GADDefaultInAppPurchase
      • GADDynamicHeightSearchRequest
      • GADExtras
      • GADInAppPurchase
      • GADInterstitial
      • GADMediaView
      • GADMediatedNativeAdNotificationSource
      • GADMobileAds
      • GADNativeAd
      • GADNativeAdImage
      • GADNativeAdImageAdLoaderOptions
      • GADNativeAdViewAdOptions
      • GADNativeAppInstallAd
      • GADNativeAppInstallAdView
      • GADNativeContentAd
      • GADNativeContentAdView
      • GADNativeCustomTemplateAd
      • GADNativeExpressAdView
      • GADRequest
      • GADRequestError
      • GADRewardBasedVideoAd
      • GADSearchBannerView
      • GADSearchRequest
      • GADVideoController
      • GADVideoOptions
    • Constants
      • Overview
      • GADCustomEventParametersServer
      • GoogleMobileAdsVersionString
      • kDFPSimulatorID
      • kGADAdLoaderAdTypeNativeAppInstall
      • kGADAdLoaderAdTypeNativeContent
      • kGADAdLoaderAdTypeNativeCustomTemplate
      • kGADAdSizeBanner
      • kGADAdSizeFluid
      • kGADAdSizeFullBanner
      • kGADAdSizeInvalid
      • kGADAdSizeLargeBanner
      • kGADAdSizeLeaderboard
      • kGADAdSizeMediumRectangle
      • kGADAdSizeSkyscraper
      • kGADAdSizeSmartBannerLandscape
      • kGADAdSizeSmartBannerPortrait
      • kGADErrorDomain
      • kGADSimulatorID
    • Enums
      • Overview
      • GADAdChoicesPosition
      • GADErrorCode
      • GADGender
      • GADInAppPurchaseStatus
      • GADMBannerAnimationType
      • GADNativeAdImageAdLoaderOptionsOrientation
      • GADSearchBorderType
      • GADSearchCallButtonColor
    • Protocols
      • Overview
      • DFPCustomRenderedBannerViewDelegate
      • DFPCustomRenderedInterstitialDelegate
      • GADAdDelegate
      • GADAdLoaderDelegate
      • GADAdNetworkExtras
      • GADAdSizeDelegate
      • GADAppEventDelegate
      • GADBannerViewDelegate
      • GADCustomEventBanner
      • GADCustomEventBannerDelegate
      • GADCustomEventInterstitial
      • GADCustomEventInterstitialDelegate
      • GADCustomEventNativeAd
      • GADCustomEventNativeAdDelegate
      • GADDebugOptionsViewControllerDelegate
      • GADDefaultInAppPurchaseDelegate
      • GADInAppPurchaseDelegate
      • GADInterstitialDelegate
      • GADMAdNetworkAdapter
      • GADMAdNetworkConnector
      • GADMRewardBasedVideoAdNetworkAdapter
      • GADMRewardBasedVideoAdNetworkConnector
      • GADMediatedNativeAd
      • GADMediatedNativeAdDelegate
      • GADMediatedNativeAppInstallAd
      • GADMediatedNativeContentAd
      • GADMediationAdRequest
      • GADNativeAdDelegate
      • GADNativeAppInstallAdLoaderDelegate
      • GADNativeContentAdLoaderDelegate
      • GADNativeCustomTemplateAdLoaderDelegate
      • GADNativeExpressAdViewDelegate
      • GADRewardBasedVideoAdDelegate
      • GADVideoControllerDelegate
    • Type Definitions
      • Overview
      • GADAdSize
    • Functions
      • Overview
      • CGSizeFromGADAdSize
      • GADAdSizeEqualToSize
      • GADAdSizeFromCGSize
      • GADAdSizeFromNSValue
      • GADAdSizeFullWidthLandscapeWithHeight
      • GADAdSizeFullWidthPortraitWithHeight
      • GADAdSizeIsFluid
      • IsGADAdSizeValid
      • NSStringFromGADAdSize
      • NSValueFromGADAdSize
    • Structs
      • Overview
      • GADAdSize
  • Android
    • Package Summary
    • ads
      • Overview
      • AdListener
      • AdLoader
        • Overview
        • Builder
      • AdRequest
        • Overview
        • Builder
      • AdSize
      • AdView
      • Correlator
      • InterstitialAd
      • MobileAds
        • Overview
        • Settings
      • NativeExpressAdView
      • VideoController
        • Overview
        • VideoLifecycleCallbacks
      • VideoOptions
        • Overview
        • Builder
    • ads.doubleclick
      • Overview
      • AppEventListener
      • CustomRenderedAd
      • OnCustomRenderedAdLoadedListener
      • PublisherAdRequest
        • Overview
        • Builder
      • PublisherAdView
      • PublisherInterstitialAd
    • ads.formats
      • Overview
      • MediaView
      • NativeAd
        • Overview
        • Image
      • NativeAdOptions
        • Overview
        • AdChoicesPlacement
        • Builder
      • NativeAdView
      • NativeAppInstallAd
        • Overview
        • OnAppInstallAdLoadedListener
      • NativeAppInstallAdView
      • NativeContentAd
        • Overview
        • OnContentAdLoadedListener
      • NativeContentAdView
      • NativeCustomTemplateAd
        • Overview
        • OnCustomClickListener
        • OnCustomTemplateAdLoadedListener
    • ads.identifier
      • Overview
      • AdvertisingIdClient
        • Overview
        • Info
    • ads.mediation
      • Overview
      • MediationAdRequest
      • MediationAdapter
      • MediationBannerAdapter
      • MediationBannerListener
      • MediationInterstitialAdapter
      • MediationInterstitialListener
      • MediationNativeAdapter
      • MediationNativeListener
      • NativeAdMapper
      • NativeAppInstallAdMapper
      • NativeContentAdMapper
      • NativeMediationAdRequest
      • NetworkExtras
      • OnContextChangedListener
    • ads.mediation.admob
      • Overview
      • AdMobExtras
    • ads.mediation.customevent
      • Overview
      • CustomEvent
      • CustomEventBanner
      • CustomEventBannerListener
      • CustomEventExtras
      • CustomEventInterstitial
      • CustomEventInterstitialListener
      • CustomEventListener
      • CustomEventNative
      • CustomEventNativeListener
    • ads.purchase
      • Overview
      • InAppPurchase
      • InAppPurchaseListener
      • InAppPurchaseResult
      • PlayStorePurchaseListener
    • ads.reward
      • Overview
      • RewardItem
      • RewardedVideoAd
      • RewardedVideoAdListener
    • ads.reward.mediation
      • Overview
      • MediationRewardedVideoAdAdapter
      • MediationRewardedVideoAdListener
    • ads.search
      • Overview
      • DynamicHeightSearchAdRequest
        • Overview
        • Builder
      • SearchAdRequest
        • Overview
        • Builder
      • SearchAdView
    • appindexing
      • Overview
      • Action
        • Overview
        • Builder
      • AndroidAppUri
      • AppIndex
      • AppIndexApi
        • Overview
        • ActionResult
        • AppIndexingLink
      • Thing
        • Overview
        • Builder
    • appinvite
      • Overview
      • AppInvite
      • AppInviteApi
      • AppInviteInvitation
        • Overview
        • AppInviteInvitation.IntentBuilder
          • Overview
          • PlatformMode
      • AppInviteInvitationResult
      • AppInviteReferral
    • measurement
      • Overview
      • AppMeasurement
      • AppMeasurementContentProvider
      • AppMeasurementInstallReferrerReceiver
      • AppMeasurementReceiver
      • AppMeasurementService
    • firebase
      • Overview
      • FirebaseApiNotAvailableException
      • FirebaseApp
      • FirebaseException
      • FirebaseNetworkException
      • FirebaseOptions
        • Overview
        • Builder
      • FirebaseTooManyRequestsException
    • firebase.analytics
      • Overview
      • FirebaseAnalytics
        • Overview
        • Event
        • Param
        • UserProperty
    • firebase.appindexing
      • Overview
      • Action
        • Overview
        • Action.Builder
          • Overview
          • StatusType
        • Action.Metadata
          • Overview
          • Builder
      • FirebaseAppIndex
      • FirebaseAppIndexingException
      • FirebaseAppIndexingInvalidArgumentException
      • FirebaseAppIndexingTooManyArgumentsException
      • FirebaseUserActions
      • Indexable
        • Overview
        • Builder
        • Indexable.Metadata
          • Overview
          • Builder
    • firebase.appindexing.builders
      • Overview
      • Actions
      • ConversationBuilder
      • DigitalDocumentBuilder
      • DigitalDocumentPermissionBuilder
      • IndexableBuilder
      • Indexables
      • MessageBuilder
      • MusicAlbumBuilder
      • MusicGroupBuilder
      • MusicPlaylistBuilder
      • MusicRecordingBuilder
      • PersonBuilder
    • firebase.auth
      • Overview
      • ActionCodeResult
        • Overview
        • ActionDataKey
        • Operation
      • AuthCredential
      • AuthResult
      • EmailAuthCredential
      • EmailAuthProvider
      • FacebookAuthCredential
      • FacebookAuthProvider
      • FirebaseAuth
        • Overview
        • AuthStateListener
      • FirebaseAuthActionCodeException
      • FirebaseAuthException
      • FirebaseAuthInvalidCredentialsException
      • FirebaseAuthInvalidUserException
      • FirebaseAuthProvider
      • FirebaseAuthRecentLoginRequiredException
      • FirebaseAuthUserCollisionException
      • FirebaseAuthWeakPasswordException
      • FirebaseUser
      • GetTokenResult
      • GithubAuthCredential
      • GithubAuthProvider
      • GoogleAuthCredential
      • GoogleAuthProvider
      • ProviderQueryResult
      • TwitterAuthCredential
      • TwitterAuthProvider
      • UserInfo
      • UserProfileChangeRequest
        • Overview
        • Builder
    • firebase.crash
      • Overview
      • FirebaseCrash
    • firebase.database
      • Overview
      • ChildEventListener
      • DataSnapshot
      • DatabaseError
      • DatabaseException
      • DatabaseReference
        • Overview
        • CompletionListener
      • Exclude
      • FirebaseDatabase
      • GenericTypeIndicator
      • IgnoreExtraProperties
      • Logger
        • Overview
        • Level
      • MutableData
      • OnDisconnect
      • PropertyName
      • Query
      • ServerValue
      • ThrowOnExtraProperties
      • Transaction
        • Overview
        • Handler
        • Result
      • ValueEventListener
    • firebase.iid
      • Overview
      • FirebaseInstanceId
      • FirebaseInstanceIdInternalReceiver
      • FirebaseInstanceIdReceiver
      • FirebaseInstanceIdService
    • firebase.messaging
      • Overview
      • FirebaseMessaging
      • FirebaseMessagingService
      • RemoteMessage
        • Overview
        • Builder
        • Notification
      • SendException
    • firebase.provider
      • Overview
      • FirebaseInitProvider
    • firebase.remoteconfig
      • Overview
      • FirebaseRemoteConfig
      • FirebaseRemoteConfigException
      • FirebaseRemoteConfigFetchException
      • FirebaseRemoteConfigFetchThrottledException
      • FirebaseRemoteConfigInfo
      • FirebaseRemoteConfigSettings
        • Overview
        • Builder
      • FirebaseRemoteConfigValue
    • firebase.storage
      • Overview
      • CancellableTask
      • ControllableTask
      • FileDownloadTask
        • Overview
        • TaskSnapshot
      • FirebaseStorage
      • OnPausedListener
      • OnProgressListener
      • StorageException
        • Overview
        • ErrorCode
      • StorageMetadata
        • Overview
        • Builder
      • StorageReference
      • StorageTask
        • Overview
        • ProvideError
      • StreamDownloadTask
        • Overview
        • StreamProcessor
        • TaskSnapshot
      • UploadTask
        • Overview
        • TaskSnapshot
  • Web
    • Overview
    • ActionCodeInfo
    • App
    • Auth
    • AuthCredential
    • AuthProvider
    • Database
    • DataSnapshot
    • EmailAuthProvider
    • Error
    • FacebookAuthProvider
    • firebase
    • firebase.app
    • firebase.auth
    • firebase.database
    • firebase.database.ServerValue
    • firebase.messaging
    • firebase.storage
    • FirebaseError
    • FullMetadata
    • GithubAuthProvider
    • GoogleAuthProvider
    • Messaging
    • OnDisconnect
    • Promise
    • Query
    • storage.Reference
    • database.Reference
    • SettableMetadata
    • Storage
    • Thenable
    • ThenableReference
    • TwitterAuthProvider
    • UploadMetadata
    • UploadTask
    • UploadTaskSnapshot
    • User
    • UserInfo
    • Index of all
  • Node.js (Client)
    • Overview
    • ActionCodeInfo
    • App
    • Auth
    • AuthCredential
    • AuthProvider
    • Database
    • DataSnapshot
    • EmailAuthProvider
    • Error
    • FacebookAuthProvider
    • firebase
    • firebase.app
    • firebase.auth
    • firebase.database
    • firebase.database.ServerValue
    • FirebaseError
    • GithubAuthProvider
    • GoogleAuthProvider
    • OnDisconnect
    • Promise
    • Query
    • Reference
    • Thenable
    • ThenableReference
    • TwitterAuthProvider
    • User
    • UserInfo
    • Index of all
  • Node.js (Admin)
    • Overview
    • admin
    • admin.auth
    • admin.credential
    • admin.database
    • admin.messaging
    • App
    • Auth
    • Database
    • DataMessagePayload
    • DataSnapshot
    • FirebaseError
    • Messaging
    • MessagingConditionResponse
    • MessagingDeviceGroupResponse
    • MessagingDeviceResult
    • MessagingDevicesResponse
    • MessagingOptions
    • MessagingPayload
    • MessagingTopicResponse
    • NotificationMessagePayload
    • OnDisconnect
    • Query
    • Reference
    • ThenableReference
    • UserInfo
    • UserMetadata
    • UserRecord
    • Index of all
  • Java (Admin)
    • com.google.firebase
      • Overview
      • FirebaseApp
      • FirebaseException
      • FirebaseOptions
        • Overview
        • Builder
    • com.google.firebase.auth
      • Overview
      • FirebaseAuth
      • FirebaseAuthException
      • FirebaseCredential
      • FirebaseCredentials
      • FirebaseToken
    • com.google.firebase.database
      • Overview
      • ChildEventListener
      • DataSnapshot
      • DatabaseError
      • DatabaseException
      • DatabaseReference
        • Overview
        • CompletionListener
      • Exclude
      • FirebaseDatabase
      • GenericTypeIndicator
      • IgnoreExtraProperties
      • Logger
        • Overview
        • Level
      • MutableData
      • OnDisconnect
      • PropertyName
      • Query
      • ServerValue
      • ThrowOnExtraProperties
      • Transaction
        • Overview
        • Handler
        • Result
      • ValueEventListener
    • com.google.firebase.tasks
      • Overview
      • Continuation
      • OnCompleteListener
      • OnFailureListener
      • OnSuccessListener
      • RuntimeExecutionException
      • Task
      • TaskCompletionSource
      • TaskExecutors
      • Tasks
  • C++
    • Overview
    • firebase
      • Overview
      • Classes
        • App
        • AppOptions
        • Future
        • FutureBase
        • ModuleInitializer
        • Variant
    • firebase::admob
      • Overview
      • Classes
        • BannerView
        • BannerView::Listener
        • InterstitialAd
        • InterstitialAd::Listener
        • NativeExpressAdView
        • NativeExpressAdView::Listener
      • Structs
        • AdRequest
        • AdSize
        • BoundingBox
        • KeyValuePair
    • firebase::admob::rewarded_video
      • Overview
      • Classes
        • Listener
        • PollableRewardListener
      • Structs
        • RewardItem
    • firebase::analytics
      • Overview
      • Structs
        • Parameter
    • firebase::auth
      • Overview
      • Classes
        • Auth
        • Auth::FetchProvidersResult
        • AuthStateListener
        • Credential
        • EmailAuthProvider
        • FacebookAuthProvider
        • GitHubAuthProvider
        • GoogleAuthProvider
        • TwitterAuthProvider
        • User
        • User::UserProfile
        • UserInfoInterface
    • firebase::database
      • Overview
      • Classes
        • ChildListener
        • Database
        • DatabaseReference
        • DataSnapshot
        • DisconnectionHandler
        • MutableData
        • Query
        • ValueListener
    • firebase::invites
      • Overview
      • Classes
        • Listener
      • Structs
        • Invite
        • SendInviteResult
    • firebase::messaging
      • Overview
      • Classes
        • Listener
      • Structs
        • Message
        • Notification
    • firebase::remote_config
      • Overview
      • Structs
        • ConfigInfo
        • ConfigKeyValue
        • ValueInfo
    • firebase::storage
      • Overview
      • Classes
        • Controller
        • Listener
        • Metadata
        • Storage
        • StorageReference
    • Modules
      • Analytics Events
      • Analytics Parameters
      • Analytics User Properties
    • Namespaces
      • google_play_services
  • Unity
    • Overview
    • Firebase
      • Overview
      • Classes
        • AppOptions
        • FirebaseApp
        • FirebaseException
        • InitializationException
        • UnityHttpRequest
    • Firebase.Analytics
      • Overview
      • Classes
        • FirebaseAnalytics
        • Parameter
    • Firebase.Auth
      • Overview
      • Classes
        • Credential
        • EmailAuthProvider
        • FacebookAuthProvider
        • FetchProvidersResult
        • FirebaseAuth
        • FirebaseUser
        • GitHubAuthProvider
        • GoogleAuthProvider
        • TwitterAuthProvider
        • UserProfile
      • Interfaces
        • IUserInfo
    • Firebase.Database
      • Overview
      • Classes
        • ChildChangedEventArgs
        • DatabaseError
        • DatabaseException
        • DatabaseReference
        • DataSnapshot
        • FirebaseDatabase
        • MutableData
        • OnDisconnect
        • Query
        • ServerValue
        • TransactionResult
        • ValueChangedEventArgs
    • Firebase.Invites
      • Overview
      • Classes
        • FirebaseInvites
        • Invite
        • InviteErrorReceivedEventArgs
        • InviteReceivedEventArgs
        • SendInviteResult
    • Firebase.Messaging
      • Overview
      • Classes
        • FirebaseMessage
        • FirebaseMessaging
        • FirebaseNotification
        • MessageReceivedEventArgs
        • TokenReceivedEventArgs
    • Firebase.RemoteConfig
      • Overview
      • Classes
        • ConfigInfo
        • FirebaseRemoteConfig
      • Structs
        • ConfigSettings
        • ConfigValue
    • Firebase.Storage
      • Overview
      • Classes
        • DownloadState
        • FirebaseStorage
        • MetadataChange
        • StorageException
        • StorageMetadata
        • StorageProgress< T >
        • StorageReference
        • UploadState
    • System.Threading.Tasks
      • Overview
      • Classes
        • Task
        • Task< T >
    • Namespaces
      • System
      • System.Threading
    • Related Pages
      • Deprecated List
  • REST
    • Realtime Database
    • Realtime Database User Auth
  • Security
    • Database Rules
    • Database Regular Expressions
    • Storage Rules
  • FCM App Server Protocol
    • HTTP Server Protocol
    • XMPP Server Protocol
  • App Indexing
    • Refine Indexing with noindex.xml
    • Common Builders for Indexable Objects
    • Android API for App Indexing
  • Dynamic Links
    • Short Links API
  • Hosting
    • Deployment Configuration
  • Gradle
    • Google Services Gradle Plugin
  • API Reference
  • CLI Reference
    • Overview
    • auth:import
  • iOS
    • FirebaseCore
    • Classes
      • Overview
      • FIRAnalyticsConfiguration
      • FIRApp
      • FIRConfiguration
      • FIROptions
    • Enums
      • Overview
      • FIRLogLevel
    • Type Definitions
      • Overview
      • FIRAppVoidBoolCallback
    • FirebaseAnalytics
    • Classes
      • Overview
      • FIRAnalytics
    • Constants
      • Overview
      • kFIREventAddPaymentInfo
      • kFIREventAddToCart
      • kFIREventAddToWishlist
      • kFIREventAppOpen
      • kFIREventBeginCheckout
      • kFIREventEarnVirtualCurrency
      • kFIREventEcommercePurchase
      • kFIREventGenerateLead
      • kFIREventJoinGroup
      • kFIREventLevelUp
      • kFIREventLogin
      • kFIREventPostScore
      • kFIREventPresentOffer
      • kFIREventPurchaseRefund
      • kFIREventSearch
      • kFIREventSelectContent
      • kFIREventShare
      • kFIREventSignUp
      • kFIREventSpendVirtualCurrency
      • kFIREventTutorialBegin
      • kFIREventTutorialComplete
      • kFIREventUnlockAchievement
      • kFIREventViewItem
      • kFIREventViewItemList
      • kFIREventViewSearchResults
      • kFIRParameterAchievementID
      • kFIRParameterCharacter
      • kFIRParameterContentType
      • kFIRParameterCoupon
      • kFIRParameterCurrency
      • kFIRParameterDestination
      • kFIRParameterEndDate
      • kFIRParameterFlightNumber
      • kFIRParameterGroupID
      • kFIRParameterItemCategory
      • kFIRParameterItemID
      • kFIRParameterItemLocationID
      • kFIRParameterItemName
      • kFIRParameterLevel
      • kFIRParameterLocation
      • kFIRParameterNumberOfNights
      • kFIRParameterNumberOfPassengers
      • kFIRParameterNumberOfRooms
      • kFIRParameterOrigin
      • kFIRParameterPrice
      • kFIRParameterQuantity
      • kFIRParameterScore
      • kFIRParameterSearchTerm
      • kFIRParameterShipping
      • kFIRParameterSignUpMethod
      • kFIRParameterStartDate
      • kFIRParameterTax
      • kFIRParameterTransactionID
      • kFIRParameterTravelClass
      • kFIRParameterValue
      • kFIRParameterVirtualCurrencyName
      • kFIRUserPropertySignUpMethod
    • FirebaseAppIndexing
    • Classes
      • Overview
      • FIRAppIndexing
    • FirebaseAuth
    • Classes
      • Overview
      • FIRActionCodeInfo
      • FIRAuth
      • FIRAuthCredential
      • FIRAuthErrors
      • FIREmailPasswordAuthProvider
      • FIRFacebookAuthProvider
      • FIRGitHubAuthProvider
      • FIRGoogleAuthProvider
      • FIRTwitterAuthProvider
      • FIRUser
      • FIRUserProfileChangeRequest
    • Constants
      • Overview
      • FIRAuthErrorDomain
      • FIRAuthErrorNameKey
      • FIRAuthStateDidChangeNotification
      • FIREmailPasswordAuthProviderID
      • FIRFacebookAuthProviderID
      • FIRGitHubAuthProviderID
      • FIRGoogleAuthProviderID
      • FIRTwitterAuthProviderID
      • FirebaseAuthVersionNumber
      • FirebaseAuthVersionString
    • Enums
      • Overview
      • FIRActionCodeOperation
      • FIRActionDataKey
      • FIRAuthErrorCode
    • Protocols
      • Overview
      • FIRUserInfo
    • Type Definitions
      • Overview
      • FIRApplyActionCodeCallback
      • FIRAuthResultCallback
      • FIRAuthStateDidChangeListenerBlock
      • FIRAuthStateDidChangeListenerHandle
      • FIRAuthTokenCallback
      • FIRCheckActionCodeCallBack
      • FIRConfirmPasswordResetCallback
      • FIRProviderQueryCallback
      • FIRSendEmailVerificationCallback
      • FIRSendPasswordResetCallback
      • FIRUserProfileChangeCallback
      • FIRVerifyPasswordResetCodeCallback
    • FirebaseDatabase
    • Classes
      • Overview
      • FIRDataSnapshot
      • FIRDatabase
      • FIRDatabaseQuery
      • FIRDatabaseReference
      • FIRMutableData
      • FIRServerValue
      • FIRTransactionResult
    • Enums
      • Overview
      • FIRDataEventType
    • Type Definitions
      • Overview
      • FIRDatabaseHandle
    • FirebaseDynamicLinks
    • Classes
      • Overview
      • FIRDynamicLink
      • FIRDynamicLinks
    • Enums
      • Overview
      • FIRDynamicLinkMatchConfidence
    • Type Definitions
      • Overview
      • FIRDynamicLinkResolverHandler
      • FIRDynamicLinkUniversalLinkHandler
    • FirebaseInstanceID
    • Classes
      • Overview
      • FIRInstanceID
    • Constants
      • Overview
      • kFIRInstanceIDScopeFirebaseMessaging
      • kFIRInstanceIDTokenRefreshNotification
    • Enums
      • Overview
      • FIRInstanceIDAPNSTokenType
      • FIRInstanceIDError
    • Type Definitions
      • Overview
      • FIRInstanceIDDeleteHandler
      • FIRInstanceIDDeleteTokenHandler
      • FIRInstanceIDHandler
      • FIRInstanceIDTokenHandler
    • FirebaseInvites
    • Classes
      • Overview
      • FIRInvites
      • FIRInvitesTargetApplication
      • FIRReceivedInvite
    • Constants
      • Overview
      • kFIRInvitesErrorDomain
    • Enums
      • Overview
      • FIRInvitesErrorCode
      • FIRReceivedInviteMatchType
    • Protocols
      • Overview
      • FIRInviteBuilder
      • FIRInviteDelegate
    • FirebaseMessaging
    • Classes
      • Overview
      • FIRMessaging
      • FIRMessagingMessageInfo
      • FIRMessagingRemoteMessage
    • Constants
      • Overview
      • FIRMessagingMessagesDeletedNotification
      • FIRMessagingSendErrorNotification
      • FIRMessagingSendSuccessNotification
    • Enums
      • Overview
      • FIRMessagingError
      • FIRMessagingMessageStatus
    • Protocols
      • Overview
      • FIRMessagingDelegate
    • Type Definitions
      • Overview
      • FIRMessagingConnectCompletion
    • FirebaseCrash
    • Functions
      • Overview
      • FIRCrashLog
      • FIRCrashLogv
      • FIRCrashMessage
      • FIRCrashNSLog
      • FIRCrashNSLogv
    • FirebaseRemoteConfig
    • Classes
      • Overview
      • FIRRemoteConfig
      • FIRRemoteConfigSettings
      • FIRRemoteConfigValue
    • Constants
      • Overview
      • FIRNamespaceGoogleMobilePlatform
      • FIRRemoteConfigErrorDomain
      • FIRRemoteConfigThrottledEndTimeInSecondsKey
    • Enums
      • Overview
      • FIRRemoteConfigError
      • FIRRemoteConfigFetchStatus
      • FIRRemoteConfigSource
    • Type Definitions
      • Overview
      • FIRRemoteConfigFetchCompletion
    • FirebaseStorage
    • Classes
      • Overview
      • FIRStorage
      • FIRStorageDownloadTask
      • FIRStorageMetadata
      • FIRStorageObservableTask
      • FIRStorageReference
      • FIRStorageTask
      • FIRStorageTaskSnapshot
      • FIRStorageUploadTask
    • Constants
      • Overview
      • FIRStorageErrorDomain
      • FirebaseStorageVersionString
    • Enums
      • Overview
      • FIRStorageErrorCode
      • FIRStorageTaskStatus
    • Protocols
      • Overview
      • FIRStorageTaskManagement
    • Type Definitions
      • Overview
      • FIRStorageHandle
      • FIRStorageVoidDataError
      • FIRStorageVoidError
      • FIRStorageVoidMetadata
      • FIRStorageVoidMetadataError
      • FIRStorageVoidSnapshot
      • FIRStorageVoidURLError
    • GoogleMobileAds
    • Classes
      • Overview
      • DFPBannerView
      • DFPCustomRenderedAd
      • DFPInterstitial
      • DFPRequest
      • GADAdChoicesView
      • GADAdLoader
      • GADAdLoaderOptions
      • GADAdReward
      • GADBannerView
      • GADCorrelator
      • GADCorrelatorAdLoaderOptions
      • GADCustomEventExtras
      • GADCustomEventRequest
      • GADDebugOptionsViewController
      • GADDefaultInAppPurchase
      • GADDynamicHeightSearchRequest
      • GADExtras
      • GADInAppPurchase
      • GADInterstitial
      • GADMediaView
      • GADMediatedNativeAdNotificationSource
      • GADMobileAds
      • GADNativeAd
      • GADNativeAdImage
      • GADNativeAdImageAdLoaderOptions
      • GADNativeAdViewAdOptions
      • GADNativeAppInstallAd
      • GADNativeAppInstallAdView
      • GADNativeContentAd
      • GADNativeContentAdView
      • GADNativeCustomTemplateAd
      • GADNativeExpressAdView
      • GADRequest
      • GADRequestError
      • GADRewardBasedVideoAd
      • GADSearchBannerView
      • GADSearchRequest
      • GADVideoController
      • GADVideoOptions
    • Constants
      • Overview
      • GADCustomEventParametersServer
      • GoogleMobileAdsVersionString
      • kDFPSimulatorID
      • kGADAdLoaderAdTypeNativeAppInstall
      • kGADAdLoaderAdTypeNativeContent
      • kGADAdLoaderAdTypeNativeCustomTemplate
      • kGADAdSizeBanner
      • kGADAdSizeFluid
      • kGADAdSizeFullBanner
      • kGADAdSizeInvalid
      • kGADAdSizeLargeBanner
      • kGADAdSizeLeaderboard
      • kGADAdSizeMediumRectangle
      • kGADAdSizeSkyscraper
      • kGADAdSizeSmartBannerLandscape
      • kGADAdSizeSmartBannerPortrait
      • kGADErrorDomain
      • kGADSimulatorID
    • Enums
      • Overview
      • GADAdChoicesPosition
      • GADErrorCode
      • GADGender
      • GADInAppPurchaseStatus
      • GADMBannerAnimationType
      • GADNativeAdImageAdLoaderOptionsOrientation
      • GADSearchBorderType
      • GADSearchCallButtonColor
    • Protocols
      • Overview
      • DFPCustomRenderedBannerViewDelegate
      • DFPCustomRenderedInterstitialDelegate
      • GADAdDelegate
      • GADAdLoaderDelegate
      • GADAdNetworkExtras
      • GADAdSizeDelegate
      • GADAppEventDelegate
      • GADBannerViewDelegate
      • GADCustomEventBanner
      • GADCustomEventBannerDelegate
      • GADCustomEventInterstitial
      • GADCustomEventInterstitialDelegate
      • GADCustomEventNativeAd
      • GADCustomEventNativeAdDelegate
      • GADDebugOptionsViewControllerDelegate
      • GADDefaultInAppPurchaseDelegate
      • GADInAppPurchaseDelegate
      • GADInterstitialDelegate
      • GADMAdNetworkAdapter
      • GADMAdNetworkConnector
      • GADMRewardBasedVideoAdNetworkAdapter
      • GADMRewardBasedVideoAdNetworkConnector
      • GADMediatedNativeAd
      • GADMediatedNativeAdDelegate
      • GADMediatedNativeAppInstallAd
      • GADMediatedNativeContentAd
      • GADMediationAdRequest
      • GADNativeAdDelegate
      • GADNativeAppInstallAdLoaderDelegate
      • GADNativeContentAdLoaderDelegate
      • GADNativeCustomTemplateAdLoaderDelegate
      • GADNativeExpressAdViewDelegate
      • GADRewardBasedVideoAdDelegate
      • GADVideoControllerDelegate
    • Type Definitions
      • Overview
      • GADAdSize
    • Functions
      • Overview
      • CGSizeFromGADAdSize
      • GADAdSizeEqualToSize
      • GADAdSizeFromCGSize
      • GADAdSizeFromNSValue
      • GADAdSizeFullWidthLandscapeWithHeight
      • GADAdSizeFullWidthPortraitWithHeight
      • GADAdSizeIsFluid
      • IsGADAdSizeValid
      • NSStringFromGADAdSize
      • NSValueFromGADAdSize
    • Structs
      • Overview
      • GADAdSize
  • Android
    • Package Summary
    • ads
      • Overview
      • AdListener
      • AdLoader
        • Overview
        • Builder
      • AdRequest
        • Overview
        • Builder
      • AdSize
      • AdView
      • Correlator
      • InterstitialAd
      • MobileAds
        • Overview
        • Settings
      • NativeExpressAdView
      • VideoController
        • Overview
        • VideoLifecycleCallbacks
      • VideoOptions
        • Overview
        • Builder
    • ads.doubleclick
      • Overview
      • AppEventListener
      • CustomRenderedAd
      • OnCustomRenderedAdLoadedListener
      • PublisherAdRequest
        • Overview
        • Builder
      • PublisherAdView
      • PublisherInterstitialAd
    • ads.formats
      • Overview
      • MediaView
      • NativeAd
        • Overview
        • Image
      • NativeAdOptions
        • Overview
        • AdChoicesPlacement
        • Builder
      • NativeAdView
      • NativeAppInstallAd
        • Overview
        • OnAppInstallAdLoadedListener
      • NativeAppInstallAdView
      • NativeContentAd
        • Overview
        • OnContentAdLoadedListener
      • NativeContentAdView
      • NativeCustomTemplateAd
        • Overview
        • OnCustomClickListener
        • OnCustomTemplateAdLoadedListener
    • ads.identifier
      • Overview
      • AdvertisingIdClient
        • Overview
        • Info
    • ads.mediation
      • Overview
      • MediationAdRequest
      • MediationAdapter
      • MediationBannerAdapter
      • MediationBannerListener
      • MediationInterstitialAdapter
      • MediationInterstitialListener
      • MediationNativeAdapter
      • MediationNativeListener
      • NativeAdMapper
      • NativeAppInstallAdMapper
      • NativeContentAdMapper
      • NativeMediationAdRequest
      • NetworkExtras
      • OnContextChangedListener
    • ads.mediation.admob
      • Overview
      • AdMobExtras
    • ads.mediation.customevent
      • Overview
      • CustomEvent
      • CustomEventBanner
      • CustomEventBannerListener
      • CustomEventExtras
      • CustomEventInterstitial
      • CustomEventInterstitialListener
      • CustomEventListener
      • CustomEventNative
      • CustomEventNativeListener
    • ads.purchase
      • Overview
      • InAppPurchase
      • InAppPurchaseListener
      • InAppPurchaseResult
      • PlayStorePurchaseListener
    • ads.reward
      • Overview
      • RewardItem
      • RewardedVideoAd
      • RewardedVideoAdListener
    • ads.reward.mediation
      • Overview
      • MediationRewardedVideoAdAdapter
      • MediationRewardedVideoAdListener
    • ads.search
      • Overview
      • DynamicHeightSearchAdRequest
        • Overview
        • Builder
      • SearchAdRequest
        • Overview
        • Builder
      • SearchAdView
    • appindexing
      • Overview
      • Action
        • Overview
        • Builder
      • AndroidAppUri
      • AppIndex
      • AppIndexApi
        • Overview
        • ActionResult
        • AppIndexingLink
      • Thing
        • Overview
        • Builder
    • appinvite
      • Overview
      • AppInvite
      • AppInviteApi
      • AppInviteInvitation
        • Overview
        • AppInviteInvitation.IntentBuilder
          • Overview
          • PlatformMode
      • AppInviteInvitationResult
      • AppInviteReferral
    • measurement
      • Overview
      • AppMeasurement
      • AppMeasurementContentProvider
      • AppMeasurementInstallReferrerReceiver
      • AppMeasurementReceiver
      • AppMeasurementService
    • firebase
      • Overview
      • FirebaseApiNotAvailableException
      • FirebaseApp
      • FirebaseException
      • FirebaseNetworkException
      • FirebaseOptions
        • Overview
        • Builder
      • FirebaseTooManyRequestsException
    • firebase.analytics
      • Overview
      • FirebaseAnalytics
        • Overview
        • Event
        • Param
        • UserProperty
    • firebase.appindexing
      • Overview
      • Action
        • Overview
        • Action.Builder
          • Overview
          • StatusType
        • Action.Metadata
          • Overview
          • Builder
      • FirebaseAppIndex
      • FirebaseAppIndexingException
      • FirebaseAppIndexingInvalidArgumentException
      • FirebaseAppIndexingTooManyArgumentsException
      • FirebaseUserActions
      • Indexable
        • Overview
        • Builder
        • Indexable.Metadata
          • Overview
          • Builder
    • firebase.appindexing.builders
      • Overview
      • Actions
      • ConversationBuilder
      • DigitalDocumentBuilder
      • DigitalDocumentPermissionBuilder
      • IndexableBuilder
      • Indexables
      • MessageBuilder
      • MusicAlbumBuilder
      • MusicGroupBuilder
      • MusicPlaylistBuilder
      • MusicRecordingBuilder
      • PersonBuilder
    • firebase.auth
      • Overview
      • ActionCodeResult
        • Overview
        • ActionDataKey
        • Operation
      • AuthCredential
      • AuthResult
      • EmailAuthCredential
      • EmailAuthProvider
      • FacebookAuthCredential
      • FacebookAuthProvider
      • FirebaseAuth
        • Overview
        • AuthStateListener
      • FirebaseAuthActionCodeException
      • FirebaseAuthException
      • FirebaseAuthInvalidCredentialsException
      • FirebaseAuthInvalidUserException
      • FirebaseAuthProvider
      • FirebaseAuthRecentLoginRequiredException
      • FirebaseAuthUserCollisionException
      • FirebaseAuthWeakPasswordException
      • FirebaseUser
      • GetTokenResult
      • GithubAuthCredential
      • GithubAuthProvider
      • GoogleAuthCredential
      • GoogleAuthProvider
      • ProviderQueryResult
      • TwitterAuthCredential
      • TwitterAuthProvider
      • UserInfo
      • UserProfileChangeRequest
        • Overview
        • Builder
    • firebase.crash
      • Overview
      • FirebaseCrash
    • firebase.database
      • Overview
      • ChildEventListener
      • DataSnapshot
      • DatabaseError
      • DatabaseException
      • DatabaseReference
        • Overview
        • CompletionListener
      • Exclude
      • FirebaseDatabase
      • GenericTypeIndicator
      • IgnoreExtraProperties
      • Logger
        • Overview
        • Level
      • MutableData
      • OnDisconnect
      • PropertyName
      • Query
      • ServerValue
      • ThrowOnExtraProperties
      • Transaction
        • Overview
        • Handler
        • Result
      • ValueEventListener
    • firebase.iid
      • Overview
      • FirebaseInstanceId
      • FirebaseInstanceIdInternalReceiver
      • FirebaseInstanceIdReceiver
      • FirebaseInstanceIdService
    • firebase.messaging
      • Overview
      • FirebaseMessaging
      • FirebaseMessagingService
      • RemoteMessage
        • Overview
        • Builder
        • Notification
      • SendException
    • firebase.provider
      • Overview
      • FirebaseInitProvider
    • firebase.remoteconfig
      • Overview
      • FirebaseRemoteConfig
      • FirebaseRemoteConfigException
      • FirebaseRemoteConfigFetchException
      • FirebaseRemoteConfigFetchThrottledException
      • FirebaseRemoteConfigInfo
      • FirebaseRemoteConfigSettings
        • Overview
        • Builder
      • FirebaseRemoteConfigValue
    • firebase.storage
      • Overview
      • CancellableTask
      • ControllableTask
      • FileDownloadTask
        • Overview
        • TaskSnapshot
      • FirebaseStorage
      • OnPausedListener
      • OnProgressListener
      • StorageException
        • Overview
        • ErrorCode
      • StorageMetadata
        • Overview
        • Builder
      • StorageReference
      • StorageTask
        • Overview
        • ProvideError
      • StreamDownloadTask
        • Overview
        • StreamProcessor
        • TaskSnapshot
      • UploadTask
        • Overview
        • TaskSnapshot
  • Web
    • Overview
    • ActionCodeInfo
    • App
    • Auth
    • AuthCredential
    • AuthProvider
    • Database
    • DataSnapshot
    • EmailAuthProvider
    • Error
    • FacebookAuthProvider
    • firebase
    • firebase.app
    • firebase.auth
    • firebase.database
    • firebase.database.ServerValue
    • firebase.messaging
    • firebase.storage
    • FirebaseError
    • FullMetadata
    • GithubAuthProvider
    • GoogleAuthProvider
    • Messaging
    • OnDisconnect
    • Promise
    • Query
    • storage.Reference
    • database.Reference
    • SettableMetadata
    • Storage
    • Thenable
    • ThenableReference
    • TwitterAuthProvider
    • UploadMetadata
    • UploadTask
    • UploadTaskSnapshot
    • User
    • UserInfo
    • Index of all
  • Node.js (Client)
    • Overview
    • ActionCodeInfo
    • App
    • Auth
    • AuthCredential
    • AuthProvider
    • Database
    • DataSnapshot
    • EmailAuthProvider
    • Error
    • FacebookAuthProvider
    • firebase
    • firebase.app
    • firebase.auth
    • firebase.database
    • firebase.database.ServerValue
    • FirebaseError
    • GithubAuthProvider
    • GoogleAuthProvider
    • OnDisconnect
    • Promise
    • Query
    • Reference
    • Thenable
    • ThenableReference
    • TwitterAuthProvider
    • User
    • UserInfo
    • Index of all
  • Node.js (Admin)
    • Overview
    • admin
    • admin.auth
    • admin.credential
    • admin.database
    • admin.messaging
    • App
    • Auth
    • Database
    • DataMessagePayload
    • DataSnapshot
    • FirebaseError
    • Messaging
    • MessagingConditionResponse
    • MessagingDeviceGroupResponse
    • MessagingDeviceResult
    • MessagingDevicesResponse
    • MessagingOptions
    • MessagingPayload
    • MessagingTopicResponse
    • NotificationMessagePayload
    • OnDisconnect
    • Query
    • Reference
    • ThenableReference
    • UserInfo
    • UserMetadata
    • UserRecord
    • Index of all
  • Java (Admin)
    • com.google.firebase
      • Overview
      • FirebaseApp
      • FirebaseException
      • FirebaseOptions
        • Overview
        • Builder
    • com.google.firebase.auth
      • Overview
      • FirebaseAuth
      • FirebaseAuthException
      • FirebaseCredential
      • FirebaseCredentials
      • FirebaseToken
    • com.google.firebase.database
      • Overview
      • ChildEventListener
      • DataSnapshot
      • DatabaseError
      • DatabaseException
      • DatabaseReference
        • Overview
        • CompletionListener
      • Exclude
      • FirebaseDatabase
      • GenericTypeIndicator
      • IgnoreExtraProperties
      • Logger
        • Overview
        • Level
      • MutableData
      • OnDisconnect
      • PropertyName
      • Query
      • ServerValue
      • ThrowOnExtraProperties
      • Transaction
        • Overview
        • Handler
        • Result
      • ValueEventListener
    • com.google.firebase.tasks
      • Overview
      • Continuation
      • OnCompleteListener
      • OnFailureListener
      • OnSuccessListener
      • RuntimeExecutionException
      • Task
      • TaskCompletionSource
      • TaskExecutors
      • Tasks
  • C++
    • Overview
    • firebase
      • Overview
      • Classes
        • App
        • AppOptions
        • Future
        • FutureBase
        • ModuleInitializer
        • Variant
    • firebase::admob
      • Overview
      • Classes
        • BannerView
        • BannerView::Listener
        • InterstitialAd
        • InterstitialAd::Listener
        • NativeExpressAdView
        • NativeExpressAdView::Listener
      • Structs
        • AdRequest
        • AdSize
        • BoundingBox
        • KeyValuePair
    • firebase::admob::rewarded_video
      • Overview
      • Classes
        • Listener
        • PollableRewardListener
      • Structs
        • RewardItem
    • firebase::analytics
      • Overview
      • Structs
        • Parameter
    • firebase::auth
      • Overview
      • Classes
        • Auth
        • Auth::FetchProvidersResult
        • AuthStateListener
        • Credential
        • EmailAuthProvider
        • FacebookAuthProvider
        • GitHubAuthProvider
        • GoogleAuthProvider
        • TwitterAuthProvider
        • User
        • User::UserProfile
        • UserInfoInterface
    • firebase::database
      • Overview
      • Classes
        • ChildListener
        • Database
        • DatabaseReference
        • DataSnapshot
        • DisconnectionHandler
        • MutableData
        • Query
        • ValueListener
    • firebase::invites
      • Overview
      • Classes
        • Listener
      • Structs
        • Invite
        • SendInviteResult
    • firebase::messaging
      • Overview
      • Classes
        • Listener
      • Structs
        • Message
        • Notification
    • firebase::remote_config
      • Overview
      • Structs
        • ConfigInfo
        • ConfigKeyValue
        • ValueInfo
    • firebase::storage
      • Overview
      • Classes
        • Controller
        • Listener
        • Metadata
        • Storage
        • StorageReference
    • Modules
      • Analytics Events
      • Analytics Parameters
      • Analytics User Properties
    • Namespaces
      • google_play_services
  • Unity
    • Overview
    • Firebase
      • Overview
      • Classes
        • AppOptions
        • FirebaseApp
        • FirebaseException
        • InitializationException
        • UnityHttpRequest
    • Firebase.Analytics
      • Overview
      • Classes
        • FirebaseAnalytics
        • Parameter
    • Firebase.Auth
      • Overview
      • Classes
        • Credential
        • EmailAuthProvider
        • FacebookAuthProvider
        • FetchProvidersResult
        • FirebaseAuth
        • FirebaseUser
        • GitHubAuthProvider
        • GoogleAuthProvider
        • TwitterAuthProvider
        • UserProfile
      • Interfaces
        • IUserInfo
    • Firebase.Database
      • Overview
      • Classes
        • ChildChangedEventArgs
        • DatabaseError
        • DatabaseException
        • DatabaseReference
        • DataSnapshot
        • FirebaseDatabase
        • MutableData
        • OnDisconnect
        • Query
        • ServerValue
        • TransactionResult
        • ValueChangedEventArgs
    • Firebase.Invites
      • Overview
      • Classes
        • FirebaseInvites
        • Invite
        • InviteErrorReceivedEventArgs
        • InviteReceivedEventArgs
        • SendInviteResult
    • Firebase.Messaging
      • Overview
      • Classes
        • FirebaseMessage
        • FirebaseMessaging
        • FirebaseNotification
        • MessageReceivedEventArgs
        • TokenReceivedEventArgs
    • Firebase.RemoteConfig
      • Overview
      • Classes
        • ConfigInfo
        • FirebaseRemoteConfig
      • Structs
        • ConfigSettings
        • ConfigValue
    • Firebase.Storage
      • Overview
      • Classes
        • DownloadState
        • FirebaseStorage
        • MetadataChange
        • StorageException
        • StorageMetadata
        • StorageProgress< T >
        • StorageReference
        • UploadState
    • System.Threading.Tasks
      • Overview
      • Classes
        • Task
        • Task< T >
    • Namespaces
      • System
      • System.Threading
    • Related Pages
      • Deprecated List
  • REST
    • Realtime Database
    • Realtime Database User Auth
  • Security
    • Database Rules
    • Database Regular Expressions
    • Storage Rules
  • FCM App Server Protocol
    • HTTP Server Protocol
    • XMPP Server Protocol
  • App Indexing
    • Refine Indexing with noindex.xml
    • Common Builders for Indexable Objects
    • Android API for App Indexing
  • Dynamic Links
    • Short Links API
  • Hosting
    • Deployment Configuration
  • Gradle
    • Google Services Gradle Plugin
  • Firebase
  • Docs
  • Reference

Interface: DataMessagePayload

admin.messaging.DataMessagePayload

interface   static

Interface representing a data message payload. Data messages let developers send up to 4KB of custom key-value pairs. The keys and values must both be strings. Keys can be any custom string, except for the following reserved strings:

  • "from"
  • Anything starting with "google.".

See Defining the message payload for code samples and detailed documentation.

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

Last updated February 2, 2017.

  • Learn

    • Guides
    • Reference
    • Samples
    • Libraries
    • GitHub
  • Stay Connected

    • Blog
    • Dev Summit
    • Facebook
    • Google+
    • Twitter
    • YouTube
  • Support

    • Contact Support
    • Stack Overflow
    • Google Group
    • Release Notes
    • Known Issues
    • Legacy Console
    • Legacy Documentation
    • Android
    • Chrome
    • Firebase
    • Google Cloud Platform
    • All Products
TermsPrivacy

Send feedback about...

This page
Documentation feedback
Firebase
Firebase
Product feedback
Need help? Visit our support page.