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
Objective-C
typedef void (^FIRUserUpdateCallback)(NSError *_Nullable)
-
The type of handle returned by
Auth.addAuthStateDidChangeListener(_:)
.Declaration
Objective-C
typedef id<NSObject> FIRAuthStateDidChangeListenerHandle
-
The type of block which can be registered as a listener for auth state did change events.
Declaration
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
Objective-C
typedef id<NSObject> FIRIDTokenDidChangeListenerHandle
-
The type of block which can be registered as a listener for ID token did change events.
Declaration
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.
Declaration
Objective-C
typedef void (^FIRAuthDataResultCallback)(FIRAuthDataResult *_Nullable, NSError *_Nullable)
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
Objective-C
typedef void (^FIRAuthResultCallback)(FIRUser *_Nullable, NSError *_Nullable)
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
Objective-C
typedef void (^FIRProviderQueryCallback)(NSArray<NSString *> *_Nullable, NSError *_Nullable)
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.
Declaration
Objective-C
typedef void (^FIRSignInMethodQueryCallback)(NSArray<NSString *> *_Nullable, NSError *_Nullable)
-
The type of block invoked when sending a password reset email.
Declaration
Objective-C
typedef void (^FIRSendPasswordResetCallback)(NSError *_Nullable)
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
Objective-C
typedef void (^FIRSendSignInLinkToEmailCallback)(NSError *_Nullable)
-
The type of block invoked when performing a password reset.
Declaration
Objective-C
typedef void (^FIRConfirmPasswordResetCallback)(NSError *_Nullable)
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.
Declaration
Objective-C
typedef void (^FIRVerifyPasswordResetCodeCallback)(NSString *_Nullable, NSError *_Nullable)
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.
Declaration
Objective-C
typedef void (^FIRApplyActionCodeCallback)(NSError *_Nullable)
Parameters
error
Optionally; if an error occurs, this is the NSError object that describes the problem. Set to nil otherwise.
-
Undocumented
Declaration
Objective-C
typedef void (^FIRAuthVoidErrorCallback)(NSError *_Nullable)
-
The type of block invoked when performing a check action code operation.
Declaration
Objective-C
typedef void (^FIRCheckActionCodeCallBack)(FIRActionCodeInfo *_Nullable, NSError *_Nullable)
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.
Declaration
Objective-C
typedef void (^FIRAuthCredentialCallback)(FIRAuthCredential *_Nullable, NSError *_Nullable)
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.
Declaration
Objective-C
typedef void (^FIRGameCenterCredentialCallback)(FIRAuthCredential *_Nullable, NSError *_Nullable)
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.Declaration
Objective-C
typedef void (^FIRMultiFactorSessionCallback)(FIRMultiFactorSession *_Nullable, NSError *_Nullable)
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.
Declaration
Objective-C
typedef void (^FIRVerificationResultCallback)(NSString *_Nullable, NSError *_Nullable)
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.
See
User.getIDToken()
See
User.idTokenForcingRefresh(_:)
One of
token
orerror
will always be non-nil.Declaration
Objective-C
typedef void (^FIRAuthTokenCallback)(NSString *_Nullable, NSError *_Nullable)
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.
See
User.getIDToken()
See
User.idTokenForcingRefresh(_:)
One of
token
orerror
will always be non-nil.Declaration
Objective-C
typedef void (^FIRAuthTokenResultCallback)(FIRAuthTokenResult *_Nullable, NSError *_Nullable)
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.
Declaration
Objective-C
typedef void (^FIRUserProfileChangeCallback)(NSError *_Nullable)
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.
Declaration
Objective-C
typedef void (^FIRSendEmailVerificationCallback)(NSError *_Nullable)
Parameters
error
Optionally; the error which occurred - or nil if the request was successful.