aboutsummaryrefslogtreecommitdiffhomepage
path: root/Firebase/Auth/Source/Public/FIRPhoneAuthProvider.h
diff options
context:
space:
mode:
Diffstat (limited to 'Firebase/Auth/Source/Public/FIRPhoneAuthProvider.h')
-rw-r--r--Firebase/Auth/Source/Public/FIRPhoneAuthProvider.h57
1 files changed, 26 insertions, 31 deletions
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;