# BeginGetCredentialResponse

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

*** ** * ** ***


```
public final class BeginGetCredentialResponse
```

<br />

*** ** * ** ***

Response from a credential provider to `https://developer.android.com/reference/androidx/credentials/provider/BeginGetCredentialRequest`, containing credential entries and other associated entries/data to be shown on the account selector UI.

## Summary

| ### Nested types |
|---|
| `public final class https://developer.android.com/reference/androidx/credentials/provider/BeginGetCredentialResponse.Builder` Builder for `https://developer.android.com/reference/androidx/credentials/provider/BeginGetCredentialResponse`. |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/credentials/provider/BeginGetCredentialResponse#BeginGetCredentialResponse(kotlin.collections.List,kotlin.collections.List,kotlin.collections.List,androidx.credentials.provider.RemoteEntry)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/credentials/provider/CredentialEntry> credentialEntries, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/credentials/provider/Action> actions, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/credentials/provider/AuthenticationAction> authenticationActions, https://developer.android.com/reference/androidx/credentials/provider/RemoteEntry remoteEntry )` constructs an instance of `https://developer.android.com/reference/androidx/credentials/provider/BeginGetCredentialResponse` |

| ### Public methods |
|---|---|
| `static 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/provider/BeginGetCredentialResponse#asBundle(androidx.credentials.provider.BeginGetCredentialResponse)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/credentials/provider/BeginGetCredentialResponse response)` Helper method to convert the class to a parcelable `https://developer.android.com/reference/android/os/Bundle.html`, in case the class instance needs to be sent across a process. |
| `static final https://developer.android.com/reference/androidx/credentials/provider/BeginGetCredentialResponse` | `https://developer.android.com/reference/androidx/credentials/provider/BeginGetCredentialResponse#fromBundle(android.os.Bundle)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/os/Bundle.html bundle)` Helper method to convert a `https://developer.android.com/reference/android/os/Bundle.html` retrieved through `https://developer.android.com/reference/androidx/credentials/provider/BeginGetCredentialResponse#asBundle(androidx.credentials.provider.BeginGetCredentialResponse)`, back to an instance of `https://developer.android.com/reference/androidx/credentials/provider/BeginGetCredentialResponse`. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/credentials/provider/Action>` | `https://developer.android.com/reference/androidx/credentials/provider/BeginGetCredentialResponse#getActions()()` the list of action entries to be shown on the selector UI, whereby each entry is set to provide an action that the user can perform before retrieving the credential, e.g. selecting a credential from a provider UI |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/credentials/provider/AuthenticationAction>` | `https://developer.android.com/reference/androidx/credentials/provider/BeginGetCredentialResponse#getAuthenticationActions()()` the list of authentication actions to be shown on the selector UI, whereby each entry is set to denote an account/group that is currently locked and cannot return any credentials, allowing the user to select one of these entries and unlock another set of credentials |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/credentials/provider/CredentialEntry>` | `https://developer.android.com/reference/androidx/credentials/provider/BeginGetCredentialResponse#getCredentialEntries()()` the list of credential entries to be shown on the selector UI, whereby each entry is set to provide a potential credential corresponding to a given `https://developer.android.com/reference/androidx/credentials/provider/BeginGetCredentialOption` from the original `https://developer.android.com/reference/androidx/credentials/provider/BeginGetCredentialRequest` |
| `final https://developer.android.com/reference/androidx/credentials/provider/RemoteEntry` | `https://developer.android.com/reference/androidx/credentials/provider/BeginGetCredentialResponse#getRemoteEntry()()` the entry that is set to allow retrieving a credential from another device |

## Public constructors

### BeginGetCredentialResponse

```
public BeginGetCredentialResponse(
    @NonNull List<@NonNull CredentialEntry> credentialEntries,
    @NonNull List<@NonNull Action> actions,
    @NonNull List<@NonNull AuthenticationAction> authenticationActions,
    RemoteEntry remoteEntry
)
```

constructs an instance of `https://developer.android.com/reference/androidx/credentials/provider/BeginGetCredentialResponse`

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/credentials/provider/CredentialEntry> credentialEntries` | the list of credential entries to be shown on the selector UI, whereby each entry is set to provide a potential credential corresponding to a given `https://developer.android.com/reference/androidx/credentials/provider/BeginGetCredentialOption` from the original `https://developer.android.com/reference/androidx/credentials/provider/BeginGetCredentialRequest` |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/credentials/provider/Action> actions` | the list of action entries to be shown on the selector UI, whereby each entry is set to provide an action that the user can perform before retrieving the credential, e.g. selecting a credential from a provider UI |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/credentials/provider/AuthenticationAction> authenticationActions` | the list of authentication actions to be shown on the selector UI, whereby each entry is set to denote an account/group that is currently locked and cannot return any credentials, allowing the user to select one of these entries and unlock another set of credentials |
| `https://developer.android.com/reference/androidx/credentials/provider/RemoteEntry remoteEntry` | the entry that is set to allow retrieving a credential from another device |

## Public methods

### asBundle

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

```
public static final @NonNull Bundle asBundle(@NonNull BeginGetCredentialResponse response)
```

Helper method to convert the class to a parcelable `https://developer.android.com/reference/android/os/Bundle.html`, in case the class instance needs to be sent across a process. Consumers of this method should use `https://developer.android.com/reference/androidx/credentials/provider/BeginGetCredentialResponse#fromBundle(android.os.Bundle)` to reconstruct the class instance back from the bundle returned here.

### fromBundle

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

```
public static final BeginGetCredentialResponse fromBundle(@NonNull Bundle bundle)
```

Helper method to convert a `https://developer.android.com/reference/android/os/Bundle.html` retrieved through `https://developer.android.com/reference/androidx/credentials/provider/BeginGetCredentialResponse#asBundle(androidx.credentials.provider.BeginGetCredentialResponse)`, back to an instance of `https://developer.android.com/reference/androidx/credentials/provider/BeginGetCredentialResponse`.

### getActions

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

```
public final @NonNull List<@NonNull Action> getActions()
```

the list of action entries to be shown on the selector UI, whereby each entry is set to provide an action that the user can perform before retrieving the credential, e.g. selecting a credential from a provider UI

### getAuthenticationActions

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

```
public final @NonNull List<@NonNull AuthenticationAction> getAuthenticationActions()
```

the list of authentication actions to be shown on the selector UI, whereby each entry is set to denote an account/group that is currently locked and cannot return any credentials, allowing the user to select one of these entries and unlock another set of credentials

### getCredentialEntries

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

```
public final @NonNull List<@NonNull CredentialEntry> getCredentialEntries()
```

the list of credential entries to be shown on the selector UI, whereby each entry is set to provide a potential credential corresponding to a given `https://developer.android.com/reference/androidx/credentials/provider/BeginGetCredentialOption` from the original `https://developer.android.com/reference/androidx/credentials/provider/BeginGetCredentialRequest`

### getRemoteEntry

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

```
public final RemoteEntry getRemoteEntry()
```

the entry that is set to allow retrieving a credential from another device