Deprecate PhoneAuthProvider.MaxTimeoutMs (Fixed #54) (#470)

* Deprecate `PhoneAuthProvider.MaxTimeoutMs`

This is a read-only valued used to set the upper bound for
`autoVerifyTimeOutMs`.  However, the value was set too low.
Android SDK has increase the range to 30 to 120 seconds, while iOS
SDK does not have a way to override timeout.

This is a change to deprecate this public property so that
the underlying SDK can determine the range for timeout.

Author: chkuang-g

auth/src/PhoneAuthProvider.cs

@@ -59,6 +59,11 @@ namespace Firebase.Auth {
 public sealed class PhoneAuthProvider : global::System.IDisposable {
   /// Maximum value of `autoVerifyTimeOutMs` in @ref VerifyPhoneNumber.
   /// @ref VerifyPhoneNumber will automatically clamp values to this amount.
+  ///
+  /// @deprecated This value is no longer used to clamp
+  /// `autoVerifyTimeOutMs` in @ref VerifyPhoneNumber. The range is
+  /// determined by the underlying SDK, ex. <a href="/docs/reference/android/com/google/firebase/auth/PhoneAuthOptions.Builder"><code>PhoneAuthOptions.Build</code> in Android SDK</a>
+  [System.Obsolete("PhoneAuthProvider.MaxTimeoutMs is deprecated. This value no longer affects PhoneAuthProvider.VerifyPhoneNumber()")]
   public static uint MaxTimeoutMs {
     get {
       return PhoneAuthProviderInternal.kMaxTimeoutMs;
@@ -212,7 +217,6 @@ private static void InitializeCallbacks() {
   ///    miliseconds. Currently SMS auto retrieval is only supported on Android.
   ///    If 0, do not do SMS auto retrieval.
   ///    If positive, try to auto-retrieve the SMS verification code.
-  ///    If larger than MaxTimeoutMs, clamped to MaxTimeoutMs.
   ///    When the time out is exceeded, `codeAutoRetrievalTimeOut`
   ///    is called.
   /// @param[in] forceResendingToken If NULL, assume this is a new phone
@@ -247,7 +251,6 @@ public void VerifyPhoneNumber(string phoneNumber, uint autoVerifyTimeOutMs,
   ///    miliseconds. Currently SMS auto retrieval is only supported on Android.
   ///    If 0, do not do SMS auto retrieval.
   ///    If positive, try to auto-retrieve the SMS verification code.
-  ///    If larger than MaxTimeoutMs, clamped to MaxTimeoutMs.
   ///    When the time out is exceeded, `codeAutoRetrievalTimeOut`
   ///    is called.
   /// @param[in] forceResendingToken If NULL, assume this is a new phone
@@ -287,7 +290,6 @@ public void VerifyPhoneNumber(string phoneNumber, uint autoVerifyTimeOutMs,
   ///    miliseconds. Currently SMS auto retrieval is only supported on Android.
   ///    If 0, do not do SMS auto retrieval.
   ///    If positive, try to auto-retrieve the SMS verification code.
-  ///    If larger than MaxTimeoutMs, clamped to MaxTimeoutMs.
   ///    When the time out is exceeded, `codeAutoRetrievalTimeOut`
   ///    is called.
   /// @param[in] forceResendingToken If NULL, assume this is a new phone
@@ -324,7 +326,6 @@ public void VerifyPhoneNumber(string phoneNumber, uint autoVerifyTimeOutMs,
   ///    miliseconds. Currently SMS auto retrieval is only supported on Android.
   ///    If 0, do not do SMS auto retrieval.
   ///    If positive, try to auto-retrieve the SMS verification code.
-  ///    If larger than MaxTimeoutMs, clamped to MaxTimeoutMs.
   ///    When the time out is exceeded, `codeAutoRetrievalTimeOut`
   ///    is called.
   /// @param[in] forceResendingToken If NULL, assume this is a new phone

docs/readme.md

@@ -155,6 +155,11 @@ Support
 
 Release Notes
 -------------
+### Upcoming
+- Changes
+    - Auth (Android/iOS): Deprecate `PhoneAuthProvider.MaxTimeoutMs`. The actual
+      range is determined by the underlying SDK, ex. [PhoneAuthOptions.Builder in Android SDK](https://firebase.google.com/docs/reference/android/com/google/firebase/auth/PhoneAuthOptions.Builder).
+
 ### 9.6.0
 - Changes
     - General: Updated Firebase C++ SDK dependencies to v9.6.0.