Skip to content

Update FIRPhoneAuthProvider reference docs #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 24, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions Firebase/Auth/Source/AuthProviders/Phone/FIRPhoneAuthProvider.h
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,25 @@ FIR_SWIFT_NAME(PhoneAuthProvider)

@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
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
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;
Expand Down
2 changes: 1 addition & 1 deletion Firebase/Auth/Source/FIRAuthErrorUtils.m
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@
@"To send verification codes, provide a phone number for the recipient.";

/** @var kFIRAuthErrorMessageInvalidPhoneNumber
@brief Message for @c FIRAuthErrorCodeMissingPhoneNumber error code.
@brief Message for @c FIRAuthErrorCodeInvalidPhoneNumber error code.
*/
static NSString *const kFIRAuthErrorMessageInvalidPhoneNumber =
@"The format of the phone number provided is incorrect. Please enter the phone number in a "
Expand Down