Classes

The following classes are available globally.

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

    Declaration

    Swift

    class ActionCodeSettings : NSObject

    Objective-C

    
    @interface FIRActionCodeSettings : NSObject
  • Represents additional user data returned from an identity provider.

    Declaration

    Swift

    class AdditionalUserInfo : NSObject

    Objective-C

    
    @interface FIRAdditionalUserInfo : NSObject
  • Manages information regarding action codes.

    Declaration

    Swift

    class ActionCodeInfo : NSObject

    Objective-C

    
    @interface FIRActionCodeInfo : NSObject
  • Manages authentication for Firebase apps. This class is thread-safe.

    Declaration

    Swift

    class Auth : NSObject

    Objective-C

    
    @interface FIRAuth : NSObject
  • Represents a credential.

    Declaration

    Swift

    class AuthCredential : NSObject

    Objective-C

    
    @interface FIRAuthCredential : NSObject
  • 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

    Objective-C

    
    @interface FIRAuthDataResult : NSObject
  • 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

    Objective-C

    
    @interface FIRAuthErrors
  • Determines settings related to an auth object.

    Declaration

    Swift

    class FIRAuthSettings : NSObject

    Objective-C

    @interface FIRAuthSettings : NSObject
  • 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

    Objective-C

    
    @interface FIRAuthTokenResult : NSObject
  • A concrete implementation of FIRAuthProvider for Email & Password Sign In.

    Declaration

    Swift

    class EmailAuthProvider : NSObject

    Objective-C

    
    @interface FIREmailAuthProvider : NSObject
  • Utility class for constructing Facebook credentials.

    Declaration

    Swift

    class FacebookAuthProvider : NSObject

    Objective-C

    
    @interface FIRFacebookAuthProvider : NSObject
  • Utility class for constructing GitHub credentials.

    Declaration

    Swift

    class GitHubAuthProvider : NSObject

    Objective-C

    
    @interface FIRGitHubAuthProvider : NSObject
  • Utility class for constructing Google Sign In credentials.

    Declaration

    Swift

    class GoogleAuthProvider : NSObject

    Objective-C

    
    @interface FIRGoogleAuthProvider : NSObject
  • A concrete implementation of FIRAuthProvider for generic OAuth Providers.

    Declaration

    Swift

    class OAuthProvider : NSObject

    Objective-C

    
    @interface FIROAuthProvider : NSObject
  • Implementation of FIRAuthCredential for Phone Auth credentials.

    Declaration

    Swift

    class PhoneAuthCredential : AuthCredential

    Objective-C

    
    @interface FIRPhoneAuthCredential : FIRAuthCredential
  • A concrete implementation of FIRAuthProvider for phone auth providers.

    Declaration

    Swift

    class PhoneAuthProvider : NSObject

    Objective-C

    
    @interface FIRPhoneAuthProvider : NSObject
  • Utility class for constructing Twitter credentials.

    Declaration

    Swift

    class TwitterAuthProvider : NSObject

    Objective-C

    
    @interface FIRTwitterAuthProvider : NSObject
  • 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

    Objective-C

    
    @interface FIRUser : NSObject <FIRUserInfo>
  • 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

    Objective-C

    
    @interface FIRUserProfileChangeRequest : NSObject
  • A data class representing the metadata corresponding to a Firebase user.

    Declaration

    Swift

    class UserMetadata : NSObject

    Objective-C

    
    @interface FIRUserMetadata : NSObject