GetCredentialException

Artifact: androidx.credentials:credentials

Added in 1.2.0

Kotlin |Java

public abstract class GetCredentialException extends Exception

java.lang.Object
↳	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 methods
`static final @NonNull Bundle`	`asBundle(@NonNull GetCredentialException ex)` Helper method to convert the given `ex` to a parcelable `Bundle`, in case the instance needs to be sent across a process.
`static final @NonNull GetCredentialException`	`fromBundle(@NonNull Bundle bundle)` Helper method to convert a `Bundle` retrieved through `asBundle`, back to an instance of `GetCredentialException`.

Inherited methods

From kotlin.Throwable

`final void`	`addSuppressed(@RecentlyNonNull @NonNull Throwable p0)`
`@NonNull Throwable`	`@RecentlyNonNull fillInStackTrace()`
`Throwable`	`getCause()`
`@NonNull String`	`@RecentlyNullable getLocalizedMessage()`
`String`	`getMessage()`
`@NonNull StackTraceElement[]`	`@RecentlyNonNull getStackTrace()`
`final @NonNull Throwable[]`	`@RecentlyNonNull getSuppressed()`
`@NonNull Throwable`	`@RecentlyNonNull initCause(@RecentlyNullable @NonNull Throwable p0)`
`void`	`printStackTrace()`
`void`	`printStackTrace(@RecentlyNonNull @NonNull PrintStream p0)`
`void`	`printStackTrace(@RecentlyNonNull @NonNull PrintWriter p0)`
`void`	`setStackTrace(@RecentlyNonNull @NonNull StackTraceElement[] p0)`

Public methods

asBundle

Added in 1.5.0-beta01

public static final @NonNull Bundle asBundle(@NonNull GetCredentialException ex)

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

public static final @NonNull GetCredentialException fromBundle(@NonNull Bundle bundle)

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.