FirebaseAuth Framework Reference Stay organized with collections Save and categorize content based on your preferences.
Type Definitions
The following type definitions are available globally.
@typedef FIRUserUpdateCallback @brief The type of block invoked when a request to update the current user is completed.
@typedef FIRAuthStateDidChangeListenerHandle @brief The type of handle returned by
Auth.addAuthStateDidChangeListener(_:).Declaration
Swift
typealiasAuthStateDidChangeListenerHandle=anyNSObjectProtocol@typedef FIRAuthStateDidChangeListenerBlock @brief The type of block which can be registered as a listener for auth state did change events.
-parameter:authTheAuthobjectonwhichstatechangesoccurred.-parameter:userOptionally;thecurrentsignedinuser,ifany.@typedef FIRIDTokenDidChangeListenerHandle @brief The type of handle returned by
Auth.addIDTokenDidChangeListener(_:).Declaration
Swift
typealiasIDTokenDidChangeListenerHandle=anyNSObjectProtocol@typedef FIRIDTokenDidChangeListenerBlock @brief The type of block which can be registered as a listener for ID token did change events.
-parameter:authTheAuthobjectonwhichIDtokenchangesoccurred.-parameter:userOptionally;thecurrentsignedinuser,ifany.@typedef FIRAuthDataResultCallback @brief The type of block invoked when sign-in related events complete.
-parameter:authResultOptionally;Resultofsign-inrequestcontainingboththeuserandtheadditionaluserinfoassociatedwiththeuser.-parameter:errorOptionally;theerrorwhichoccurred-orniliftherequestwassuccessful.@typedef FIRAuthResultCallback @brief The type of block invoked when sign-in related events complete.
-parameter:userOptionally;thesignedinuser,ifany.-parameter:errorOptionally;ifanerroroccurs,thisistheNSErrorobjectthatdescribestheproblem.Settonilotherwise.@typedef FIRProviderQueryCallback @brief The type of block invoked when a list of identity providers for a given email address is requested.
-parameter:providersOptionally;alistofprovideridentifiers,ifany.-see:GoogleAuthProviderIDetc.-parameter:errorOptionally;ifanerroroccurs,thisistheNSErrorobjectthatdescribestheproblem.Settonilotherwise.@typedef FIRSignInMethodQueryCallback @brief The type of block invoked when a list of sign-in methods for a given email address is requested.
@typedef FIRSendPasswordResetCallback @brief The type of block invoked when sending a password reset email.
-parameter:errorOptionally;ifanerroroccurs,thisistheNSErrorobjectthatdescribestheproblem.Settonilotherwise.@typedef FIRSendSignInLinkToEmailCallback @brief The type of block invoked when sending an email sign-in link email.
@typedef FIRConfirmPasswordResetCallback @brief The type of block invoked when performing a password reset.
-parameter:errorOptionally;ifanerroroccurs,thisistheNSErrorobjectthatdescribestheproblem.Settonilotherwise.@typedef FIRVerifyPasswordResetCodeCallback @brief The type of block invoked when verifying that an out of band code should be used to perform password reset.
-parameter:emailOptionally;theemailaddressoftheuserforwhichtheoutofbandcodeapplies.-parameter:errorOptionally;ifanerroroccurs,thisistheNSErrorobjectthatdescribestheproblem.Settonilotherwise.@typedef FIRApplyActionCodeCallback @brief The type of block invoked when applying an action code.
-parameter:errorOptionally;ifanerroroccurs,thisistheNSErrorobjectthatdescribestheproblem.Settonilotherwise.Undocumented
@typedef FIRAuthCredentialCallback @brief The type of block invoked when obtaining an auth credential. - parameter: credential The credential obtained. - parameter: error The error that occurred if any.
@typedef FIRGameCenterCredentialCallback @brief The type of block invoked when the Game Center credential code has finished. - parameter: credential On success, the credential will be provided, nil otherwise. - parameter: error On error, the error that occurred, nil otherwise.
@typedef FIRMultiFactorSessionCallback @brief The callback that triggered when a developer calls
getSessionWithCompletion. This type is available on iOS and macOS. - parameter: session The multi factor session returned, if any. - parameter: error The error which occurred, if any.@typedef FIRVerificationResultCallback @brief The type of block invoked when a request to send a verification code has finished. This type is available on iOS only.
-parameter:verificationIDOnsuccess,theverificationIDprovided,nilotherwise.-parameter:errorOnerror,theerrorthatoccurred,nilotherwise.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-27 UTC.