exceptionInfos top-level constant

Implementation

const Map<String, ExceptionInfo> exceptionInfos = {
  'cancelled': ExceptionInfo(
    title: 'PasskeyAuthCancelledException',
    description: 'Thrown when the user cancels the passkey flow.',
    platforms: ['Android', 'iOS'],
    suggestions: [
      'Allow the user to start the flow again.',
    ],
  ),
  'exclude-credentials-match': ExceptionInfo(
    title: 'ExcludeCredentialsCanNotBeRegisteredException',
    description:
        'Thrown when the user tries to register but one of the excluded credentials matches an existing one.',
    platforms: ['Android'],
    suggestions: [
      'Inform the user that the credential already exists.',
      'Allow the user to proceed with authentication instead of registration.',
    ],
  ),
  'android-missing-google-sign-in': ExceptionInfo(
    title: 'MissingGoogleSignInException',
    description:
        'Thrown when the user tries to register or authenticate but isn’t signed in to a Google account on their device.',
    platforms: ['Android'],
    suggestions: [
      'Ask the user to sign in to their Google account first.',
      'Use a fallback method (e.g. login via email OTP).',
    ],
  ),
  'android-sync-account-not-available': ExceptionInfo(
    title: 'SyncAccountNotAvailableException',
    description:
        'Thrown when the passkey cannot be retrieved from the sync provider (e.g., on an Android emulator).',
    platforms: ['Android'],
    suggestions: [
      'Make sure the emulator has Google Play Services integrated.',
      'Cold-boot your emulator and ensure the user is signed in to Google.',
    ],
  ),
  'domain-not-associated': ExceptionInfo(
    title: 'DomainNotAssociatedException',
    description:
        'Thrown when your app’s domain isn’t correctly associated (no Digital Asset Links or AASA file). In your case it is caused by apple CDN Caching when dealing with AASA files. For more information check https://docs.corbado.com/corbado-complete/frontend-integration/flutter/run-on-physical-device/ios/overview#aasa-file-caching-and-the-%3Fmode%3Ddeveloper-parameter',
    platforms: ['Android', 'iOS'],
    suggestions: [
      'Check our docs on https://docs.corbado.com/corbado-complete/frontend-integration/flutter/run-on-physical-device/ios/configure-device and ',
    ],
  ),
  'deviceNotSupported': ExceptionInfo(
    title: 'DeviceNotSupportedException',
    description: 'Thrown when the device does not support passkeys.',
    platforms: ['Android', 'iOS'],
    suggestions: [
      'Update the device OS to a version that supports passkeys.',
    ],
  ),
  'android-timeout': ExceptionInfo(
    title: 'TimeoutException',
    description: 'Thrown when the operation times out.',
    platforms: ['Android', 'iOS'],
    suggestions: [
      'Ask the user to try again.',
    ],
  ),
  'ios-security-key-timeout': ExceptionInfo(
    title: 'TimeoutException',
    description: 'Thrown when the operation times out.',
    platforms: ['Android', 'iOS'],
    suggestions: [
      'Ask the user to try again.',
    ],
  ),
  'no-credentials-available': ExceptionInfo(
    title: 'NoCredentialsAvailableException',
    description:
        'Thrown when the user has no credentials available for the authenticator.',
    platforms: ['Android', 'iOS'],
    suggestions: [
      'Use a fallback method (e.g. login via email OTP).',
    ],
  ),
  'android-no-credential': ExceptionInfo(
    title: 'NoCredentialsAvailableException',
    description:
        'Thrown when the user has no credentials available for the authenticator.',
    platforms: ['Android', 'iOS'],
    suggestions: [
      'Use a fallback method (e.g. login via email OTP).',
    ],
  ),
  'android-no-create-option': ExceptionInfo(
    title: 'NoCreateOptionException',
    description:
        'Thrown when no viable creation options were found for the given CreateCredentialRequest.',
    platforms: ['Android'],
    suggestions: [
      'Use a fallback method (e.g. redirect the user to the device settings).',
      'Ask the user to enable passkeys in the device settings.',
    ],
  ),
  'malformed-base64-url-challenge': ExceptionInfo(
    title: 'MalformedBase64UrlChallenge',
    description:
        'Thrown when the challenge is not a valid Base64URL-encoded string.',
    platforms: ['Android', 'iOS', 'Web'],
    suggestions: [
      'Make sure that the challenge is a valid Base64URL-encoded string without padding.',
    ],
  ),
  'malformed-base64-url-credential-id': ExceptionInfo(
    title: 'MalformedBase64UrlCredentialID',
    description:
        'Thrown when a credential ID is not a valid Base64URL-encoded string.',
    platforms: ['Android', 'iOS', 'Web'],
    suggestions: [
      'Make sure that the credential ID is a valid Base64URL-encoded string without padding.',
    ],
  ),
  'malformed-base64-url-user-id': ExceptionInfo(
    title: 'MalformedBase64UrlUserID',
    description:
        'Thrown when the user ID is not a valid Base64URL-encoded string.',
    platforms: ['Android', 'iOS', 'Web'],
    suggestions: [
      'Make sure that the user ID is a valid Base64URL-encoded string.',
    ],
  ),
  'failed': ExceptionInfo(
    title: 'FailedException',
    description:
        'Thrown when the operation fails. This is expected on IOS simulator when trying to trigger Conditional Login',
    platforms: ['iOS'],
    suggestions: [],
  ),
  'android-passkey-unsupported': ExceptionInfo(
    title: 'PasskeyUnsupportedException',
    description:
        'Thrown when the Android device does not support passkeys due to missing hardware or software capabilities. (minimal sdk version is 28)',
    platforms: ['Android'],
    suggestions: [
      'Ensure the device meets the minimum requirements for passkey support.',
      'Update the device OS to the latest version.',
      'Check if Google Play Services are up to date.',
    ],
  ),
};