From 59683ee0fc21c60dbbe92eed2d29aea68fba2452 Mon Sep 17 00:00:00 2001 From: creativecreatorormaybenot Date: Sun, 2 Oct 2022 09:44:50 +0000 Subject: [PATCH 1/4] fix(auth): setSettings docs --- .../platform_interface_firebase_auth.dart | 34 +++++++++---------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/packages/firebase_auth/firebase_auth_platform_interface/lib/src/platform_interface/platform_interface_firebase_auth.dart b/packages/firebase_auth/firebase_auth_platform_interface/lib/src/platform_interface/platform_interface_firebase_auth.dart index 36b2184588c5..8199c64b2c4a 100644 --- a/packages/firebase_auth/firebase_auth_platform_interface/lib/src/platform_interface/platform_interface_firebase_auth.dart +++ b/packages/firebase_auth/firebase_auth_platform_interface/lib/src/platform_interface/platform_interface_firebase_auth.dart @@ -331,7 +331,7 @@ abstract class FirebaseAuthPlatform extends PlatformInterface { /// Updates the current instance with the provided settings. /// - /// [appVerificationDisabledForTesting] This setting applies to android, iOS and + /// [appVerificationDisabledForTesting] This setting applies to Android, iOS and /// web platforms. When set to `true`, this property disables app /// verification for the purpose of testing phone authentication. For this /// property to take effect, it needs to be set before handling a reCAPTCHA @@ -345,22 +345,22 @@ abstract class FirebaseAuthPlatform extends PlatformInterface { /// /// The default value is `false` (app verification is enabled). /// - /// [forceRecaptchaFlow] This setting applies to android only. When set to 'true', - /// it forces the application verification to use the web reCAPTCHA flow for Phone Authentication. - /// Once this has been called, every call to PhoneAuthProvider#verifyPhoneNumber() will skip the SafetyNet verification flow and use the reCAPTCHA flow instead. - /// Calling this method a second time will overwrite the previously passed parameter. - /// - /// [phoneNumber] & [smsCode] These settings apply to android only. The phone number and SMS code here must have been configured in the Firebase Console (Authentication > Sign In Method > Phone). - /// Once this has been called, every call to PhoneAuthProvider#verifyPhoneNumber() with the same phone number as the one that is configured here will have onVerificationCompleted() triggered as the callback. - /// Calling this method a second time will overwrite the previously passed parameters. Only one number can be configured at a given time. - /// Calling this method with either parameter set to null removes this functionality until valid parameters are passed. - /// Verifying a phone number other than the one configured here will trigger normal behavior. If the phone number is configured as a test phone number in the console, the regular testing flow occurs. Otherwise, normal phone number verification will take place. - /// When this is set and PhoneAuthProvider#verifyPhoneNumber() is called with a matching phone number, PhoneAuthProvider.OnVerificationStateChangedCallbacks.onCodeAutoRetrievalTimeOut(String) will never be called. - /// - /// [userAccessGroup] This setting only applies to iOS and MacOS platforms. - /// When set, it allows you to share authentication state between - /// applications. Set the property to your team group ID or set to `null` - /// to remove sharing capabilities. + /// [forceRecaptchaFlow] This setting applies to Android only. When set to 'true', + /// it forces the application verification to use the web reCAPTCHA flow for Phone Authentication. + /// Once this has been called, every call to PhoneAuthProvider#verifyPhoneNumber() will skip the SafetyNet verification flow and use the reCAPTCHA flow instead. + /// Calling this method a second time will overwrite the previously passed parameter. + /// + /// [phoneNumber] & [smsCode] These settings apply to Android only. The phone number and SMS code here must have been configured in the Firebase Console (Authentication > Sign In Method > Phone). + /// Once this has been called, every call to PhoneAuthProvider#verifyPhoneNumber() with the same phone number as the one that is configured here will have onVerificationCompleted() triggered as the callback. + /// Calling this method a second time will overwrite the previously passed parameters. Only one number can be configured at a given time. + /// Calling this method with either parameter set to null removes this functionality until valid parameters are passed. + /// Verifying a phone number other than the one configured here will trigger normal behaviour. If the phone number is configured as a test phone number in the console, the regular testing flow occurs. Otherwise, normal phone number verification will take place. + /// When this is set and PhoneAuthProvider#verifyPhoneNumber() is called with a matching phone number, PhoneAuthProvider.OnVerificationStateChangedCallbacks.onCodeAutoRetrievalTimeOut(String) will never be called. + /// + /// [userAccessGroup] This setting only applies to iOS and MacOS platforms. + /// When set, it allows you to share authentication state between + /// applications. Set the property to your team group ID or set to `null` + /// to remove sharing capabilities. /// /// Key Sharing capabilities must be enabled for your app via XCode (Project /// settings > Capabilities). To learn more, visit the From 7efbcb98bc93cc12f3dbd9da4af259985fab6639 Mon Sep 17 00:00:00 2001 From: creativecreatorormaybenot Date: Sun, 2 Oct 2022 09:46:56 +0000 Subject: [PATCH 2/4] Update firebase_auth.dart --- .../firebase_auth/lib/src/firebase_auth.dart | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/packages/firebase_auth/firebase_auth/lib/src/firebase_auth.dart b/packages/firebase_auth/firebase_auth/lib/src/firebase_auth.dart index 7edf0762db1d..3ff023523613 100644 --- a/packages/firebase_auth/firebase_auth/lib/src/firebase_auth.dart +++ b/packages/firebase_auth/firebase_auth/lib/src/firebase_auth.dart @@ -382,7 +382,7 @@ class FirebaseAuth extends FirebasePluginPlatform { /// Updates the current instance with the provided settings. /// - /// [appVerificationDisabledForTesting] This setting only applies to iOS and + /// [appVerificationDisabledForTesting] This setting applies to Android, iOS and /// web platforms. When set to `true`, this property disables app /// verification for the purpose of testing phone authentication. For this /// property to take effect, it needs to be set before handling a reCAPTCHA @@ -396,10 +396,22 @@ class FirebaseAuth extends FirebasePluginPlatform { /// /// The default value is `false` (app verification is enabled). /// + /// [forceRecaptchaFlow] This setting applies to Android only. When set to 'true', + /// it forces the application verification to use the web reCAPTCHA flow for Phone Authentication. + /// Once this has been called, every call to PhoneAuthProvider#verifyPhoneNumber() will skip the SafetyNet verification flow and use the reCAPTCHA flow instead. + /// Calling this method a second time will overwrite the previously passed parameter. + /// + /// [phoneNumber] & [smsCode] These settings apply to Android only. The phone number and SMS code here must have been configured in the Firebase Console (Authentication > Sign In Method > Phone). + /// Once this has been called, every call to PhoneAuthProvider#verifyPhoneNumber() with the same phone number as the one that is configured here will have onVerificationCompleted() triggered as the callback. + /// Calling this method a second time will overwrite the previously passed parameters. Only one number can be configured at a given time. + /// Calling this method with either parameter set to null removes this functionality until valid parameters are passed. + /// Verifying a phone number other than the one configured here will trigger normal behaviour. If the phone number is configured as a test phone number in the console, the regular testing flow occurs. Otherwise, normal phone number verification will take place. + /// When this is set and PhoneAuthProvider#verifyPhoneNumber() is called with a matching phone number, PhoneAuthProvider.OnVerificationStateChangedCallbacks.onCodeAutoRetrievalTimeOut(String) will never be called. + /// /// [userAccessGroup] This setting only applies to iOS and MacOS platforms. /// When set, it allows you to share authentication state between - /// applications. Set the property to your team group ID or set to `null` to - /// remove sharing capabilities. + /// applications. Set the property to your team group ID or set to `null` + /// to remove sharing capabilities. /// /// Key Sharing capabilities must be enabled for your app via XCode (Project /// settings > Capabilities). To learn more, visit the From 1663ce454bea6756db8c2120ac2b9899c7614a42 Mon Sep 17 00:00:00 2001 From: creativecreatorormaybenot Date: Sun, 2 Oct 2022 09:48:18 +0000 Subject: [PATCH 3/4] Use American spelling --- packages/firebase_auth/firebase_auth/lib/src/firebase_auth.dart | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/firebase_auth/firebase_auth/lib/src/firebase_auth.dart b/packages/firebase_auth/firebase_auth/lib/src/firebase_auth.dart index 3ff023523613..22f0f226e4b0 100644 --- a/packages/firebase_auth/firebase_auth/lib/src/firebase_auth.dart +++ b/packages/firebase_auth/firebase_auth/lib/src/firebase_auth.dart @@ -405,7 +405,7 @@ class FirebaseAuth extends FirebasePluginPlatform { /// Once this has been called, every call to PhoneAuthProvider#verifyPhoneNumber() with the same phone number as the one that is configured here will have onVerificationCompleted() triggered as the callback. /// Calling this method a second time will overwrite the previously passed parameters. Only one number can be configured at a given time. /// Calling this method with either parameter set to null removes this functionality until valid parameters are passed. - /// Verifying a phone number other than the one configured here will trigger normal behaviour. If the phone number is configured as a test phone number in the console, the regular testing flow occurs. Otherwise, normal phone number verification will take place. + /// Verifying a phone number other than the one configured here will trigger normal behavior. If the phone number is configured as a test phone number in the console, the regular testing flow occurs. Otherwise, normal phone number verification will take place. /// When this is set and PhoneAuthProvider#verifyPhoneNumber() is called with a matching phone number, PhoneAuthProvider.OnVerificationStateChangedCallbacks.onCodeAutoRetrievalTimeOut(String) will never be called. /// /// [userAccessGroup] This setting only applies to iOS and MacOS platforms. From f34a27e1ffe41270de48cabe8f707bd589130c3d Mon Sep 17 00:00:00 2001 From: creativecreatorormaybenot Date: Sun, 2 Oct 2022 09:48:35 +0000 Subject: [PATCH 4/4] Use US spelling --- .../platform_interface/platform_interface_firebase_auth.dart | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/firebase_auth/firebase_auth_platform_interface/lib/src/platform_interface/platform_interface_firebase_auth.dart b/packages/firebase_auth/firebase_auth_platform_interface/lib/src/platform_interface/platform_interface_firebase_auth.dart index 8199c64b2c4a..47eb10be4e69 100644 --- a/packages/firebase_auth/firebase_auth_platform_interface/lib/src/platform_interface/platform_interface_firebase_auth.dart +++ b/packages/firebase_auth/firebase_auth_platform_interface/lib/src/platform_interface/platform_interface_firebase_auth.dart @@ -354,7 +354,7 @@ abstract class FirebaseAuthPlatform extends PlatformInterface { /// Once this has been called, every call to PhoneAuthProvider#verifyPhoneNumber() with the same phone number as the one that is configured here will have onVerificationCompleted() triggered as the callback. /// Calling this method a second time will overwrite the previously passed parameters. Only one number can be configured at a given time. /// Calling this method with either parameter set to null removes this functionality until valid parameters are passed. - /// Verifying a phone number other than the one configured here will trigger normal behaviour. If the phone number is configured as a test phone number in the console, the regular testing flow occurs. Otherwise, normal phone number verification will take place. + /// Verifying a phone number other than the one configured here will trigger normal behavior. If the phone number is configured as a test phone number in the console, the regular testing flow occurs. Otherwise, normal phone number verification will take place. /// When this is set and PhoneAuthProvider#verifyPhoneNumber() is called with a matching phone number, PhoneAuthProvider.OnVerificationStateChangedCallbacks.onCodeAutoRetrievalTimeOut(String) will never be called. /// /// [userAccessGroup] This setting only applies to iOS and MacOS platforms.