ClearCredentialStateRequest

Artifact: androidx.credentials:credentials

View Source

Added in 1.2.0

---

Kotlin |Java

public final class ClearCredentialStateRequest

---

Request class for clearing a user's credential state from the credential providers.

If the request type is TYPE_CLEAR_CREDENTIAL_STATE, then the request will be sent to the credential providers to clear the user's credential state.

If the request type is TYPE_CLEAR_RESTORE_CREDENTIAL, then the request will be sent to the restore credential provider to delete any stored RestoreCredential.

Throws
kotlin.IllegalArgumentException	if the requestType is unsupported type.

Summary

Constants
static final @NonNull String	TYPE_CLEAR_CREDENTIAL_STATE Clears credential state from all credential providers that have cached a user sign-in states.
static final @NonNull String	TYPE_CLEAR_RESTORE_CREDENTIAL Clears restore credential from the device and the backup

Public constructors
ClearCredentialStateRequest(@NonNull String requestType) creates a new ClearCredentialStateRequest

Public methods
final @NonNull Bundle	getRequestBundle()
final @NonNull String	getRequestType() the type of this request

Constants

TYPE_CLEAR_CREDENTIAL_STATE

public static final @NonNull String TYPE_CLEAR_CREDENTIAL_STATE

Clears credential state from all credential providers that have cached a user sign-in states.

TYPE_CLEAR_RESTORE_CREDENTIAL

public static final @NonNull String TYPE_CLEAR_RESTORE_CREDENTIAL

Clears restore credential from the device and the backup

Public constructors

ClearCredentialStateRequest

Added in 1.5.0-alpha05

public ClearCredentialStateRequest(@NonNull String requestType)

creates a new ClearCredentialStateRequest

Public methods

getRequestBundle

Added in 1.5.0-alpha05

public final @NonNull Bundle getRequestBundle()

getRequestType

Added in 1.5.0-alpha05

public final @NonNull String getRequestType()

the type of this request