GetCredentialException

Artifact: androidx.credentials:credentials

Added in 1.2.0

Kotlin |Java

abstract class GetCredentialException : Exception

kotlin.Any
↳	kotlin.Throwable
	↳	java.lang.Exception
		↳	androidx.credentials.exceptions.GetCredentialException

Known direct subclasses

GetCredentialCancellationException, GetCredentialCustomException, GetCredentialInterruptedException, GetCredentialProviderConfigurationException, GetCredentialUnknownException, GetCredentialUnsupportedException, GetPublicKeyCredentialException, NoCredentialException

`GetCredentialCancellationException`	During the get credential flow, this is thrown when a user intentionally cancels an operation.
`GetCredentialCustomException`	Represents a custom error thrown during a get flow with `CredentialManager`.
`GetCredentialInterruptedException`	During the get credential flow, this is thrown when some interruption occurs that may warrant retrying or at least does not indicate a purposeful desire to close or tap away from credential manager.
`GetCredentialProviderConfigurationException`	During the get credential flow, this is thrown when configurations are mismatched for the provider, typically indicating the provider dependency is missing in the manifest or some system service is not enabled.
`GetCredentialUnknownException`	This is thrown when the get credential operation failed with no more detailed information.
`GetCredentialUnsupportedException`	During the get credential flow, this is thrown when credential manager is unsupported, typically because the device has disabled it or did not ship with this feature enabled.
`GetPublicKeyCredentialException`	A subclass of CreateCredentialException for unique exceptions thrown specific only to PublicKeyCredentials.
`NoCredentialException`	During the get credential flow, this is returned when no viable credential is available for the the user.

Known indirect subclasses

GetPublicKeyCredentialDomException

GetPublicKeyCredentialDomException

During the get-passkey flow, this is thrown when a DOM Exception is thrown, indicating the operation contains a DOMException error type.

Represents an error thrown during a get flow with Credential Manager. See CredentialManager for more details on how Exceptions work for Credential Manager flows.

See also
`CredentialManager`
`GetCredentialUnknownException`
`GetCredentialCancellationException`
`GetCredentialInterruptedException`

Summary

Public companion functions
`Bundle`	`asBundle(ex: GetCredentialException)` Helper method to convert the given `ex` to a parcelable `Bundle`, in case the instance needs to be sent across a process.
`GetCredentialException`	`fromBundle(bundle: Bundle)` Helper method to convert a `Bundle` retrieved through `asBundle`, back to an instance of `GetCredentialException`.

Inherited functions

From kotlin.Throwable

`Unit`	`addSuppressed(@RecentlyNonNull p0: Throwable)`
`open Throwable`	`@RecentlyNonNull fillInStackTrace()`
`open String`	`@RecentlyNullable getLocalizedMessage()`
`open Array<StackTraceElement>`	`@RecentlyNonNull getStackTrace()`
`Array<Throwable>`	`@RecentlyNonNull getSuppressed()`
`open Throwable`	`@RecentlyNonNull initCause(@RecentlyNullable p0: Throwable)`
`open Unit`	`printStackTrace()`
`open Unit`	`printStackTrace(@RecentlyNonNull p0: PrintStream)`
`open Unit`	`printStackTrace(@RecentlyNonNull p0: PrintWriter)`
`open Unit`	`setStackTrace(@RecentlyNonNull p0: Array<StackTraceElement>)`

Inherited properties

From kotlin.Throwable

`open Throwable?`	`cause`
`open String?`	`message`

Public companion functions

asBundle

Added in 1.5.0-beta01

fun asBundle(ex: GetCredentialException): Bundle

Helper method to convert the given ex to a parcelable Bundle, in case the instance needs to be sent across a process. Consumers of this method should use fromBundle to reconstruct the class instance back from the bundle returned here.

fromBundle

Added in 1.5.0-beta01

fun fromBundle(bundle: Bundle): GetCredentialException

Helper method to convert a Bundle retrieved through asBundle, back to an instance of GetCredentialException.

Throws IllegalArgumentException if the conversion fails. This means that the given bundle does not contain a GetCredentialException. The bundle should be constructed and retrieved from asBundle itself and never be created from scratch to avoid the failure.