aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorGravatar alexg33 <alexgeboff@gmail.com>2017-12-06 15:41:47 -0800
committerGravatar Paul Beusterien <paulbeusterien@google.com>2017-12-06 15:41:47 -0800
commitcb5f3efd3ab53561afd7de625d16d014d14374dd (patch)
treeb1f70a5892b6f59053ad2dff89fec3c1c808bfa5
parenta904be723a997ed434a36ce9562794a75673927e (diff)
Updating the Auth header comments for Jazzy syntax (#535)
-rw-r--r--Firebase/Auth/Source/Public/FIRAdditionalUserInfo.h4
-rw-r--r--Firebase/Auth/Source/Public/FIRAuth.h299
-rw-r--r--Firebase/Auth/Source/Public/FIRAuthDataResult.h4
-rw-r--r--Firebase/Auth/Source/Public/FIRAuthErrors.h44
-rw-r--r--Firebase/Auth/Source/Public/FIREmailAuthProvider.h8
-rw-r--r--Firebase/Auth/Source/Public/FIRFacebookAuthProvider.h2
-rw-r--r--Firebase/Auth/Source/Public/FIRGitHubAuthProvider.h2
-rw-r--r--Firebase/Auth/Source/Public/FIRGoogleAuthProvider.h2
-rw-r--r--Firebase/Auth/Source/Public/FIROAuthProvider.h6
-rw-r--r--Firebase/Auth/Source/Public/FIRPhoneAuthProvider.h57
-rw-r--r--Firebase/Auth/Source/Public/FIRTwitterAuthProvider.h2
-rw-r--r--Firebase/Auth/Source/Public/FIRUser.h190
12 files changed, 266 insertions, 354 deletions
diff --git a/Firebase/Auth/Source/Public/FIRAdditionalUserInfo.h b/Firebase/Auth/Source/Public/FIRAdditionalUserInfo.h
index 36dd3aa..4f6947a 100644
--- a/Firebase/Auth/Source/Public/FIRAdditionalUserInfo.h
+++ b/Firebase/Auth/Source/Public/FIRAdditionalUserInfo.h
@@ -27,8 +27,8 @@ NS_SWIFT_NAME(AdditionalUserInfo)
@interface FIRAdditionalUserInfo : NSObject
/** @fn init
- @brief This class should not be initialized manually. @c FIRAdditionalUserInfo can be retrieved
- from from an instance of @c FIRAuthDataResult.
+ @brief This class should not be initialized manually. `FIRAdditionalUserInfo` can be retrieved
+ from from an instance of `FIRAuthDataResult`.
*/
- (instancetype)init NS_UNAVAILABLE;
diff --git a/Firebase/Auth/Source/Public/FIRAuth.h b/Firebase/Auth/Source/Public/FIRAuth.h
index 42b3ac5..f18a3d0 100644
--- a/Firebase/Auth/Source/Public/FIRAuth.h
+++ b/Firebase/Auth/Source/Public/FIRAuth.h
@@ -33,7 +33,7 @@
NS_ASSUME_NONNULL_BEGIN
/** @typedef FIRAuthStateDidChangeListenerHandle
- @brief The type of handle returned by @c FIRAuth.addAuthStateDidChangeListener:.
+ @brief The type of handle returned by `FIRAuth.addAuthStateDidChangeListener:`.
*/
typedef id<NSObject> FIRAuthStateDidChangeListenerHandle
NS_SWIFT_NAME(AuthStateDidChangeListenerHandle);
@@ -48,7 +48,7 @@ typedef void(^FIRAuthStateDidChangeListenerBlock)(FIRAuth *auth, FIRUser *_Nulla
NS_SWIFT_NAME(AuthStateDidChangeListenerBlock);
/** @typedef FIRIDTokenDidChangeListenerHandle
- @brief The type of handle returned by @c FIRAuth.addIDTokenDidChangeListener:.
+ @brief The type of handle returned by `FIRAuth.addIDTokenDidChangeListener:`.
*/
typedef id<NSObject> FIRIDTokenDidChangeListenerHandle
NS_SWIFT_NAME(IDTokenDidChangeListenerHandle);
@@ -75,17 +75,17 @@ typedef void (^FIRAuthDataResultCallback)(FIRAuthDataResult *_Nullable authResul
#if defined(__IPHONE_10_0) && __IPHONE_OS_VERSION_MAX_ALLOWED >= __IPHONE_10_0
/**
- @brief The name of the @c NSNotificationCenter notification which is posted when the auth state
+ @brief The name of the `NSNotificationCenter` notification which is posted when the auth state
changes (for example, a new token has been produced, a user signs in or signs out). The
- object parameter of the notification is the sender @c FIRAuth instance.
+ object parameter of the notification is the sender `FIRAuth` instance.
*/
extern const NSNotificationName FIRAuthStateDidChangeNotification
NS_SWIFT_NAME(AuthStateDidChange);
#else
/**
- @brief The name of the @c NSNotificationCenter notification which is posted when the auth state
+ @brief The name of the `NSNotificationCenter` notification which is posted when the auth state
changes (for example, a new token has been produced, a user signs in or signs out). The
- object parameter of the notification is the sender @c FIRAuth instance.
+ object parameter of the notification is the sender `FIRAuth` instance.
*/
extern NSString *const FIRAuthStateDidChangeNotification
NS_SWIFT_NAME(AuthStateDidChangeNotification);
@@ -154,8 +154,8 @@ typedef void (^FIRApplyActionCodeCallback)(NSError *_Nullable error)
NS_SWIFT_NAME(ApplyActionCodeCallback);
/**
- @brief Keys used to retrieve operation data from a @c FIRActionCodeInfo object by the
- @c dataForKey method.
+ @brief Keys used to retrieve operation data from a `FIRActionCodeInfo` object by the
+ `dataForKey` method.
*/
typedef NS_ENUM(NSInteger, FIRActionDataKey) {
/**
@@ -239,7 +239,7 @@ NS_SWIFT_NAME(Auth)
+ (FIRAuth *)auth NS_SWIFT_NAME(auth());
/** @fn authWithApp:
- @brief Gets the auth object for a @c FIRApp.
+ @brief Gets the auth object for a `FIRApp`.
@param app The FIRApp for which to retrieve the associated FIRAuth instance.
@return The FIRAuth instance associated with the given FIRApp.
@@ -247,7 +247,7 @@ NS_SWIFT_NAME(Auth)
+ (FIRAuth *)authWithApp:(FIRApp *)app NS_SWIFT_NAME(auth(app:));
/** @property app
- @brief Gets the @c FIRApp object that this auth object is connected to.
+ @brief Gets the `FIRApp` object that this auth object is connected to.
*/
@property(nonatomic, weak, readonly, nullable) FIRApp *app;
@@ -256,9 +256,9 @@ NS_SWIFT_NAME(Auth)
*/
@property(nonatomic, strong, readonly, nullable) FIRUser *currentUser;
-/** @proprty languageCode
+/** @property languageCode
@brief The current user language code. This property can be set to the app's current language by
- calling @c useAppLanguage.
+ calling `useAppLanguage`.
@remarks The string used to set this property must be a language code that follows BCP 47.
*/
@@ -269,13 +269,13 @@ NS_SWIFT_NAME(Auth)
@brief The APNs token used for phone number authentication. The type of the token (production
or sandbox) will be attempted to be automatcially detected.
@remarks If swizzling is disabled, the APNs Token must be set for phone number auth to work,
- by either setting this property or by calling @c setAPNSToken:type:
+ by either setting this property or by calling `setAPNSToken:type:`
*/
@property(nonatomic, strong, nullable) NSData *APNSToken;
#endif
/** @fn init
- @brief Please access auth instances using @c FIRAuth.auth and @c FIRAuth.authForApp:.
+ @brief Please access auth instances using `FIRAuth.auth` and `FIRAuth.authForApp:`.
*/
- (instancetype)init NS_UNAVAILABLE;
@@ -289,11 +289,10 @@ NS_SWIFT_NAME(Auth)
main thread in the future.
@remarks Possible error codes:
- <ul>
- <li>@c FIRAuthErrorCodeInvalidEmail - Indicates the email address is malformed.</li>
- </ul>
- @remarks See @c FIRAuthErrors for a list of error codes that are common to all API methods.
+ + `FIRAuthErrorCodeInvalidEmail` - Indicates the email address is malformed.
+
+ @remarks See `FIRAuthErrors` for a list of error codes that are common to all API methods.
*/
- (void)fetchProvidersForEmail:(NSString *)email
completion:(nullable FIRProviderQueryCallback)completion;
@@ -308,21 +307,16 @@ NS_SWIFT_NAME(Auth)
@remarks Possible error codes:
- <ul>
- <li>@c FIRAuthErrorCodeOperationNotAllowed - Indicates that email and password
+ + `FIRAuthErrorCodeOperationNotAllowed` - Indicates that email and password
accounts are not enabled. Enable them in the Auth section of the
Firebase console.
- </li>
- <li>@c FIRAuthErrorCodeUserDisabled - Indicates the user's account is disabled.
- </li>
- <li>@c FIRAuthErrorCodeWrongPassword - Indicates the user attempted
+ + `FIRAuthErrorCodeUserDisabled` - Indicates the user's account is disabled.
+ + `FIRAuthErrorCodeWrongPassword` - Indicates the user attempted
sign in with an incorrect password.
- </li>
- <li>@c FIRAuthErrorCodeInvalidEmail - Indicates the email address is malformed.
- </li>
- </ul>
+ + `FIRAuthErrorCodeInvalidEmail` - Indicates the email address is malformed.
+
- @remarks See @c FIRAuthErrors for a list of error codes that are common to all API methods.
+ @remarks See `FIRAuthErrors` for a list of error codes that are common to all API methods.
*/
- (void)signInWithEmail:(NSString *)email
password:(NSString *)password
@@ -338,31 +332,28 @@ NS_SWIFT_NAME(Auth)
@remarks Possible error codes:
- <ul>
- <li>@c FIRAuthErrorCodeOperationNotAllowed - Indicates that email and password
+ + `FIRAuthErrorCodeOperationNotAllowed` - Indicates that email and password
accounts are not enabled. Enable them in the Auth section of the
Firebase console.
- </li>
- <li>@c FIRAuthErrorCodeUserDisabled - Indicates the user's account is disabled.
- </li>
- <li>@c FIRAuthErrorCodeWrongPassword - Indicates the user attempted
+ + `FIRAuthErrorCodeUserDisabled` - Indicates the user's account is disabled.
+ + `FIRAuthErrorCodeWrongPassword` - Indicates the user attempted
sign in with an incorrect password.
- </li>
- <li>@c FIRAuthErrorCodeInvalidEmail - Indicates the email address is malformed.
- </li>
- </ul>
+ + `FIRAuthErrorCodeInvalidEmail` - Indicates the email address is malformed.
+
+
+
+ @remarks See `FIRAuthErrors` for a list of error codes that are common to all API methods.
- @remarks See @c FIRAuthErrors for a list of error codes that are common to all API methods.
@remarks This method will only exist until the next major Firebase release following 4.x.x.
- After the next major release the method @c signInWithEmail:password:completion: will support
- the @c FIRAuthDataResultCallback.
+ After the next major release the method `signInWithEmail:password:completion:` will support
+ the `FIRAuthDataResultCallback`.
*/
- (void)signInAndRetrieveDataWithEmail:(NSString *)email
password:(NSString *)password
completion:(nullable FIRAuthDataResultCallback)completion;
/** @fn signInWithCredential:completion:
- @brief Convenience method for @c signInAndRetrieveDataWithCredential:completion: This method
+ @brief Convenience method for `signInAndRetrieveDataWithCredential:completion:` This method
doesn't return additional identity provider data.
*/
- (void)signInWithCredential:(FIRAuthCredential *)credential
@@ -378,45 +369,35 @@ NS_SWIFT_NAME(Auth)
canceled. Invoked asynchronously on the main thread in the future.
@remarks Possible error codes:
- <ul>
- <li>@c FIRAuthErrorCodeInvalidCredential - Indicates the supplied credential is invalid.
+
+ + `FIRAuthErrorCodeInvalidCredential` - Indicates the supplied credential is invalid.
This could happen if it has expired or it is malformed.
- </li>
- <li>@c FIRAuthErrorCodeOperationNotAllowed - Indicates that accounts
+ + `FIRAuthErrorCodeOperationNotAllowed` - Indicates that accounts
with the identity provider represented by the credential are not enabled.
Enable them in the Auth section of the Firebase console.
- </li>
- <li>@c FIRAuthErrorCodeAccountExistsWithDifferentCredential - Indicates the email asserted
+ + `FIRAuthErrorCodeAccountExistsWithDifferentCredential` - Indicates the email asserted
by the credential (e.g. the email in a Facebook access token) is already in use by an
existing account, that cannot be authenticated with this sign-in method. Call
fetchProvidersForEmail for this user’s email and then prompt them to sign in with any of
the sign-in providers returned. This error will only be thrown if the "One account per
email address" setting is enabled in the Firebase console, under Auth settings.
- </li>
- <li>@c FIRAuthErrorCodeUserDisabled - Indicates the user's account is disabled.
- </li>
- <li>@c FIRAuthErrorCodeWrongPassword - Indicates the user attempted sign in with an
+ + `FIRAuthErrorCodeUserDisabled` - Indicates the user's account is disabled.
+ + `FIRAuthErrorCodeWrongPassword` - Indicates the user attempted sign in with an
incorrect password, if credential is of the type EmailPasswordAuthCredential.
- </li>
- <li>@c FIRAuthErrorCodeInvalidEmail - Indicates the email address is malformed.
- </li>
- <li>@c FIRAuthErrorCodeMissingVerificationID - Indicates that the phone auth credential was
+ + `FIRAuthErrorCodeInvalidEmail` - Indicates the email address is malformed.
+ + `FIRAuthErrorCodeMissingVerificationID` - Indicates that the phone auth credential was
created with an empty verification ID.
- </li>
- <li>@c FIRAuthErrorCodeMissingVerificationCode - Indicates that the phone auth credential
+ + `FIRAuthErrorCodeMissingVerificationCode` - Indicates that the phone auth credential
was created with an empty verification code.
- </li>
- <li>@c FIRAuthErrorCodeInvalidVerificationCode - Indicates that the phone auth credential
+ + `FIRAuthErrorCodeInvalidVerificationCode` - Indicates that the phone auth credential
was created with an invalid verification Code.
- </li>
- <li>@c FIRAuthErrorCodeInvalidVerificationID - Indicates that the phone auth credential was
+ + `FIRAuthErrorCodeInvalidVerificationID` - Indicates that the phone auth credential was
created with an invalid verification ID.
- </li>
- <li>@c FIRAuthErrorCodeSessionExpired - Indicates that the SMS code has expired.
- </li>
- </ul>
+ + `FIRAuthErrorCodeSessionExpired` - Indicates that the SMS code has expired.
+
- @remarks See @c FIRAuthErrors for a list of error codes that are common to all API methods.
+
+ @remarks See `FIRAuthErrors` for a list of error codes that are common to all API methods.
*/
- (void)signInAndRetrieveDataWithCredential:(FIRAuthCredential *)credential
completion:(nullable FIRAuthDataResultCallback)completion;
@@ -430,13 +411,11 @@ NS_SWIFT_NAME(Auth)
If there is any other existing user signed in, that user will be signed out.
@remarks Possible error codes:
- <ul>
- <li>@c FIRAuthErrorCodeOperationNotAllowed - Indicates that anonymous accounts are
+
+ + `FIRAuthErrorCodeOperationNotAllowed` - Indicates that anonymous accounts are
not enabled. Enable them in the Auth section of the Firebase console.
- </li>
- </ul>
- @remarks See @c FIRAuthErrors for a list of error codes that are common to all API methods.
+ @remarks See `FIRAuthErrors` for a list of error codes that are common to all API methods.
*/
- (void)signInAnonymouslyWithCompletion:(nullable FIRAuthResultCallback)completion;
@@ -449,16 +428,16 @@ NS_SWIFT_NAME(Auth)
If there is any other existing user signed in, that user will be signed out.
@remarks Possible error codes:
- <ul>
- <li>@c FIRAuthErrorCodeOperationNotAllowed - Indicates that anonymous accounts are
+
+ + `FIRAuthErrorCodeOperationNotAllowed` - Indicates that anonymous accounts are
not enabled. Enable them in the Auth section of the Firebase console.
- </li>
- </ul>
- @remarks See @c FIRAuthErrors for a list of error codes that are common to all API methods.
+
+ @remarks See `FIRAuthErrors` for a list of error codes that are common to all API methods.
+
@remarks This method will only exist until the next major Firebase release following 4.x.x.
- After the next major release the method @c signInAnonymouslyWithCompletion will support the
- @c FIRAuthDataResultCallback.
+ After the next major release the method `signInAnonymouslyWithCompletion` will support the
+ `FIRAuthDataResultCallback`.
*/
- (void)signInAnonymouslyAndRetrieveDataWithCompletion:
(nullable FIRAuthDataResultCallback)completion;
@@ -471,16 +450,15 @@ NS_SWIFT_NAME(Auth)
canceled. Invoked asynchronously on the main thread in the future.
@remarks Possible error codes:
- <ul>
- <li>@c FIRAuthErrorCodeInvalidCustomToken - Indicates a validation error with
+
+ + `FIRAuthErrorCodeInvalidCustomToken` - Indicates a validation error with
the custom token.
- </li>
- <li>@c FIRAuthErrorCodeCustomTokenMismatch - Indicates the service account and the API key
+ + `FIRAuthErrorCodeCustomTokenMismatch` - Indicates the service account and the API key
belong to different projects.
- </li>
- </ul>
- @remarks See @c FIRAuthErrors for a list of error codes that are common to all API methods.
+
+
+ @remarks See `FIRAuthErrors` for a list of error codes that are common to all API methods.
*/
- (void)signInWithCustomToken:(NSString *)token
completion:(nullable FIRAuthResultCallback)completion;
@@ -493,19 +471,20 @@ NS_SWIFT_NAME(Auth)
canceled. Invoked asynchronously on the main thread in the future.
@remarks Possible error codes:
- <ul>
- <li>@c FIRAuthErrorCodeInvalidCustomToken - Indicates a validation error with
+
+ + `FIRAuthErrorCodeInvalidCustomToken` - Indicates a validation error with
the custom token.
- </li>
- <li>@c FIRAuthErrorCodeCustomTokenMismatch - Indicates the service account and the API key
+
+ + `FIRAuthErrorCodeCustomTokenMismatch` - Indicates the service account and the API key
belong to different projects.
- </li>
- </ul>
- @remarks See @c FIRAuthErrors for a list of error codes that are common to all API methods.
+
+
+ @remarks See `FIRAuthErrors` for a list of error codes that are common to all API methods.
+
@remarks This method will only exist until the next major Firebase release following 4.x.x.
- After the next major release the method @c createUserWithEmail:password:completion: will
- support the @c FIRAuthDataResultCallback.
+ After the next major release the method `createUserWithEmail:password:completion:` will
+ support the `FIRAuthDataResultCallback`.
*/
- (void)signInAndRetrieveDataWithCustomToken:(NSString *)token
completion:(nullable FIRAuthDataResultCallback)completion;
@@ -520,23 +499,18 @@ NS_SWIFT_NAME(Auth)
canceled. Invoked asynchronously on the main thread in the future.
@remarks Possible error codes:
- <ul>
- <li>@c FIRAuthErrorCodeInvalidEmail - Indicates the email address is malformed.
- </li>
- <li>@c FIRAuthErrorCodeEmailAlreadyInUse - Indicates the email used to attempt sign up
+
+ + `FIRAuthErrorCodeInvalidEmail` - Indicates the email address is malformed.
+ + `FIRAuthErrorCodeEmailAlreadyInUse` - Indicates the email used to attempt sign up
already exists. Call fetchProvidersForEmail to check which sign-in mechanisms the user
used, and prompt the user to sign in with one of those.
- </li>
- <li>@c FIRAuthErrorCodeOperationNotAllowed - Indicates that email and password accounts
+ + `FIRAuthErrorCodeOperationNotAllowed` - Indicates that email and password accounts
are not enabled. Enable them in the Auth section of the Firebase console.
- </li>
- <li>@c FIRAuthErrorCodeWeakPassword - Indicates an attempt to set a password that is
+ + `FIRAuthErrorCodeWeakPassword` - Indicates an attempt to set a password that is
considered too weak. The NSLocalizedFailureReasonErrorKey field in the NSError.userInfo
dictionary object will contain more detailed explanation that can be shown to the user.
- </li>
- </ul>
- @remarks See @c FIRAuthErrors for a list of error codes that are common to all API methods.
+ @remarks See `FIRAuthErrors` for a list of error codes that are common to all API methods.
*/
- (void)createUserWithEmail:(NSString *)email
password:(NSString *)password
@@ -551,26 +525,22 @@ NS_SWIFT_NAME(Auth)
canceled. Invoked asynchronously on the main thread in the future.
@remarks Possible error codes:
- <ul>
- <li>@c FIRAuthErrorCodeInvalidEmail - Indicates the email address is malformed.
- </li>
- <li>@c FIRAuthErrorCodeEmailAlreadyInUse - Indicates the email used to attempt sign up
+
+ + `FIRAuthErrorCodeInvalidEmail` - Indicates the email address is malformed.
+ + `FIRAuthErrorCodeEmailAlreadyInUse` - Indicates the email used to attempt sign up
already exists. Call fetchProvidersForEmail to check which sign-in mechanisms the user
used, and prompt the user to sign in with one of those.
- </li>
- <li>@c FIRAuthErrorCodeOperationNotAllowed - Indicates that email and password accounts
+ + `FIRAuthErrorCodeOperationNotAllowed` - Indicates that email and password accounts
are not enabled. Enable them in the Auth section of the Firebase console.
- </li>
- <li>@c FIRAuthErrorCodeWeakPassword - Indicates an attempt to set a password that is
+ + `FIRAuthErrorCodeWeakPassword` - Indicates an attempt to set a password that is
considered too weak. The NSLocalizedFailureReasonErrorKey field in the NSError.userInfo
dictionary object will contain more detailed explanation that can be shown to the user.
- </li>
- </ul>
- @remarks See @c FIRAuthErrors for a list of error codes that are common to all API methods.
+ @remarks See `FIRAuthErrors` for a list of error codes that are common to all API methods.
+
@remarks This method will only exist until the next major Firebase release following 4.x.x.
- After the next major release the method @c createUserWithEmail:password:completion: will
- support the @c FIRAuthDataResultCallback.
+ After the next major release the method `createUserWithEmail:password:completion:` will
+ support the `FIRAuthDataResultCallback`.
*/
- (void)createUserAndRetrieveDataWithEmail:(NSString *)email
password:(NSString *)password
@@ -585,20 +555,15 @@ NS_SWIFT_NAME(Auth)
asynchronously on the main thread in the future.
@remarks Possible error codes:
- <ul>
- <li>@c FIRAuthErrorCodeWeakPassword - Indicates an attempt to set a password that is
+
+ + `FIRAuthErrorCodeWeakPassword` - Indicates an attempt to set a password that is
considered too weak.
- </li>
- <li>@c FIRAuthErrorCodeOperationNotAllowed - Indicates the administrator disabled sign
+ + `FIRAuthErrorCodeOperationNotAllowed` - Indicates the administrator disabled sign
in with the specified identity provider.
- </li>
- <li>@c FIRAuthErrorCodeExpiredActionCode - Indicates the OOB code is expired.
- </li>
- <li>@c FIRAuthErrorCodeInvalidActionCode - Indicates the OOB code is invalid.
- </li>
- </ul>
+ + `FIRAuthErrorCodeExpiredActionCode` - Indicates the OOB code is expired.
+ + `FIRAuthErrorCodeInvalidActionCode` - Indicates the OOB code is invalid.
- @remarks See @c FIRAuthErrors for a list of error codes that are common to all API methods.
+ @remarks See `FIRAuthErrors` for a list of error codes that are common to all API methods.
*/
- (void)confirmPasswordResetWithCode:(NSString *)code
newPassword:(NSString *)newPassword
@@ -644,17 +609,15 @@ NS_SWIFT_NAME(Auth)
asynchronously on the main thread in the future.
@remarks Possible error codes:
- <ul>
- <li>@c FIRAuthErrorCodeInvalidRecipientEmail - Indicates an invalid recipient email was
+
+ + `FIRAuthErrorCodeInvalidRecipientEmail` - Indicates an invalid recipient email was
sent in the request.
- </li>
- <li>@c FIRAuthErrorCodeInvalidSender - Indicates an invalid sender email is set in
+ + `FIRAuthErrorCodeInvalidSender` - Indicates an invalid sender email is set in
the console for this action.
- </li>
- <li>@c FIRAuthErrorCodeInvalidMessagePayload - Indicates an invalid email template for
+ + `FIRAuthErrorCodeInvalidMessagePayload` - Indicates an invalid email template for
sending update email.
- </li>
- </ul>
+
+
*/
- (void)sendPasswordResetWithEmail:(NSString *)email
completion:(nullable FIRSendPasswordResetCallback)completion;
@@ -663,35 +626,29 @@ NS_SWIFT_NAME(Auth)
@brief Initiates a password reset for the given email address and @FIRActionCodeSettings object.
@param email The email address of the user.
- @param actionCodeSettings An @c FIRActionCodeSettings object containing settings related to
+ @param actionCodeSettings An `FIRActionCodeSettings` object containing settings related to
handling action codes.
@param completion Optionally; a block which is invoked when the request finishes. Invoked
asynchronously on the main thread in the future.
@remarks Possible error codes:
- <ul>
- <li>@c FIRAuthErrorCodeInvalidRecipientEmail - Indicates an invalid recipient email was
+
+ + `FIRAuthErrorCodeInvalidRecipientEmail` - Indicates an invalid recipient email was
sent in the request.
- </li>
- <li>@c FIRAuthErrorCodeInvalidSender - Indicates an invalid sender email is set in
+ + `FIRAuthErrorCodeInvalidSender` - Indicates an invalid sender email is set in
the console for this action.
- </li>
- <li>@c FIRAuthErrorCodeInvalidMessagePayload - Indicates an invalid email template for
+ + `FIRAuthErrorCodeInvalidMessagePayload` - Indicates an invalid email template for
sending update email.
- </li>
- <li>@c FIRAuthErrorCodeMissingIosBundleID - Indicates that the iOS bundle ID is missing when
- @c handleCodeInApp is set to YES.
- </li>
- <li>@c FIRAuthErrorCodeMissingAndroidPackageName - Indicates that the android package name
- is missing when the @c androidInstallApp flag is set to true.
- </li>
- <li>@c FIRAuthErrorCodeUnauthorizedDomain - Indicates that the domain specified in the
+ + `FIRAuthErrorCodeMissingIosBundleID` - Indicates that the iOS bundle ID is missing when
+ `handleCodeInApp` is set to YES.
+ + `FIRAuthErrorCodeMissingAndroidPackageName` - Indicates that the android package name
+ is missing when the `androidInstallApp` flag is set to true.
+ + `FIRAuthErrorCodeUnauthorizedDomain` - Indicates that the domain specified in the
continue URL is not whitelisted in the Firebase console.
- </li>
- <li>@c FIRAuthErrorCodeInvalidContinueURI - Indicates that the domain specified in the
+ + `FIRAuthErrorCodeInvalidContinueURI` - Indicates that the domain specified in the
continue URI is not valid.
- </li>
- </ul>
+
+
*/
- (void)sendPasswordResetWithEmail:(NSString *)email
actionCodeSettings:(FIRActionCodeSettings *)actionCodeSettings
@@ -705,12 +662,12 @@ NS_SWIFT_NAME(Auth)
@return @YES when the sign out request was successful. @NO otherwise.
@remarks Possible error codes:
- <ul>
- <li>@c FIRAuthErrorCodeKeychainError - Indicates an error occurred when accessing the
- keychain. The @c NSLocalizedFailureReasonErrorKey field in the @c NSError.userInfo
+
+ + `FIRAuthErrorCodeKeychainError` - Indicates an error occurred when accessing the
+ keychain. The `NSLocalizedFailureReasonErrorKey` field in the `NSError.userInfo`
dictionary will contain more information about the error encountered.
- </li>
- </ul>
+
+
*/
- (BOOL)signOut:(NSError *_Nullable *_Nullable)error;
@@ -728,8 +685,8 @@ NS_SWIFT_NAME(Auth)
@remarks The block is invoked immediately after adding it according to it's standard invocation
semantics, asynchronously on the main thread. Users should pay special attention to
making sure the block does not inadvertently retain objects which should not be retained by
- the long-lived block. The block itself will be retained by @c FIRAuth until it is
- unregistered or until the @c FIRAuth instance is otherwise deallocated.
+ the long-lived block. The block itself will be retained by `FIRAuth` until it is
+ unregistered or until the `FIRAuth` instance is otherwise deallocated.
@return A handle useful for manually unregistering the block as a listener.
*/
@@ -757,8 +714,8 @@ NS_SWIFT_NAME(Auth)
@remarks The block is invoked immediately after adding it according to it's standard invocation
semantics, asynchronously on the main thread. Users should pay special attention to
making sure the block does not inadvertently retain objects which should not be retained by
- the long-lived block. The block itself will be retained by @c FIRAuth until it is
- unregistered or until the @c FIRAuth instance is otherwise deallocated.
+ the long-lived block. The block itself will be retained by `FIRAuth` until it is
+ unregistered or until the `FIRAuth` instance is otherwise deallocated.
@return A handle useful for manually unregistering the block as a listener.
*/
@@ -773,14 +730,14 @@ NS_SWIFT_NAME(Auth)
- (void)removeIDTokenDidChangeListener:(FIRIDTokenDidChangeListenerHandle)listenerHandle;
/** @fn useAppLanguage
- @brief Sets @c languageCode to the app's current language.
+ @brief Sets `languageCode` to the app's current language.
*/
- (void)useAppLanguage;
#if TARGET_OS_IOS
/** @fn canHandleURL:
- @brief Whether the specific URL is handled by @c FIRAuth .
+ @brief Whether the specific URL is handled by `FIRAuth` .
@param URL The URL received by the application delegate from any of the openURL method.
@return Whether or the URL is handled. YES means the URL is for Firebase Auth
so the caller should ignore the URL from further processing, and NO means the
@@ -794,12 +751,12 @@ NS_SWIFT_NAME(Auth)
/** @fn setAPNSToken:type:
@brief Sets the APNs token along with its type.
@remarks If swizzling is disabled, the APNs Token must be set for phone number auth to work,
- by either setting calling this method or by setting the @c APNSToken property.
+ by either setting calling this method or by setting the `APNSToken` property.
*/
- (void)setAPNSToken:(NSData *)token type:(FIRAuthAPNSTokenType)type;
/** @fn canHandleNotification:
- @brief Whether the specific remote notification is handled by @c FIRAuth .
+ @brief Whether the specific remote notification is handled by `FIRAuth` .
@param userInfo A dictionary that contains information related to the
notification in question.
@return Whether or the notification is handled. YES means the notification is for Firebase Auth
diff --git a/Firebase/Auth/Source/Public/FIRAuthDataResult.h b/Firebase/Auth/Source/Public/FIRAuthDataResult.h
index ba16576..bc4fa4a 100644
--- a/Firebase/Auth/Source/Public/FIRAuthDataResult.h
+++ b/Firebase/Auth/Source/Public/FIRAuthDataResult.h
@@ -29,8 +29,8 @@ NS_SWIFT_NAME(AuthDataResult)
@interface FIRAuthDataResult : NSObject
/** @fn init
- @brief This class should not be initialized manually. @c FIRAuthDataResult instance is
- returned as part of @c FIRAuthDataResultCallback .
+ @brief This class should not be initialized manually. `FIRAuthDataResult` instance is
+ returned as part of `FIRAuthDataResultCallback`.
*/
- (instancetype)init NS_UNAVAILABLE;
diff --git a/Firebase/Auth/Source/Public/FIRAuthErrors.h b/Firebase/Auth/Source/Public/FIRAuthErrors.h
index fdfee19..b8e5fb6 100644
--- a/Firebase/Auth/Source/Public/FIRAuthErrors.h
+++ b/Firebase/Auth/Source/Public/FIRAuthErrors.h
@@ -18,21 +18,21 @@
/** @class FIRAuthErrors
@remarks Error Codes common to all API Methods:
- <ul>
- <li>@c FIRAuthErrorCodeNetworkError</li>
- <li>@c FIRAuthErrorCodeUserNotFound</li>
- <li>@c FIRAuthErrorCodeUserTokenExpired</li>
- <li>@c FIRAuthErrorCodeTooManyRequests</li>
- <li>@c FIRAuthErrorCodeInvalidAPIKey</li>
- <li>@c FIRAuthErrorCodeAppNotAuthorized</li>
- <li>@c FIRAuthErrorCodeKeychainError</li>
- <li>@c FIRAuthErrorCodeInternalError</li>
- </ul>
- @remarks Common error codes for @c FIRUser operations:
- <ul>
- <li>@c FIRAuthErrorCodeInvalidUserToken</li>
- <li>@c FIRAuthErrorCodeUserDisabled</li>
- </ul>
+
+ + `FIRAuthErrorCodeNetworkError`
+ + `FIRAuthErrorCodeUserNotFound`
+ + `FIRAuthErrorCodeUserTokenExpired`
+ + `FIRAuthErrorCodeTooManyRequests`
+ + `FIRAuthErrorCodeInvalidAPIKey`
+ + `FIRAuthErrorCodeAppNotAuthorized`
+ + `FIRAuthErrorCodeKeychainError`
+ + `FIRAuthErrorCodeInternalError`
+
+ @remarks Common error codes for `FIRUser` operations:
+
+ + `FIRAuthErrorCodeInvalidUserToken`
+ + `FIRAuthErrorCodeUserDisabled`
+
*/
NS_SWIFT_NAME(AuthErrors)
@interface FIRAuthErrors
@@ -54,8 +54,8 @@ extern NSString *const FIRAuthUpdatedCredentialKey NS_SWIFT_NAME(AuthUpdatedCred
extern NSString *const FIRAuthErrorNameKey NS_SWIFT_NAME(AuthErrorNameKey);
/**
- @brief Errors with the code @c FIRAuthErrorCodeAccountExistsWithDifferentCredential may contain
- an @c NSError.userInfo dictinary object which contains this key. The value associated with
+ @brief Errors with the code `FIRAuthErrorCodeAccountExistsWithDifferentCredential` may contain
+ an `NSError.userInfo` dictinary object which contains this key. The value associated with
this key is an NSString of the email address of the account that already exists.
*/
extern NSString *const FIRAuthErrorUserInfoEmailKey NS_SWIFT_NAME(AuthErrorUserInfoEmailKey);
@@ -127,7 +127,7 @@ typedef NS_ENUM(NSInteger, FIRAuthErrorCode) {
/** Indicates a network error occurred (such as a timeout, interrupted connection, or
unreachable host). These types of errors are often recoverable with a retry. The
- @c NSUnderlyingError field in the @c NSError.userInfo dictionary will contain the error
+ `NSUnderlyingError` field in the `NSError.userInfo` dictionary will contain the error
encountered.
*/
FIRAuthErrorCodeNetworkError = 17020,
@@ -192,7 +192,7 @@ typedef NS_ENUM(NSInteger, FIRAuthErrorCode) {
*/
FIRAuthErrorCodeMissingIosBundleID = 17036,
- /** Indicates that the android package name is missing when the @c androidInstallApp flag is set
+ /** Indicates that the android package name is missing when the `androidInstallApp` flag is set
to true.
*/
FIRAuthErrorCodeMissingAndroidPackageName = 17037,
@@ -212,12 +212,12 @@ typedef NS_ENUM(NSInteger, FIRAuthErrorCode) {
FIRAuthErrorCodeMissingContinueURI = 17040,
/** Indicates that a phone number was not provided in a call to
- @c verifyPhoneNumber:completion:.
+ `verifyPhoneNumber:completion:`.
*/
FIRAuthErrorCodeMissingPhoneNumber = 17041,
/** Indicates that an invalid phone number was provided in a call to
- @c verifyPhoneNumber:completion:.
+ `verifyPhoneNumber:completion:`.
*/
FIRAuthErrorCodeInvalidPhoneNumber = 17042,
@@ -295,7 +295,7 @@ typedef NS_ENUM(NSInteger, FIRAuthErrorCode) {
*/
FIRAuthErrorCodeWebNetworkRequestFailed = 17061,
- /** Indicates that an internal error occured within a SFSafariViewController or UIWebview.
+ /** Indicates that an internal error occurred within a SFSafariViewController or UIWebview.
*/
FIRAuthErrorCodeWebInternalError = 17062,
diff --git a/Firebase/Auth/Source/Public/FIREmailAuthProvider.h b/Firebase/Auth/Source/Public/FIREmailAuthProvider.h
index 030efda..0108d40 100644
--- a/Firebase/Auth/Source/Public/FIREmailAuthProvider.h
+++ b/Firebase/Auth/Source/Public/FIREmailAuthProvider.h
@@ -26,24 +26,24 @@ NS_ASSUME_NONNULL_BEGIN
extern NSString *const FIREmailAuthProviderID NS_SWIFT_NAME(EmailAuthProviderID);
/**
- @brief please use @c FIREmailAuthProviderID instead.
+ @brief please use `FIREmailAuthProviderID` instead.
*/
extern NSString *const FIREmailPasswordAuthProviderID __attribute__((deprecated));
/** @class FIREmailAuthProvider
- @brief A concrete implementation of @c FIRAuthProvider for Email & Password Sign In.
+ @brief A concrete implementation of `FIRAuthProvider` for Email & Password Sign In.
*/
NS_SWIFT_NAME(EmailAuthProvider)
@interface FIREmailAuthProvider : NSObject
/** @typedef FIREmailPasswordAuthProvider
- @brief Please use @c FIREmailAuthProvider instead.
+ @brief Please use `FIREmailAuthProvider` instead.
*/
typedef FIREmailAuthProvider FIREmailPasswordAuthProvider __attribute__((deprecated));
/** @fn credentialWithEmail:password:
- @brief Creates an @c FIRAuthCredential for an email & password sign in.
+ @brief Creates an `FIRAuthCredential` for an email & password sign in.
@param email The user's email address.
@param password The user's password.
diff --git a/Firebase/Auth/Source/Public/FIRFacebookAuthProvider.h b/Firebase/Auth/Source/Public/FIRFacebookAuthProvider.h
index dae90dc..f08740f 100644
--- a/Firebase/Auth/Source/Public/FIRFacebookAuthProvider.h
+++ b/Firebase/Auth/Source/Public/FIRFacebookAuthProvider.h
@@ -32,7 +32,7 @@ NS_SWIFT_NAME(FacebookAuthProvider)
@interface FIRFacebookAuthProvider : NSObject
/** @fn credentialWithAccessToken:
- @brief Creates an @c FIRAuthCredential for a Facebook sign in.
+ @brief Creates an `FIRAuthCredential` for a Facebook sign in.
@param accessToken The Access Token from Facebook.
@return A FIRAuthCredential containing the Facebook credentials.
diff --git a/Firebase/Auth/Source/Public/FIRGitHubAuthProvider.h b/Firebase/Auth/Source/Public/FIRGitHubAuthProvider.h
index 0da3142..f0b5dbe 100644
--- a/Firebase/Auth/Source/Public/FIRGitHubAuthProvider.h
+++ b/Firebase/Auth/Source/Public/FIRGitHubAuthProvider.h
@@ -32,7 +32,7 @@ NS_SWIFT_NAME(GitHubAuthProvider)
@interface FIRGitHubAuthProvider : NSObject
/** @fn credentialWithToken:
- @brief Creates an @c FIRAuthCredential for a GitHub sign in.
+ @brief Creates an `FIRAuthCredential` for a GitHub sign in.
@param token The GitHub OAuth access token.
@return A FIRAuthCredential containing the GitHub credential.
diff --git a/Firebase/Auth/Source/Public/FIRGoogleAuthProvider.h b/Firebase/Auth/Source/Public/FIRGoogleAuthProvider.h
index 1386c04..e80d87e 100644
--- a/Firebase/Auth/Source/Public/FIRGoogleAuthProvider.h
+++ b/Firebase/Auth/Source/Public/FIRGoogleAuthProvider.h
@@ -32,7 +32,7 @@ NS_SWIFT_NAME(GoogleAuthProvider)
@interface FIRGoogleAuthProvider : NSObject
/** @fn credentialWithIDToken:accessToken:
- @brief Creates an @c FIRAuthCredential for a Google sign in.
+ @brief Creates an `FIRAuthCredential` for a Google sign in.
@param IDToken The ID Token from Google.
@param accessToken The Access Token from Google.
diff --git a/Firebase/Auth/Source/Public/FIROAuthProvider.h b/Firebase/Auth/Source/Public/FIROAuthProvider.h
index b20d9b6..cc628f8 100644
--- a/Firebase/Auth/Source/Public/FIROAuthProvider.h
+++ b/Firebase/Auth/Source/Public/FIROAuthProvider.h
@@ -21,13 +21,13 @@
NS_ASSUME_NONNULL_BEGIN
/** @class FIROAuthProvider
- @brief A concrete implementation of @c FIRAuthProvider for generic OAuth Providers.
+ @brief A concrete implementation of `FIRAuthProvider` for generic OAuth Providers.
*/
NS_SWIFT_NAME(OAuthProvider)
@interface FIROAuthProvider : NSObject
/** @fn credentialWithProviderID:IDToken:accessToken:
- @brief Creates an @c FIRAuthCredential for that OAuth 2 provider identified by providerID, ID
+ @brief Creates an `FIRAuthCredential` for that OAuth 2 provider identified by providerID, ID
token and access token.
@param providerID The provider ID associated with the Auth credential being created.
@@ -42,7 +42,7 @@ NS_SWIFT_NAME(OAuthProvider)
/** @fn credentialWithProviderID:accessToken:
- @brief Creates an @c FIRAuthCredential for that OAuth 2 provider identified by providerID using
+ @brief Creates an `FIRAuthCredential` for that OAuth 2 provider identified by providerID using
an ID token.
@param providerID The provider ID associated with the Auth credential being created.
diff --git a/Firebase/Auth/Source/Public/FIRPhoneAuthProvider.h b/Firebase/Auth/Source/Public/FIRPhoneAuthProvider.h
index 2d6d698..34db683 100644
--- a/Firebase/Auth/Source/Public/FIRPhoneAuthProvider.h
+++ b/Firebase/Auth/Source/Public/FIRPhoneAuthProvider.h
@@ -38,47 +38,44 @@ typedef void (^FIRVerificationResultCallback)(NSString *_Nullable verificationID
NS_SWIFT_NAME(VerificationResultCallback);
/** @class FIRPhoneAuthProvider
- @brief A concrete implementation of @c FIRAuthProvider for phone auth providers.
+ @brief A concrete implementation of `FIRAuthProvider` for phone auth providers.
*/
NS_SWIFT_NAME(PhoneAuthProvider)
@interface FIRPhoneAuthProvider : NSObject
/** @fn provider
- @brief Returns an instance of @c FIRPhoneAuthProvider for the default @c FIRAuth object.
+ @brief Returns an instance of `FIRPhoneAuthProvider` for the default `FIRAuth` object.
*/
+ (instancetype)provider NS_SWIFT_NAME(provider());
/** @fn providerWithAuth:
- @brief Returns an instance of @c FIRPhoneAuthProvider for the provided @c FIRAuth object.
+ @brief Returns an instance of `FIRPhoneAuthProvider` for the provided `FIRAuth` object.
@param auth The auth object to associate with the phone auth provider instance.
*/
+ (instancetype)providerWithAuth:(FIRAuth *)auth NS_SWIFT_NAME(provider(auth:));
/** @fn verifyPhoneNumber:completion:
- @brief Please use @c verifyPhoneNumber:UIDelegate:completion: instead.
+ @brief Please use `verifyPhoneNumber:UIDelegate:completion:` instead.
@param phoneNumber The phone number to be verified.
@param completion The callback to be invoked when the verification flow is finished.
@remarks Possible error codes:
- <ul>
- <li>@c FIRAuthErrorCodeAppNotVerified - Indicates that Firebase could not retrieve the
- silent push notification and therefore could not verify your app.</li>
- <li>@c FIRAuthErrorCodeInvalidAppCredential - Indicates that The APNs device token provided
+
+ + `FIRAuthErrorCodeAppNotVerified` - Indicates that Firebase could not retrieve the
+ silent push notification and therefore could not verify your app.
+ + `FIRAuthErrorCodeInvalidAppCredential` - Indicates that The APNs device token provided
is either incorrect or does not match the private certificate uploaded to the Firebase
- Console.</li>
- <li>@c FIRAuthErrorCodeQuotaExceeded - Indicates that the phone verification quota for this
- project has been exceeded.</li>
- <li>@c FIRAuthErrorCodeInvalidPhoneNumber - Indicates that the phone number provided is
- invalid.</li>
- <li>@c FIRAuthErrorCodeMissingPhoneNumber - Indicates that a phone number was not provided.
- </li>
- <li>@c FIRAuthErrorCodeMissingAppToken - Indicates that the APNs device token could not be
+ Console.
+ + `FIRAuthErrorCodeQuotaExceeded` - Indicates that the phone verification quota for this
+ project has been exceeded.
+ + `FIRAuthErrorCodeInvalidPhoneNumber` - Indicates that the phone number provided is
+ invalid.
+ + `FIRAuthErrorCodeMissingPhoneNumber` - Indicates that a phone number was not provided.
+ + `FIRAuthErrorCodeMissingAppToken` - Indicates that the APNs device token could not be
obtained. The app may not have set up remote notification correctly, or may fail to
forward the APNs device token to FIRAuth if app delegate swizzling is disabled.
- </li>
- </ul>
*/
- (void)verifyPhoneNumber:(NSString *)phoneNumber
completion:(nullable FIRVerificationResultCallback)completion
@@ -92,23 +89,21 @@ NS_SWIFT_NAME(PhoneAuthProvider)
by this method until the completion block is executed.
@param completion The callback to be invoked when the verification flow is finished.
@remarks Possible error codes:
- <ul>
- <li>@c FIRAuthErrorCodeCaptchaCheckFailed - Indicates that the reCAPTCHA token obtained by
- the Firebase Auth is invalid or has expired.</li>
- <li>@c FIRAuthErrorCodeQuotaExceeded - Indicates that the phone verification quota for this
- project has been exceeded.</li>
- <li>@c FIRAuthErrorCodeInvalidPhoneNumber - Indicates that the phone number provided is
- invalid.</li>
- <li>@c FIRAuthErrorCodeMissingPhoneNumber - Indicates that a phone number was not provided.
- </li>
- </ul>
+
+ + `FIRAuthErrorCodeCaptchaCheckFailed` - Indicates that the reCAPTCHA token obtained by
+ the Firebase Auth is invalid or has expired.
+ + `FIRAuthErrorCodeQuotaExceeded` - Indicates that the phone verification quota for this
+ project has been exceeded.
+ + `FIRAuthErrorCodeInvalidPhoneNumber` - Indicates that the phone number provided is
+ invalid.
+ + `FIRAuthErrorCodeMissingPhoneNumber` - Indicates that a phone number was not provided.
*/
- (void)verifyPhoneNumber:(NSString *)phoneNumber
UIDelegate:(nullable id<FIRAuthUIDelegate>)UIDelegate
completion:(nullable FIRVerificationResultCallback)completion;
/** @fn credentialWithVerificationID:verificationCode:
- @brief Creates an @c FIRAuthCredential for the phone number provider identified by the
+ @brief Creates an `FIRAuthCredential` for the phone number provider identified by the
verification ID and verification code.
@param verificationID The verification ID obtained from invoking
@@ -121,8 +116,8 @@ NS_SWIFT_NAME(PhoneAuthProvider)
verificationCode:(NSString *)verificationCode;
/** @fn init
- @brief Please use the @c provider or @c providerWithAuth: methods to obtain an instance of
- @c FIRPhoneAuthProvider.
+ @brief Please use the `provider` or `providerWithAuth:` methods to obtain an instance of
+ `FIRPhoneAuthProvider`.
*/
- (instancetype)init NS_UNAVAILABLE;
diff --git a/Firebase/Auth/Source/Public/FIRTwitterAuthProvider.h b/Firebase/Auth/Source/Public/FIRTwitterAuthProvider.h
index 4200753..2ef32f7 100644
--- a/Firebase/Auth/Source/Public/FIRTwitterAuthProvider.h
+++ b/Firebase/Auth/Source/Public/FIRTwitterAuthProvider.h
@@ -32,7 +32,7 @@ NS_SWIFT_NAME(TwitterAuthProvider)
@interface FIRTwitterAuthProvider : NSObject
/** @fn credentialWithToken:secret:
- @brief Creates an @c FIRAuthCredential for a Twitter sign in.
+ @brief Creates an `FIRAuthCredential` for a Twitter sign in.
@param token The Twitter OAuth token.
@param secret The Twitter OAuth secret.
diff --git a/Firebase/Auth/Source/Public/FIRUser.h b/Firebase/Auth/Source/Public/FIRUser.h
index 7e22329..1bba710 100644
--- a/Firebase/Auth/Source/Public/FIRUser.h
+++ b/Firebase/Auth/Source/Public/FIRUser.h
@@ -34,7 +34,7 @@ NS_ASSUME_NONNULL_BEGIN
@param token Optionally; an access token if the request was successful.
@param error Optionally; the error which occurred - or nil if the request was successful.
- @remarks One of: @c token or @c error will always be non-nil.
+ @remarks One of: `token` or `error` will always be non-nil.
*/
typedef void (^FIRAuthTokenCallback)(NSString *_Nullable token, NSError *_Nullable error)
NS_SWIFT_NAME(AuthTokenCallback);
@@ -91,8 +91,8 @@ NS_SWIFT_NAME(User)
/** @fn init
@brief This class should not be instantiated.
- @remarks To retrieve the current user, use @c FIRAuth.currentUser. To sign a user
- in or out, use the methods on @c FIRAuth.
+ @remarks To retrieve the current user, use `FIRAuth.currentUser`. To sign a user
+ in or out, use the methods on `FIRAuth`.
*/
- (instancetype)init NS_UNAVAILABLE;
@@ -107,29 +107,22 @@ NS_SWIFT_NAME(User)
Invoked asynchronously on the main thread in the future.
@remarks Possible error codes:
- <ul>
- <li>@c FIRAuthErrorCodeInvalidRecipientEmail - Indicates an invalid recipient email was
+
+ + `FIRAuthErrorCodeInvalidRecipientEmail` - Indicates an invalid recipient email was
sent in the request.
- </li>
- <li>@c FIRAuthErrorCodeInvalidSender - Indicates an invalid sender email is set in
+ + `FIRAuthErrorCodeInvalidSender` - Indicates an invalid sender email is set in
the console for this action.
- </li>
- <li>@c FIRAuthErrorCodeInvalidMessagePayload - Indicates an invalid email template for
+ + `FIRAuthErrorCodeInvalidMessagePayload` - Indicates an invalid email template for
sending update email.
- </li>
- <li>@c FIRAuthErrorCodeEmailAlreadyInUse - Indicates the email is already in use by another
+ + `FIRAuthErrorCodeEmailAlreadyInUse` - Indicates the email is already in use by another
account.
- </li>
- <li>@c FIRAuthErrorCodeInvalidEmail - Indicates the email address is malformed.
- </li>
- <li>@c FIRAuthErrorCodeRequiresRecentLogin - Updating a user’s email is a security
+ + `FIRAuthErrorCodeInvalidEmail` - Indicates the email address is malformed.
+ + `FIRAuthErrorCodeRequiresRecentLogin` - Updating a user’s email is a security
sensitive operation that requires a recent login from the user. This error indicates
the user has not signed in recently enough. To resolve, reauthenticate the user by
invoking reauthenticateWithCredential:completion: on FIRUser.
- </li>
- </ul>
- @remarks See @c FIRAuthErrors for a list of error codes that are common to all FIRUser methods.
+ @remarks See `FIRAuthErrors` for a list of error codes that are common to all FIRUser methods.
*/
- (void)updateEmail:(NSString *)email completion:(nullable FIRUserProfileChangeCallback)completion
NS_SWIFT_NAME(updateEmail(to:completion:));
@@ -142,22 +135,18 @@ NS_SWIFT_NAME(User)
Invoked asynchronously on the main thread in the future.
@remarks Possible error codes:
- <ul>
- <li>@c FIRAuthErrorCodeOperationNotAllowed - Indicates the administrator disabled
+
+ + `FIRAuthErrorCodeOperationNotAllowed` - Indicates the administrator disabled
sign in with the specified identity provider.
- </li>
- <li>@c FIRAuthErrorCodeRequiresRecentLogin - Updating a user’s password is a security
+ + `FIRAuthErrorCodeRequiresRecentLogin` - Updating a user’s password is a security
sensitive operation that requires a recent login from the user. This error indicates
the user has not signed in recently enough. To resolve, reauthenticate the user by
invoking reauthenticateWithCredential:completion: on FIRUser.
- </li>
- <li>@c FIRAuthErrorCodeWeakPassword - Indicates an attempt to set a password that is
+ + `FIRAuthErrorCodeWeakPassword` - Indicates an attempt to set a password that is
considered too weak. The NSLocalizedFailureReasonErrorKey field in the NSError.userInfo
dictionary object will contain more detailed explanation that can be shown to the user.
- </li>
- </ul>
- @remarks See @c FIRAuthErrors for a list of error codes that are common to all FIRUser methods.
+ @remarks See `FIRAuthErrors` for a list of error codes that are common to all FIRUser methods.
*/
- (void)updatePassword:(NSString *)password
completion:(nullable FIRUserProfileChangeCallback)completion
@@ -175,15 +164,13 @@ NS_SWIFT_NAME(User)
Invoked asynchronously on the main thread in the future.
@remarks Possible error codes:
- <ul>
- <li>@c FIRAuthErrorCodeRequiresRecentLogin - Updating a user’s phone number is a security
+
+ + `FIRAuthErrorCodeRequiresRecentLogin` - Updating a user’s phone number is a security
sensitive operation that requires a recent login from the user. This error indicates
the user has not signed in recently enough. To resolve, reauthenticate the user by
invoking reauthenticateWithCredential:completion: on FIRUser.
- </li>
- </ul>
- @remarks See @c FIRAuthErrors for a list of error codes that are common to all FIRUser methods.
+ @remarks See `FIRAuthErrors` for a list of error codes that are common to all FIRUser methods.
*/
- (void)updatePhoneNumberCredential:(FIRPhoneAuthCredential *)phoneNumberCredential
completion:(nullable FIRUserProfileChangeCallback)completion;
@@ -193,7 +180,7 @@ NS_SWIFT_NAME(User)
@brief Creates an object which may be used to change the user's profile data.
@remarks Set the properties of the returned object, then call
- @c FIRUserProfileChangeRequest.commitChangesWithCallback: to perform the updates atomically.
+ `FIRUserProfileChangeRequest.commitChangesWithCallback:` to perform the updates atomically.
@return An object which may be used to change the user's profile data atomically.
*/
@@ -205,16 +192,16 @@ NS_SWIFT_NAME(User)
@param completion Optionally; the block invoked when the reload has finished. Invoked
asynchronously on the main thread in the future.
- @remarks May fail with a @c FIRAuthErrorCodeRequiresRecentLogin error code. In this case
- you should call @c FIRUser.reauthenticateWithCredential:completion: before re-invoking
- @c FIRUser.updateEmail:completion:.
+ @remarks May fail with a `FIRAuthErrorCodeRequiresRecentLogin` error code. In this case
+ you should call `FIRUser.reauthenticateWithCredential:completion:` before re-invoking
+ `FIRUser.updateEmail:completion:`.
- @remarks See @c FIRAuthErrors for a list of error codes that are common to all API methods.
+ @remarks See `FIRAuthErrors` for a list of error codes that are common to all API methods.
*/
- (void)reloadWithCompletion:(nullable FIRUserProfileChangeCallback)completion;
/** @fn reauthenticateWithCredential:completion:
- @brief Convenience method for @c reauthenticateAndRetrieveDataWithCredential:completion: This
+ @brief Convenience method for `reauthenticateAndRetrieveDataWithCredential:completion:` This
method doesn't return additional identity provider data.
*/
- (void)reauthenticateWithCredential:(FIRAuthCredential *)credential
@@ -234,33 +221,27 @@ NS_SWIFT_NAME(User)
user remains signed in.
@remarks Possible error codes:
- <ul>
- <li>@c FIRAuthErrorCodeInvalidCredential - Indicates the supplied credential is invalid.
+
+ + `FIRAuthErrorCodeInvalidCredential` - Indicates the supplied credential is invalid.
This could happen if it has expired or it is malformed.
- </li>
- <li>@c FIRAuthErrorCodeOperationNotAllowed - Indicates that accounts with the
+ + `FIRAuthErrorCodeOperationNotAllowed` - Indicates that accounts with the
identity provider represented by the credential are not enabled. Enable them in the
Auth section of the Firebase console.
- </li>
- <li>@c FIRAuthErrorCodeEmailAlreadyInUse - Indicates the email asserted by the credential
+ + `FIRAuthErrorCodeEmailAlreadyInUse` - Indicates the email asserted by the credential
(e.g. the email in a Facebook access token) is already in use by an existing account,
that cannot be authenticated with this method. Call fetchProvidersForEmail for
this user’s email and then prompt them to sign in with any of the sign-in providers
returned. This error will only be thrown if the "One account per email address"
setting is enabled in the Firebase console, under Auth settings. Please note that the
error code raised in this specific situation may not be the same on Web and Android.
- </li>
- <li>@c FIRAuthErrorCodeUserDisabled - Indicates the user's account is disabled.
- </li>
- <li>@c FIRAuthErrorCodeWrongPassword - Indicates the user attempted reauthentication with
+ + `FIRAuthErrorCodeUserDisabled` - Indicates the user's account is disabled.
+ + `FIRAuthErrorCodeWrongPassword` - Indicates the user attempted reauthentication with
an incorrect password, if credential is of the type EmailPasswordAuthCredential.
- </li>
- <li>@c FIRAuthErrorCodeUserMismatch - Indicates that an attempt was made to
+ + `FIRAuthErrorCodeUserMismatch` - Indicates that an attempt was made to
reauthenticate with a user which is not the current user.
- </li>
- <li>@c FIRAuthErrorCodeInvalidEmail - Indicates the email address is malformed.</li>
- </ul>
- @remarks See @c FIRAuthErrors for a list of error codes that are common to all API methods.
+ + `FIRAuthErrorCodeInvalidEmail` - Indicates the email address is malformed.
+
+ @remarks See `FIRAuthErrors` for a list of error codes that are common to all API methods.
*/
- (void)reauthenticateAndRetrieveDataWithCredential:(FIRAuthCredential *) credential
completion:(nullable FIRAuthDataResultCallback) completion;
@@ -271,18 +252,18 @@ NS_SWIFT_NAME(User)
@param completion Optionally; the block invoked when the token is available. Invoked
asynchronously on the main thread in the future.
- @remarks See @c FIRAuthErrors for a list of error codes that are common to all API methods.
+ @remarks See `FIRAuthErrors` for a list of error codes that are common to all API methods.
*/
- (void)getIDTokenWithCompletion:(nullable FIRAuthTokenCallback)completion
NS_SWIFT_NAME(getIDToken(completion:));
/** @fn getTokenWithCompletion:
- @brief Please use @c getIDTokenWithCompletion: instead.
+ @brief Please use `getIDTokenWithCompletion:` instead.
@param completion Optionally; the block invoked when the token is available. Invoked
asynchronously on the main thread in the future.
- @remarks See @c FIRAuthErrors for a list of error codes that are common to all API methods.
+ @remarks See `FIRAuthErrors` for a list of error codes that are common to all API methods.
*/
- (void)getTokenWithCompletion:(nullable FIRAuthTokenCallback)completion
NS_SWIFT_NAME(getToken(completion:)) __attribute__((deprecated));
@@ -296,9 +277,9 @@ NS_SWIFT_NAME(User)
asynchronously on the main thread in the future.
@remarks The authentication token will be refreshed (by making a network request) if it has
- expired, or if @c forceRefresh is YES.
+ expired, or if `forceRefresh` is YES.
- @remarks See @c FIRAuthErrors for a list of error codes that are common to all API methods.
+ @remarks See `FIRAuthErrors` for a list of error codes that are common to all API methods.
*/
- (void)getIDTokenForcingRefresh:(BOOL)forceRefresh
completion:(nullable FIRAuthTokenCallback)completion;
@@ -312,16 +293,16 @@ NS_SWIFT_NAME(User)
asynchronously on the main thread in the future.
@remarks The authentication token will be refreshed (by making a network request) if it has
- expired, or if @c forceRefresh is YES.
+ expired, or if `forceRefresh` is YES.
- @remarks See @c FIRAuthErrors for a list of error codes that are common to all API methods.
+ @remarks See `FIRAuthErrors` for a list of error codes that are common to all API methods.
*/
- (void)getTokenForcingRefresh:(BOOL)forceRefresh
completion:(nullable FIRAuthTokenCallback)completion
__attribute__((deprecated));
/** @fn linkWithCredential:completion:
- @brief Convenience method for @c linkAndRetrieveDataWithCredential:completion: This method
+ @brief Convenience method for `linkAndRetrieveDataWithCredential:completion:` This method
doesn't return additional identity provider data.
*/
- (void)linkWithCredential:(FIRAuthCredential *)credential
@@ -336,24 +317,20 @@ NS_SWIFT_NAME(User)
Invoked asynchronously on the main thread in the future.
@remarks Possible error codes:
- <ul>
- <li>@c FIRAuthErrorCodeProviderAlreadyLinked - Indicates an attempt to link a provider of a
+
+ + `FIRAuthErrorCodeProviderAlreadyLinked` - Indicates an attempt to link a provider of a
type already linked to this account.
- </li>
- <li>@c FIRAuthErrorCodeCredentialAlreadyInUse - Indicates an attempt to link with a
+ + `FIRAuthErrorCodeCredentialAlreadyInUse` - Indicates an attempt to link with a
credential
that has already been linked with a different Firebase account.
- </li>
- <li>@c FIRAuthErrorCodeOperationNotAllowed - Indicates that accounts with the identity
+ + `FIRAuthErrorCodeOperationNotAllowed` - Indicates that accounts with the identity
provider represented by the credential are not enabled. Enable them in the Auth section
of the Firebase console.
- </li>
- </ul>
@remarks This method may also return error codes associated with updateEmail:completion: and
updatePassword:completion: on FIRUser.
- @remarks See @c FIRAuthErrors for a list of error codes that are common to all FIRUser methods.
+ @remarks See `FIRAuthErrors` for a list of error codes that are common to all FIRUser methods.
*/
- (void)linkAndRetrieveDataWithCredential:(FIRAuthCredential *) credential
completion:(nullable FIRAuthDataResultCallback) completion;
@@ -366,18 +343,15 @@ NS_SWIFT_NAME(User)
Invoked asynchronously on the main thread in the future.
@remarks Possible error codes:
- <ul>
- <li>@c FIRAuthErrorCodeNoSuchProvider - Indicates an attempt to unlink a provider
+
+ + `FIRAuthErrorCodeNoSuchProvider` - Indicates an attempt to unlink a provider
that is not linked to the account.
- </li>
- <li>@c FIRAuthErrorCodeRequiresRecentLogin - Updating email is a security sensitive
+ + `FIRAuthErrorCodeRequiresRecentLogin` - Updating email is a security sensitive
operation that requires a recent login from the user. This error indicates the user
has not signed in recently enough. To resolve, reauthenticate the user by invoking
reauthenticateWithCredential:completion: on FIRUser.
- </li>
- </ul>
- @remarks See @c FIRAuthErrors for a list of error codes that are common to all FIRUser methods.
+ @remarks See `FIRAuthErrors` for a list of error codes that are common to all FIRUser methods.
*/
- (void)unlinkFromProvider:(NSString *)provider
completion:(nullable FIRAuthResultCallback)completion;
@@ -389,54 +363,42 @@ NS_SWIFT_NAME(User)
is complete, or fails. Invoked asynchronously on the main thread in the future.
@remarks Possible error codes:
- <ul>
- <li>@c FIRAuthErrorCodeInvalidRecipientEmail - Indicates an invalid recipient email was
+
+ + `FIRAuthErrorCodeInvalidRecipientEmail` - Indicates an invalid recipient email was
sent in the request.
- </li>
- <li>@c FIRAuthErrorCodeInvalidSender - Indicates an invalid sender email is set in
+ + `FIRAuthErrorCodeInvalidSender` - Indicates an invalid sender email is set in
the console for this action.
- </li>
- <li>@c FIRAuthErrorCodeInvalidMessagePayload - Indicates an invalid email template for
+ + `FIRAuthErrorCodeInvalidMessagePayload` - Indicates an invalid email template for
sending update email.
- </li>
- <li>@c FIRAuthErrorCodeUserNotFound - Indicates the user account was not found.</li>
- </ul>
+ + `FIRAuthErrorCodeUserNotFound` - Indicates the user account was not found.
- @remarks See @c FIRAuthErrors for a list of error codes that are common to all FIRUser methods.
+ @remarks See `FIRAuthErrors` for a list of error codes that are common to all FIRUser methods.
*/
- (void)sendEmailVerificationWithCompletion:(nullable FIRSendEmailVerificationCallback)completion;
/** @fn sendEmailVerificationWithActionCodeSettings:completion:
@brief Initiates email verification for the user.
- @param actionCodeSettings An @c FIRActionCodeSettings object containing settings related to
+ @param actionCodeSettings An `FIRActionCodeSettings` object containing settings related to
handling action codes.
@remarks Possible error codes:
- <ul>
- <li>@c FIRAuthErrorCodeInvalidRecipientEmail - Indicates an invalid recipient email was
+
+ + `FIRAuthErrorCodeInvalidRecipientEmail` - Indicates an invalid recipient email was
sent in the request.
- </li>
- <li>@c FIRAuthErrorCodeInvalidSender - Indicates an invalid sender email is set in
+ + `FIRAuthErrorCodeInvalidSender` - Indicates an invalid sender email is set in
the console for this action.
- </li>
- <li>@c FIRAuthErrorCodeInvalidMessagePayload - Indicates an invalid email template for
+ + `FIRAuthErrorCodeInvalidMessagePayload` - Indicates an invalid email template for
sending update email.
- </li>
- <li>@c FIRAuthErrorCodeUserNotFound - Indicates the user account was not found.</li>
- <li>@c FIRAuthErrorCodeMissingIosBundleID - Indicates that the iOS bundle ID is missing when
+ + `FIRAuthErrorCodeUserNotFound` - Indicates the user account was not found.
+ + `FIRAuthErrorCodeMissingIosBundleID` - Indicates that the iOS bundle ID is missing when
a iOS App Store ID is provided.
- </li>
- <li>@c FIRAuthErrorCodeMissingAndroidPackageName - Indicates that the android package name
- is missing when the @c androidInstallApp flag is set to true.
- </li>
- <li>@c FIRAuthErrorCodeUnauthorizedDomain - Indicates that the domain specified in the
+ + `FIRAuthErrorCodeMissingAndroidPackageName` - Indicates that the android package name
+ is missing when the `androidInstallApp` flag is set to true.
+ + `FIRAuthErrorCodeUnauthorizedDomain` - Indicates that the domain specified in the
continue URL is not whitelisted in the Firebase console.
- </li>
- <li>@c FIRAuthErrorCodeInvalidContinueURI - Indicates that the domain specified in the
+ + `FIRAuthErrorCodeInvalidContinueURI` - Indicates that the domain specified in the
continue URI is not valid.
- </li>
- </ul>
*/
- (void)sendEmailVerificationWithActionCodeSettings:(FIRActionCodeSettings *)actionCodeSettings
completion:(nullable FIRSendEmailVerificationCallback)
@@ -449,15 +411,13 @@ NS_SWIFT_NAME(User)
complete, or fails. Invoked asynchronously on the main thread in the future.
@remarks Possible error codes:
- <ul>
- <li>@c FIRAuthErrorCodeRequiresRecentLogin - Updating email is a security sensitive
+
+ + `FIRAuthErrorCodeRequiresRecentLogin` - Updating email is a security sensitive
operation that requires a recent login from the user. This error indicates the user
has not signed in recently enough. To resolve, reauthenticate the user by invoking
reauthenticateWithCredential:completion: on FIRUser.
- </li>
- </ul>
- @remarks See @c FIRAuthErrors for a list of error codes that are common to all FIRUser methods.
+ @remarks See `FIRAuthErrors` for a list of error codes that are common to all FIRUser methods.
*/
- (void)deleteWithCompletion:(nullable FIRUserProfileChangeCallback)completion;
@@ -473,21 +433,21 @@ NS_SWIFT_NAME(UserProfileChangeRequest)
@interface FIRUserProfileChangeRequest : NSObject
/** @fn init
- @brief Please use @c FIRUser.profileChangeRequest
+ @brief Please use `FIRUser.profileChangeRequest`
*/
- (instancetype)init NS_UNAVAILABLE;
/** @property displayName
@brief The user's display name.
@remarks It is an error to set this property after calling
- @c FIRUserProfileChangeRequest.commitChangesWithCallback:
+ `FIRUserProfileChangeRequest.commitChangesWithCallback:`
*/
@property(nonatomic, copy, nullable) NSString *displayName;
/** @property photoURL
@brief The user's photo URL.
@remarks It is an error to set this property after calling
- @c FIRUserProfileChangeRequest.commitChangesWithCallback:
+ `FIRUserProfileChangeRequest.commitChangesWithCallback:`
*/
@property(nonatomic, copy, nullable) NSURL *photoURL;