FirebaseAuth Framework Reference

Constants

The following constants are available globally.

  • The name of the NSNotificationCenter notification which is posted when the auth state changes (for example, a new token has been produced, a user signs in or signs out). The object parameter of the notification is the sender Auth instance.

    Declaration

    Objective-C

    extern NS_SWIFT_NAME(AuthStateDidChange) const NSNotificationName
    FIRAuthStateDidChangeNotification

  • The Firebase Auth error domain.

    Declaration

    Objective-C

    extern NS_SWIFT_NAME(AuthErrorDomain) NSString *const FIRAuthErrorDomain

  • The name of the key for the error short string of an error code.

    Declaration

    Objective-C

    extern NS_SWIFT_NAME(AuthErrorUserInfoNameKey) NSString *const
    FIRAuthErrorUserInfoNameKey

  • Errors with one of the following three codes: - AuthErrorCodeAccountExistsWithDifferentCredential - AuthErrorCodeCredentialAlreadyInUse - AuthErrorCodeEmailAlreadyInUse may contain an NSError.userInfo dictinary object which contains this key. The value associated with this key is an NSString of the email address of the account that already exists.

    Declaration

    Objective-C

    extern NS_SWIFT_NAME(AuthErrorUserInfoEmailKey) NSString *const
    FIRAuthErrorUserInfoEmailKey

  • The key used to read the updated Auth credential from the userInfo dictionary of the NSError object returned. This is the updated auth credential the developer should use for recovery if applicable.

    Declaration

    Objective-C

    extern NS_SWIFT_NAME(AuthErrorUserInfoUpdatedCredentialKey) NSString *const
    FIRAuthErrorUserInfoUpdatedCredentialKey

  • The key used to read the MFA resolver from the userInfo dictionary of the NSError object returned when 2FA is required for sign-incompletion.

    Declaration

    Objective-C

    extern NS_SWIFT_NAME(AuthErrorUserInfoMultiFactorResolverKey) NSString *const
    FIRAuthErrorUserInfoMultiFactorResolverKey

  • A string constant identifying the email & password identity provider.

    Declaration

    Objective-C

    extern NS_SWIFT_NAME(EmailAuthProviderID) NSString *const FIREmailAuthProviderID

  • A string constant identifying the email-link sign-in method.

    Declaration

    Objective-C

    extern NS_SWIFT_NAME(EmailLinkAuthSignInMethod) NSString *const
    FIREmailLinkAuthSignInMethod

  • A string constant identifying the email & password sign-in method.

    Declaration

    Objective-C

    extern NS_SWIFT_NAME(EmailPasswordAuthSignInMethod) NSString *const
    FIREmailPasswordAuthSignInMethod

  • A string constant identifying the Facebook identity provider.

    Declaration

    Objective-C

    extern NS_SWIFT_NAME(FacebookAuthProviderID) NSString *const
    FIRFacebookAuthProviderID

  • A string constant identifying the Facebook sign-in method.

    Declaration

    Objective-C

    extern NS_SWIFT_NAME(FacebookAuthSignInMethod) NSString *const
    FIRFacebookAuthSignInMethod

  • A string constant identifying the Game Center identity provider.

    Declaration

    Objective-C

    extern NS_SWIFT_NAME(GameCenterAuthProviderID) NSString *const
    FIRGameCenterAuthProviderID

  • A string constant identifying the Game Center sign-in method.

    Declaration

    Objective-C

    extern NS_SWIFT_NAME(
    GameCenterAuthSignInMethod) NSString *const
    FIRGameCenterAuthSignInMethod

  • A string constant identifying the GitHub identity provider.

    Declaration

    Objective-C

    extern NS_SWIFT_NAME(GitHubAuthProviderID) NSString *const
    FIRGitHubAuthProviderID

  • A string constant identifying the GitHub sign-in method.

    Declaration

    Objective-C

    extern NS_SWIFT_NAME(GitHubAuthSignInMethod) NSString *const
    FIRGitHubAuthSignInMethod

  • A string constant identifying the Google identity provider.

    Declaration

    Objective-C

    extern NS_SWIFT_NAME(GoogleAuthProviderID) NSString *const
    FIRGoogleAuthProviderID

  • A string constant identifying the Google sign-in method.

    Declaration

    Objective-C

    extern NS_SWIFT_NAME(GoogleAuthSignInMethod) NSString *const
    FIRGoogleAuthSignInMethod

  • The string identifier for using phone as a second factor. This constant is available on iOS only.

    Declaration

    Objective-C

    extern NS_SWIFT_NAME(PhoneMultiFactorID) NSString *const FIRPhoneMultiFactorID

  • The string identifier for using TOTP as a second factor. This constant is available on iOS only.

    Declaration

    Objective-C

    extern NS_SWIFT_NAME(TOTPMultiFactorID) NSString *const FIRTOTPMultiFactorID

  • @var FIRPhoneAuthProviderID A string constant identifying the phone identity provider. This constant is available on iOS only.

    Declaration

    Objective-C

    extern NS_SWIFT_NAME(PhoneAuthProviderID) NSString *const FIRPhoneAuthProviderID

  • @var FIRPhoneAuthProviderID A string constant identifying the phone sign-in method. This constant is available on iOS only.

    Declaration

    Objective-C

    extern NS_SWIFT_NAME(PhoneAuthSignInMethod) NSString *const
    FIRPhoneAuthSignInMethod

  • A string constant identifying the Twitter identity provider.

    Declaration

    Objective-C

    extern NS_SWIFT_NAME(TwitterAuthProviderID) NSString *const
    FIRTwitterAuthProviderID

  • A string constant identifying the Twitter sign-in method.

    Declaration

    Objective-C

    extern NS_SWIFT_NAME(TwitterAuthSignInMethod) NSString *const
    FIRTwitterAuthSignInMethod