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