Type-Definitions

The following type definitions are available globally.

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

    Declaration

    Swift

    typealias UserUpdateCallback = (Error?) -> Void
  • The type of handle returned by FIRAuth.addAuthStateDidChangeListener:.

    Declaration

    Swift

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

    Declaration

    Swift

    typealias AuthStateDidChangeListenerBlock = (Auth, FIRUser?) -> Void

    Parameters

    auth

    The FIRAuth object on which state changes occurred.

    user

    Optionally; the current signed in user, if any.

  • The type of handle returned by FIRAuth.addIDTokenDidChangeListener:.

    Declaration

    Swift

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

    Declaration

    Swift

    typealias IDTokenDidChangeListenerBlock = (Auth, FIRUser?) -> Void

    Parameters

    auth

    The FIRAuth 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.

    Declaration

    Swift

    typealias AuthDataResultCallback = (FIRAuthDataResult?, Error?) -> Void

    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.

    Declaration

    Swift

    typealias AuthResultCallback = (FIRUser?, Error?) -> Void

    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.

    Declaration

    Swift

    typealias ProviderQueryCallback = ([String]?, Error?) -> Void

    Parameters

    providers

    Optionally; a list of provider identifiers, if any.

    See

    FIRGoogleAuthProviderID 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.

    Declaration

    Swift

    typealias SignInMethodQueryCallback = ([String]?, Error?) -> Void
  • The type of block invoked when sending a password reset email.

    Declaration

    Swift

    typealias SendPasswordResetCallback = (Error?) -> Void

    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.

    Declaration

    Swift

    typealias SendSignInLinkToEmailCallback = (Error?) -> Void
  • The type of block invoked when performing a password reset.

    Declaration

    Swift

    typealias ConfirmPasswordResetCallback = (Error?) -> Void

    Parameters

    error

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