Skip to content

Commit

Permalink
docs(auth): update setSettings() inline documentation (#9655)
Browse files Browse the repository at this point in the history
  • Loading branch information
@creativecreatorormaybenot
creativecreatorormaybenot committed Oct 3, 2022
1 parent 60f7a2e commit 39ca002
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 20 deletions.
18 changes: 15 additions & 3 deletions packages/firebase_auth/firebase_auth/lib/src/firebase_auth.dart
View file
Expand Up @@ -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
Expand All @@ -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 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.
/// 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
Expand Down
34 changes: 17 additions & 17 deletions ..._auth_platform_interface/lib/src/platform_interface/platform_interface_firebase_auth.dart
View file
Expand Up @@ -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
Expand All @@ -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 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.
///
/// Key Sharing capabilities must be enabled for your app via XCode (Project
/// settings > Capabilities). To learn more, visit the
Expand Down

0 comments on commit 39ca002

Please sign in to comment.