From db7f85b9d43906adb99524185d7c375d2161c152 Mon Sep 17 00:00:00 2001
From: Paul Beusterien <paulbeusterien@google.com>
Date: Wed, 24 May 2017 13:28:48 -0700
Subject: Update FIRPhoneAuthProvider reference docs (#27)

Adds reference docs error documentation to FIRPhoneAuthProvider.
Also fixes small typo in FIRAuthErrorUtils.
---
 .../Source/AuthProviders/Phone/FIRPhoneAuthProvider.h | 19 +++++++++++++++++++
 Firebase/Auth/Source/FIRAuthErrorUtils.m              |  2 +-
 2 files changed, 20 insertions(+), 1 deletion(-)

(limited to 'Firebase')

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;
diff --git a/Firebase/Auth/Source/FIRAuthErrorUtils.m b/Firebase/Auth/Source/FIRAuthErrorUtils.m
index dbeb5d1..6764c45 100644
--- a/Firebase/Auth/Source/FIRAuthErrorUtils.m
+++ b/Firebase/Auth/Source/FIRAuthErrorUtils.m
@@ -230,7 +230,7 @@ static NSString *const kFIRAuthErrorMessageMissingPhoneNumber =
     @"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 "
-- 
cgit v1.2.3