[ Web Proxy ]
URL:
Viewing: https://firebase.google.com/docs/reference/ios/firebaseauth/api/reference/Type-Definitions [Back]  [Original]

FirebaseAuth Framework Reference devsite/tools/jazzy/templates Skip to main content
Firebase [Firebase]

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.

    Declaration

    Objective-C

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

    Declaration

    Objective-C

    typedef id<NSObject> FIRAuthStateDidChangeListenerHandle
  • @typedef FIRAuthStateDidChangeListenerBlock @brief The type of block which can be registered as a listener for auth state did change events.

    - parameter: auth The Auth object on which state changes occurred.
    - parameter: user Optionally; the current signed in user, if any.
    

    Declaration

    Objective-C

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

    Declaration

    Objective-C

    typedef id<NSObject> FIRIDTokenDidChangeListenerHandle
  • @typedef FIRIDTokenDidChangeListenerBlock @brief The type of block which can be registered as a listener for ID token did change events.

    - parameter: auth The Auth object on which ID token changes occurred.
    - parameter: user Optionally; the current signed in user, if any.
    

    Declaration

    Objective-C

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

    - parameter: authResult Optionally; Result of sign-in request containing both the user and
       the additional user info associated with the user.
    - parameter: error Optionally; the error which occurred - or nil if the request was successful.
    

    Declaration

    Objective-C

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

    - parameter: user Optionally; the signed in user, if any.
    - parameter: error Optionally; if an error occurs, this is the NSError object that describes the
        problem. Set to nil otherwise.
    

    Declaration

    Objective-C

    typedef void (^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: providers Optionally; a list of provider identifiers, if any.
        - see: GoogleAuthProviderID etc.
    - parameter: error Optionally; if an error occurs, this is the NSError object that describes the
        problem. Set to nil otherwise.
    

    Declaration

    Objective-C

    typedef void (^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

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

    - parameter: error Optionally; if an error occurs, this is the NSError object that describes the
        problem. Set to nil otherwise.
    

    Declaration

    Objective-C

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

    Declaration

    Objective-C

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

    - parameter: error Optionally; if an error occurs, this is the NSError object that describes the
        problem. Set to nil otherwise.
    

    Declaration

    Objective-C

    typedef void (^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: email Optionally; the email address of the user for which the out of band code applies.
    - parameter: error Optionally; if an error occurs, this is the NSError object that describes the
        problem. Set to nil otherwise.
    

    Declaration

    Objective-C

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

    - parameter: error Optionally; if an error occurs, this is the NSError object that describes the
        problem. Set to nil otherwise.
    

    Declaration

    Objective-C

    typedef void (^FIRApplyActionCodeCallback)(NSError *_Nullable)
  • Undocumented

    Declaration

    Objective-C

    typedef void (^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

    typedef void (^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

    typedef void (^FIRGameCenterCredentialCallback)(FIRAuthCredential *_Nullable,
                                                    NSError *_Nullable)
  • @typedef FIRMultiFactorSessionCallback @brief The callback that triggered when a developer calls getSessionWithCompletion. 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

    typedef void (^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: verificationID On success, the verification ID provided, nil otherwise.
    - parameter: error On error, the error that occurred, nil otherwise.
    

    Declaration

    Objective-C

    typedef void (^FIRVerificationResultCallback)(NSString *_Nullable,
                                                  NSError *_Nullable)
  • Undocumented

    Declaration

    Objective-C

    typedef void (^FIRAuthRecaptchaTokenCallback)(NSString *_Nonnull token,
                                                  NSError *_Nullable error,
                                                  BOOL linked,
                                                  BOOL recaptchaActionCreated)

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

Last updated 2025-01-15 UTC.

[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-15 UTC."],[],[]]

Web Proxy Viewer  |  New URL  |  Original Page