types library
Classes
- AuthenticateRequestType
- The AuthenticateRequestType is used to create an authentication request and send it to the platform.
- AuthenticateResponseType
- AuthenticatorSelectionType
- AvailabilityType
- The base class for platform-specific availability information.
- AvailabilityTypeAndroid
- Represents the availability information specific to Android platforms.
- AvailabilityTypeIOS
- Represents the availability information specific to iOS platforms.
- AvailabilityTypeWeb
- Represents the availability information specific to web platforms.
- AvailabilityTypeWindows
- Represents the availability information specific to Windows platforms.
- CredentialType
- The CredentialType class wraps the data of a credential it can be used to explicitly exclude or allow credentials.
- PubKeyCredParamType
- The PubKeyCredParamType class wraps the data of a public key credential parameter. It is used to specify the type and algorithm of the public key credential that is being requested.
- RegisterRequestType
- The RegisterRequestType is used to create a registration request and send it to the platform.
- RegisterResponseType
- RelyingPartyType
- The RelyingPartyType class wraps the data of a relying party. It is used to identify the party that is requesting authentication.
- UserType
- The UserType class wraps the data of a user..
Enums
- MediationType
- Defines how user mediation (interaction) should be handled during credential operations.
Exceptions / Errors
- AuthenticatorException
- Used as a base exception for all authenticator exceptions thrown by this package.
- ExcludeCredentialsCanNotBeRegisteredException
- This exception is thrown when the user tries to login but is not logged in to a Google account on his device. Being logged in to a Google account is mandatory for passkeys to work on Android devices.
- MissingGoogleSignInException
- This exception is thrown when the user tries to login but is not logged in to a Google account on his device. Being logged in to a Google account is mandatory for passkeys to work on Android devices.
- PasskeyAuthCancelledException
- Thrown when the user cancels the passkey flow.
- SyncAccountNotAvailableException
- This exception is thrown when the passkey can not be retrieved from the entity that is used for passkey syncing. Currently this error is observed when testing on Android emulators. In these cases you need to restart the emulator using the 'Cold Boot Now' option.
- UnhandledAuthenticatorException
- This exception is thrown when an exception is thrown by the authenticator that we do not handle so far in this package.