FirebaseAuth Framework Reference

Classes

The following classes are available globally.

• ActionCodeSettings

  Used to set and retrieve settings related to handling action codes.

  Declaration

  Swift

  class ActionCodeSettings : NSObject

• AdditionalUserInfo

  Represents additional user data returned from an identity provider.

  Declaration

  Swift

  class AdditionalUserInfo : NSObject

• ActionCodeInfo

  Manages information regarding action codes.

  Declaration

  Swift

  class ActionCodeInfo : NSObject

• Auth

  Manages authentication for Firebase apps. This class is thread-safe.

  Declaration

  Swift

  class Auth : NSObject

• AuthCredential

  Represents a credential.

  Declaration

  Swift

  class AuthCredential : NSObject

• AuthDataResult

  Helper object that contains the result of a successful sign-in, link and reauthenticate action. It contains references to a FIRUser instance and a FIRAdditionalUserInfo instance.

  Declaration

  Swift

  class AuthDataResult : NSObject

• AuthErrors

  Error Codes common to all API Methods:

  + `FIRAuthErrorCodeNetworkError`
  + `FIRAuthErrorCodeUserNotFound`
  + `FIRAuthErrorCodeUserTokenExpired`
  + `FIRAuthErrorCodeTooManyRequests`
  + `FIRAuthErrorCodeInvalidAPIKey`
  + `FIRAuthErrorCodeAppNotAuthorized`
  + `FIRAuthErrorCodeKeychainError`
  + `FIRAuthErrorCodeInternalError`
  

  Common error codes for FIRUser operations:

  + `FIRAuthErrorCodeInvalidUserToken`
  + `FIRAuthErrorCodeUserDisabled`
  

  Declaration

  Swift

  class AuthErrors

• AuthSettings

  Determines settings related to an auth object.

  Declaration

  Swift

  class AuthSettings : NSObject

• AuthTokenResult

  A data class containing the ID token JWT string and other properties associated with the token including the decoded payload claims.

  Declaration

  Swift

  class AuthTokenResult : NSObject

• EmailAuthProvider

  A concrete implementation of FIRAuthProvider for Email & Password Sign In.

  Declaration

  Swift

  class EmailAuthProvider : NSObject

• FacebookAuthProvider

  Utility class for constructing Facebook credentials.

  Declaration

  Swift

  class FacebookAuthProvider : NSObject

• GameCenterAuthProvider

  A concrete implementation of FIRAuthProvider for Game Center Sign In.

  Declaration

  Swift

  class GameCenterAuthProvider : NSObject

• GitHubAuthProvider

  Utility class for constructing GitHub credentials.

  Declaration

  Swift

  class GitHubAuthProvider : NSObject

• GoogleAuthProvider

  Utility class for constructing Google Sign In credentials.

  Declaration

  Swift

  class GoogleAuthProvider : NSObject

• OAuthCredential

  Internal implementation of FIRAuthCredential for generic credentials.

  Declaration

  Swift

  class OAuthCredential : AuthCredential, NSSecureCoding

• OAuthProvider

  A concrete implementation of FIRAuthProvider for generic OAuth Providers.

  Declaration

  Swift

  class OAuthProvider : NSObject, FederatedAuthProvider

• PhoneAuthCredential

  Implementation of FIRAuthCredential for Phone Auth credentials.

  Declaration

  Swift

  class PhoneAuthCredential : AuthCredential, NSSecureCoding

• PhoneAuthProvider

  A concrete implementation of FIRAuthProvider for phone auth providers.

  Declaration

  Swift

  class PhoneAuthProvider : NSObject

• TwitterAuthProvider

  Utility class for constructing Twitter credentials.

  Declaration

  Swift

  class TwitterAuthProvider : NSObject

• User

  Represents a user. Firebase Auth does not attempt to validate users when loading them from the keychain. Invalidated users (such as those whose passwords have been changed on another client) are automatically logged out when an auth-dependent operation is attempted or when the ID token is automatically refreshed. This class is thread-safe.

  Declaration

  Swift

  class User : NSObject, UserInfo

• UserProfileChangeRequest

  Represents an object capable of updating a user’s profile data. Properties are marked as being part of a profile update when they are set. Setting a property value to nil is not the same as leaving the property unassigned.

  Declaration

  Swift

  class UserProfileChangeRequest : NSObject

• UserMetadata

  A data class representing the metadata corresponding to a Firebase user.

  Declaration

  Swift

  class UserMetadata : NSObject