Skip to content

Commit 4ad418d

Browse files
protocol86XiangtianDai
authored andcommitted
update_FIRPhoneAuthProvider_rederence_docs (#78)
Adds reference docs error documentation to FIRPhoneAuthProvider. Also fixes small typo in FIRAuthErrorUtils.
1 parent 3313fd2 commit 4ad418d

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed

Firebase/Auth/Source/AuthProviders/Phone/FIRPhoneAuthProvider.h

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,25 @@ FIR_SWIFT_NAME(PhoneAuthProvider)
6262
6363
@param phoneNumber The phone number to be verified.
6464
@param completion The callback to be invoked when the verification flow is finished.
65+
66+
@remarks Possible error codes:
67+
<ul>
68+
<li>@c FIRAuthErrorCodeAppNotVerified - Indicates that Firebase could not retrieve the
69+
silent push notification and therefore could not verify your app.</li>
70+
<li>@c FIRAuthErrorCodeInvalidAppCredential - Indicates that The APNs device token provided
71+
is either incorrect or does not match the private certificate uploaded to the Firebase
72+
Console.</li>
73+
<li>@c FIRAuthErrorCodeQuotaExceeded - Indicates that the phone verification quota for this
74+
project has been exceeded.</li>
75+
<li>@c FIRAuthErrorCodeInvalidPhoneNumber - Indicates that the phone number provided is
76+
invalid.</li>
77+
<li>@c FIRAuthErrorCodeMissingPhoneNumber - Indicates that a phone number was not provided.
78+
</li>
79+
<li>@c FIRAuthErrorCodeMissingAppToken - Indicates that the APNs device token could not be
80+
obtained. The app may not have set up remote notification correctly, or may fail to
81+
forward the APNs device token to FIRAuth if app delegate swizzling is disabled.
82+
</li>
83+
</ul>
6584
*/
6685
- (void)verifyPhoneNumber:(NSString *)phoneNumber
6786
completion:(nullable FIRVerificationResultCallback)completion;

Firebase/Auth/Source/FIRAuthErrorUtils.m

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@
230230
@"To send verification codes, provide a phone number for the recipient.";
231231

232232
/** @var kFIRAuthErrorMessageInvalidPhoneNumber
233-
@brief Message for @c FIRAuthErrorCodeMissingPhoneNumber error code.
233+
@brief Message for @c FIRAuthErrorCodeInvalidPhoneNumber error code.
234234
*/
235235
static NSString *const kFIRAuthErrorMessageInvalidPhoneNumber =
236236
@"The format of the phone number provided is incorrect. Please enter the phone number in a "

0 commit comments

Comments
 (0)