# ClearCredentialStateRequest

Artifact: [androidx.credentials:credentials](https://developer.android.com/jetpack/androidx/releases/credentials) [View Source](https://cs.android.com/search?q=file:androidx/credentials/ClearCredentialStateRequest.kt+class:androidx.credentials.ClearCredentialStateRequest) Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/credentials#1.2.0)

*** ** * ** ***

<br />

```
public final class ClearCredentialStateRequest
```

<br />

*** ** * ** ***

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

If the request type is `https://developer.android.com/reference/androidx/credentials/ClearCredentialStateRequest#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 `https://developer.android.com/reference/androidx/credentials/ClearCredentialStateRequest#TYPE_CLEAR_RESTORE_CREDENTIAL()`, then the request will be sent to the restore credential provider to delete any stored `https://developer.android.com/reference/androidx/credentials/RestoreCredential`.

| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html` | if the `https://developer.android.com/reference/androidx/credentials/ClearCredentialStateRequest#requestType()` is unsupported type. |

## Summary

| ### Constants |
|---|---|
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/credentials/ClearCredentialStateRequest#TYPE_CLEAR_CREDENTIAL_STATE()` Clears credential state from all credential providers that have cached a user sign-in states. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/credentials/ClearCredentialStateRequest#TYPE_CLEAR_RESTORE_CREDENTIAL()` Clears restore credential from the device and the backup |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/credentials/ClearCredentialStateRequest#ClearCredentialStateRequest(kotlin.String)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html requestType)` creates a new ClearCredentialStateRequest |

| ### Public methods |
|---|---|
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/os/Bundle.html` | `https://developer.android.com/reference/androidx/credentials/ClearCredentialStateRequest#getRequestBundle()()` |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/credentials/ClearCredentialStateRequest#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](https://developer.android.com/jetpack/androidx/releases/credentials#1.5.0)

```
public ClearCredentialStateRequest(@NonNull String requestType)
```

creates a new ClearCredentialStateRequest

## Public methods

### getRequestBundle

Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/credentials#1.5.0)

```
public final @NonNull Bundle getRequestBundle()
```

### getRequestType

Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/credentials#1.5.0)

```
public final @NonNull String getRequestType()
```

the type of this request