ClearCredentialException

Artifact: androidx.credentials:credentials

Added in 1.2.0

Kotlin |Java

public abstract class ClearCredentialException extends Exception

java.lang.Object
↳	kotlin.Throwable
	↳	java.lang.Exception
		↳	androidx.credentials.exceptions.ClearCredentialException

Known direct subclasses

ClearCredentialCustomException, ClearCredentialInterruptedException, ClearCredentialProviderConfigurationException, ClearCredentialUnknownException, ClearCredentialUnsupportedException

`ClearCredentialCustomException`	Represents a custom error thrown during a clear flow with `CredentialManager`.
`ClearCredentialInterruptedException`	During the clear 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.
`ClearCredentialProviderConfigurationException`	During the clear 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.
`ClearCredentialUnknownException`	This is thrown when the clear credential operation failed with no more detailed information.
`ClearCredentialUnsupportedException`	During the clear 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.

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

See also
`CredentialManager`
`ClearCredentialInterruptedException`
`ClearCredentialUnknownException`

Summary

Public methods
`static final @NonNull Bundle`	`asBundle(@NonNull ClearCredentialException 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 ClearCredentialException`	`fromBundle(@NonNull Bundle bundle)` Helper method to convert a `Bundle` retrieved through `asBundle`, back to an instance of `ClearCredentialException`.

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-alpha05

public static final @NonNull Bundle asBundle(@NonNull ClearCredentialException 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-alpha05

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

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

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