devsite/tools/jazzy/templates

FirebaseAuth Framework Reference

Constants

The following constants are available globally.

  • @brief 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

    Swift

    static let AuthStateDidChange: NSNotification.Name

  • @brief The Firebase Auth error domain.

    Declaration

    Swift

    let AuthErrorDomain: String

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

    Declaration

    Swift

    let AuthErrorUserInfoNameKey: String

  • @brief Errors with one of the following three codes: - AuthErrorCodeAccountExistsWithDifferentCredential - AuthErrorCodeCredentialAlreadyInUse - AuthErrorCodeEmailAlreadyInUse may contain an NSError.userInfo dictionary 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

    Swift

    let AuthErrorUserInfoEmailKey: String

  • @brief 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

    Swift

    let AuthErrorUserInfoUpdatedCredentialKey: String

  • @brief 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

    Swift

    let AuthErrorUserInfoMultiFactorResolverKey: String

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

    Declaration

    Swift

    let EmailAuthProviderID: String

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

    Declaration

    Swift

    let EmailLinkAuthSignInMethod: String

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

    Declaration

    Swift

    let EmailPasswordAuthSignInMethod: String

  • @brief A string constant identifying the Facebook identity provider.

    Declaration

    Swift

    let FacebookAuthProviderID: String

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

    Declaration

    Swift

    let FacebookAuthSignInMethod: String

  • @brief A string constant identifying the Game Center identity provider.

    Declaration

    Swift

    let GameCenterAuthProviderID: String

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

    Declaration

    Swift

    let GameCenterAuthSignInMethod: String

  • @brief A string constant identifying the GitHub identity provider.

    Declaration

    Swift

    let GitHubAuthProviderID: String

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

    Declaration

    Swift

    let GitHubAuthSignInMethod: String

  • @brief A string constant identifying the Google identity provider.

    Declaration

    Swift

    let GoogleAuthProviderID: String

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

    Declaration

    Swift

    let GoogleAuthSignInMethod: String

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

    Declaration

    Swift

    let PhoneMultiFactorID: String

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

    Declaration

    Swift

    let TOTPMultiFactorID: String

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

    Declaration

    Swift

    let PhoneAuthProviderID: String

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

    Declaration

    Swift

    let PhoneAuthSignInMethod: String

  • @brief A string constant identifying the Twitter identity provider.

    Declaration

    Swift

    let TwitterAuthProviderID: String

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

    Declaration

    Swift

    let TwitterAuthSignInMethod: String