diff options
author | 2017-05-24 13:28:48 -0700 | |
---|---|---|
committer | 2017-05-24 13:28:48 -0700 | |
commit | db7f85b9d43906adb99524185d7c375d2161c152 (patch) | |
tree | bf515e1fb559edba1bc35ce4d1a717c6799f440c /Firebase/Auth/Source/AuthProviders | |
parent | f67c074ed154e6ce2cfd949cc797e7cc7b72490f (diff) |
Update FIRPhoneAuthProvider reference docs (#27)
Adds reference docs error documentation to FIRPhoneAuthProvider.
Also fixes small typo in FIRAuthErrorUtils.
Diffstat (limited to 'Firebase/Auth/Source/AuthProviders')
-rw-r--r-- | Firebase/Auth/Source/AuthProviders/Phone/FIRPhoneAuthProvider.h | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/Firebase/Auth/Source/AuthProviders/Phone/FIRPhoneAuthProvider.h b/Firebase/Auth/Source/AuthProviders/Phone/FIRPhoneAuthProvider.h index 6102822..402edb5 100644 --- a/Firebase/Auth/Source/AuthProviders/Phone/FIRPhoneAuthProvider.h +++ b/Firebase/Auth/Source/AuthProviders/Phone/FIRPhoneAuthProvider.h @@ -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; |