Visitar URL original
docs(auth): add information about error codes for `verifyBeforeUpdate… · firebase/flutterfire@8ef7421 · GitHub
Skip to content

Commit 8ef7421

Browse files
LyokoneLyokone
authored
docs(auth): add information about error codes for verifyBeforeUpdateEmail (#13036)
* docs(auth): add information about error codes for verifyBeforeUpdateEmail * more
1 parent f122380 commit 8ef7421

2 files changed

Lines changed: 24 additions & 0 deletions

File tree

‎packages/firebase_auth/firebase_auth/lib/src/user.dart‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -653,6 +653,18 @@ class User {
653653
///
654654
/// If you have a custom email action handler, you can complete the
655655
/// verification process by calling [applyActionCode].
656+
///
657+
/// A [FirebaseAuthException] maybe thrown with the following error code:
658+
/// - **missing-android-pkg-name**:
659+
/// - An Android package name must be provided if the Android app is required to be installed.
660+
/// - **missing-continue-uri**:
661+
/// - A continue URL must be provided in the request.
662+
/// - **missing-ios-bundle-id**:
663+
/// - An iOS bundle ID must be provided if an App Store ID is provided.
664+
/// - **invalid-continue-uri**:
665+
/// - The continue URL provided in the request is invalid.
666+
/// - **unauthorized-continue-uri**:
667+
/// - The domain of the continue URL is not whitelisted. Whitelist the domain in the Firebase console.
656668
Future<void> verifyBeforeUpdateEmail(
657669
String newEmail, [
658670
ActionCodeSettings? actionCodeSettings,

‎packages/firebase_auth/firebase_auth_platform_interface/lib/src/platform_interface/platform_interface_user.dart‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -533,6 +533,18 @@ abstract class UserPlatform extends PlatformInterface {
533533
///
534534
/// If you have a custom email action handler, you can complete the
535535
/// verification process by calling [applyActionCode].
536+
///
537+
/// A [FirebaseAuthException] maybe thrown with the following error code:
538+
/// - **missing-android-pkg-name**:
539+
/// - An Android package name must be provided if the Android app is required to be installed.
540+
/// - **missing-continue-uri**:
541+
/// - A continue URL must be provided in the request.
542+
/// - **missing-ios-bundle-id**:
543+
/// - An iOS bundle ID must be provided if an App Store ID is provided.
544+
/// - **invalid-continue-uri**:
545+
/// - The continue URL provided in the request is invalid.
546+
/// - **unauthorized-continue-uri**:
547+
/// - The domain of the continue URL is not whitelisted. Whitelist the domain in the Firebase console.
536548
Future<void> verifyBeforeUpdateEmail(
537549
String newEmail, [
538550
ActionCodeSettings? actionCodeSettings,

0 commit comments

Comments
 (0)