FirebaseAuth Framework Reference

    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.

      Declaration

      Objective-C

      typedefvoid(^FIRUserUpdateCallback)(NSError*_Nullable)
    • @typedef FIRAuthStateDidChangeListenerHandle @brief The type of handle returned byAuth.addAuthStateDidChangeListener(_:).

      Declaration

      Objective-C

      typedefid<NSObject>FIRAuthStateDidChangeListenerHandle
    • @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.

      Declaration

      Objective-C

      typedefvoid(^FIRAuthStateDidChangeListenerBlock)(FIRAuth*_Nonnull,FIRUser*_Nullable)
    • @typedef FIRIDTokenDidChangeListenerHandle @brief The type of handle returned byAuth.addIDTokenDidChangeListener(_:).

      Declaration

      Objective-C

      typedefid<NSObject>FIRIDTokenDidChangeListenerHandle
    • @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.

      Declaration

      Objective-C

      typedefvoid(^FIRIDTokenDidChangeListenerBlock)(FIRAuth*_Nonnull,FIRUser*_Nullable)
    • @typedef FIRAuthDataResultCallback @brief The type of block invoked when sign-in related events complete.

      -parameter:authResultOptionally;Resultofsign-inrequestcontainingboththeuserandtheadditionaluserinfoassociatedwiththeuser.-parameter:errorOptionally;theerrorwhichoccurred-orniliftherequestwassuccessful.

      Declaration

      Objective-C

      typedefvoid(^FIRAuthDataResultCallback)(FIRAuthDataResult*_Nullable,NSError*_Nullable)
    • @typedef FIRAuthResultCallback @brief The type of block invoked when sign-in related events complete.

      -parameter:userOptionally;thesignedinuser,ifany.-parameter:errorOptionally;ifanerroroccurs,thisistheNSErrorobjectthatdescribestheproblem.Settonilotherwise.

      Declaration

      Objective-C

      typedefvoid(^FIRAuthResultCallback)(FIRUser*_Nullable,NSError*_Nullable)
    • @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.

      Declaration

      Objective-C

      typedefvoid(^FIRProviderQueryCallback)(NSArray<NSString*>*_Nullable,NSError*_Nullable)
    • @typedef FIRSignInMethodQueryCallback @brief The type of block invoked when a list of sign-in methods for a given email address is requested.

      Declaration

      Objective-C

      typedefvoid(^FIRSignInMethodQueryCallback)(NSArray<NSString*>*_Nullable,NSError*_Nullable)
    • @typedef FIRSendPasswordResetCallback @brief The type of block invoked when sending a password reset email.

      -parameter:errorOptionally;ifanerroroccurs,thisistheNSErrorobjectthatdescribestheproblem.Settonilotherwise.

      Declaration

      Objective-C

      typedefvoid(^FIRSendPasswordResetCallback)(NSError*_Nullable)
    • @typedef FIRSendSignInLinkToEmailCallback @brief The type of block invoked when sending an email sign-in link email.

      Declaration

      Objective-C

      typedefvoid(^FIRSendSignInLinkToEmailCallback)(NSError*_Nullable)
    • @typedef FIRConfirmPasswordResetCallback @brief The type of block invoked when performing a password reset.

      -parameter:errorOptionally;ifanerroroccurs,thisistheNSErrorobjectthatdescribestheproblem.Settonilotherwise.

      Declaration

      Objective-C

      typedefvoid(^FIRConfirmPasswordResetCallback)(NSError*_Nullable)
    • @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.

      Declaration

      Objective-C

      typedefvoid(^FIRVerifyPasswordResetCodeCallback)(NSString*_Nullable,NSError*_Nullable)
    • @typedef FIRApplyActionCodeCallback @brief The type of block invoked when applying an action code.

      -parameter:errorOptionally;ifanerroroccurs,thisistheNSErrorobjectthatdescribestheproblem.Settonilotherwise.

      Declaration

      Objective-C

      typedefvoid(^FIRApplyActionCodeCallback)(NSError*_Nullable)
    • Undocumented

      Declaration

      Objective-C

      typedefvoid(^FIRAuthVoidErrorCallback)(NSError*_Nullable)
    • @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.

      Declaration

      Objective-C

      typedefvoid(^FIRAuthCredentialCallback)(FIRAuthCredential*_Nullable,NSError*_Nullable)
    • @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.

      Declaration

      Objective-C

      typedefvoid(^FIRGameCenterCredentialCallback)(FIRAuthCredential*_Nullable,NSError*_Nullable)
    • @typedef FIRMultiFactorSessionCallback @brief The callback that triggered when a developer callsgetSessionWithCompletion. This type is available on iOS only. - parameter: session The multi factor session returned, if any. - parameter: error The error which occurred, if any.

      Declaration

      Objective-C

      typedefvoid(^FIRMultiFactorSessionCallback)(FIRMultiFactorSession*_Nullable,NSError*_Nullable)
    • @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.

      Declaration

      Objective-C

      typedefvoid(^FIRVerificationResultCallback)(NSString*_Nullable,NSError*_Nullable)
    • Undocumented

      Declaration

      Objective-C

      typedefvoid(^FIRAuthRecaptchaTokenCallback)(NSString*_Nonnulltoken,NSError*_Nullableerror,BOOLlinked,BOOLrecaptchaActionCreated)

    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-01-15 UTC.