devsite/tools/jazzy/templates

FirebaseAuth Framework Reference

AuthErrors

@objc(FIRAuthErrors)
open class AuthErrors : NSObject

Error Codes common to all API Methods:

  • The Firebase Auth error domain.

    Declaration

    Swift

    @objc
public static let domain: String

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

    Declaration

    Swift

    @objc
public static let userInfoNameKey: String

  • Error codes for Email operations

    Errors with one of the following three codes:

    • accountExistsWithDifferentCredential
    • credentialAlreadyInUse
    • emailAlreadyInUse`

    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

    @objc
public static let userInfoEmailKey: String

  • 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

    @objc
public static let userInfoUpdatedCredentialKey: String

  • 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

    @objc(FIRAuthErrorUserInfoMultiFactorResolverKey)
public static let userInfoMultiFactorResolverKey: String