FirebaseAuth Framework Reference

Type Definitions

The following type definitions are available globally.

  • The type of block invoked when a request to update the current user is completed.

  • The type of handle returned by Auth.addAuthStateDidChangeListener(_:).

    Declaration

    Swift

    typealias AuthStateDidChangeListenerHandle = NSObjectProtocol
  • The type of block which can be registered as a listener for auth state did change events.

    Parameters

    auth

    The Auth object on which state changes occurred.

    user

    Optionally; the current signed in user, if any.

  • The type of handle returned by Auth.addIDTokenDidChangeListener(_:).

    Declaration

    Swift

    typealias IDTokenDidChangeListenerHandle = NSObjectProtocol
  • The type of block which can be registered as a listener for ID token did change events.

    Parameters

    auth

    The Auth object on which ID token changes occurred.

    user

    Optionally; the current signed in user, if any.

  • The type of block invoked when sign-in related events complete.

    Parameters

    authResult

    Optionally; Result of sign-in request containing both the user and the additional user info associated with the user.

    error

    Optionally; the error which occurred - or nil if the request was successful.

  • The type of block invoked when sign-in related events complete.

    Parameters

    user

    Optionally; the signed in user, if any.

    error

    Optionally; if an error occurs, this is the NSError object that describes the problem. Set to nil otherwise.

  • The type of block invoked when a list of identity providers for a given email address is requested.

    Parameters

    providers

    Optionally; a list of provider identifiers, if any.

    See

    GoogleAuthProviderID etc.

    error

    Optionally; if an error occurs, this is the NSError object that describes the problem. Set to nil otherwise.

  • The type of block invoked when a list of sign-in methods for a given email address is requested.

  • The type of block invoked when sending a password reset email.

    Parameters

    error

    Optionally; if an error occurs, this is the NSError object that describes the problem. Set to nil otherwise.

  • The type of block invoked when sending an email sign-in link email.

  • The type of block invoked when performing a password reset.

    Parameters

    error

    Optionally; if an error occurs, this is the NSError object that describes the problem. Set to nil otherwise.

  • The type of block invoked when verifying that an out of band code should be used to perform password reset.

    Parameters

    email

    Optionally; the email address of the user for which the out of band code applies.

    error

    Optionally; if an error occurs, this is the NSError object that describes the problem. Set to nil otherwise.

  • The type of block invoked when applying an action code.

    Parameters

    error

    Optionally; if an error occurs, this is the NSError object that describes the problem. Set to nil otherwise.

  • Undocumented

  • The type of block invoked when performing a check action code operation.

    Parameters

    info

    Metadata corresponding to the action code.

    error

    Optionally; if an error occurs, this is the NSError object that describes the problem. Set to nil otherwise.

  • The type of block invoked when obtaining an auth credential.

    Parameters

    credential

    The credential obtained.

    error

    The error that occurred if any.

  • The type of block invoked when the Game Center credential code has finished.

    Parameters

    credential

    On success, the credential will be provided, nil otherwise.

    error

    On error, the error that occurred, nil otherwise.

  • The callback that triggered when a developer calls getSessionWithCompletion. This type is available on iOS only.

    Parameters

    session

    The multi factor session returned, if any.

    error

    The error which occurred, if any.

  • The type of block invoked when a request to send a verification code has finished. This type is available on iOS only.

    Parameters

    verificationID

    On success, the verification ID provided, nil otherwise.

    error

    On error, the error that occurred, nil otherwise.

  • The type of block called when a token is ready for use.

    One of token or error will always be non-nil.

    Parameters

    token

    Optionally; an access token if the request was successful.

    error

    Optionally; the error which occurred - or nil if the request was successful.

  • The type of block called when a token is ready for use.

    One of token or error will always be non-nil.

    Parameters

    tokenResult

    Optionally; an object containing the raw access token string as well as other useful data pertaining to the token.

    error

    Optionally; the error which occurred - or nil if the request was successful.

  • The type of block called when a user profile change has finished.

    Parameters

    error

    Optionally; the error which occurred - or nil if the request was successful.

  • The type of block called when a request to send an email verification has finished.

    Parameters

    error

    Optionally; the error which occurred - or nil if the request was successful.