diff options
Diffstat (limited to 'Firebase/Auth/Source/Public/FIRAuth.h')
| -rw-r--r-- | Firebase/Auth/Source/Public/FIRAuth.h | 299 |
1 files changed, 128 insertions, 171 deletions
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 |