# BeginGetCredentialResponse

# 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)

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/androidx/credentials/provider/BeginGetCredentialResponse "View this page in Java")

<br />

```
class BeginGetCredentialResponse
```

<br />

*** ** * ** ***

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

## Summary

|                                                                                                                                                ### Nested types                                                                                                                                                 |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `class `[BeginGetCredentialResponse.Builder](https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginGetCredentialResponse.Builder) Builder for[BeginGetCredentialResponse](https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginGetCredentialResponse). |

|                                                      ### Public companion functions                                                      |
|------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Bundle](https://developer.android.com/reference/android/os/Bundle.html)                                                                 | [asBundle](https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginGetCredentialResponse#asBundle(androidx.credentials.provider.BeginGetCredentialResponse))`(response: `[BeginGetCredentialResponse](https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginGetCredentialResponse)`)` Helper method to convert the class to a parcelable[Bundle](https://developer.android.com/reference/android/os/Bundle.html), in case the class instance needs to be sent across a process.                                                                                                                                                                             |
| [BeginGetCredentialResponse](https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginGetCredentialResponse)`?` | [fromBundle](https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginGetCredentialResponse#fromBundle(android.os.Bundle))`(bundle: `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)`)` Helper method to convert a[Bundle](https://developer.android.com/reference/android/os/Bundle.html)retrieved through[asBundle](https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginGetCredentialResponse#asBundle(androidx.credentials.provider.BeginGetCredentialResponse)), back to an instance of[BeginGetCredentialResponse](https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginGetCredentialResponse). |

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 ### Public constructors                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [BeginGetCredentialResponse](https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginGetCredentialResponse#BeginGetCredentialResponse(kotlin.collections.List,kotlin.collections.List,kotlin.collections.List,androidx.credentials.provider.RemoteEntry))`(` ` credentialEntries: `[List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[CredentialEntry](https://developer.android.com/reference/kotlin/androidx/credentials/provider/CredentialEntry)`>,` ` actions: `[List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[Action](https://developer.android.com/reference/kotlin/androidx/credentials/provider/Action)`>,` ` authenticationActions: `[List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[AuthenticationAction](https://developer.android.com/reference/kotlin/androidx/credentials/provider/AuthenticationAction)`>,` ` remoteEntry: `[RemoteEntry](https://developer.android.com/reference/kotlin/androidx/credentials/provider/RemoteEntry)`?` `)` constructs an instance of[BeginGetCredentialResponse](https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginGetCredentialResponse) |

|                                                                                                  ### Public properties                                                                                                   |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[Action](https://developer.android.com/reference/kotlin/androidx/credentials/provider/Action)`>`                             | [actions](https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginGetCredentialResponse#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                                                                                                                                                                                                                                         |
| [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[AuthenticationAction](https://developer.android.com/reference/kotlin/androidx/credentials/provider/AuthenticationAction)`>` | [authenticationActions](https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginGetCredentialResponse#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                                                                                                                                                       |
| [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[CredentialEntry](https://developer.android.com/reference/kotlin/androidx/credentials/provider/CredentialEntry)`>`           | [credentialEntries](https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginGetCredentialResponse#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[BeginGetCredentialOption](https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginGetCredentialOption)from the original[BeginGetCredentialRequest](https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginGetCredentialRequest) |
| [RemoteEntry](https://developer.android.com/reference/kotlin/androidx/credentials/provider/RemoteEntry)`?`                                                                                                               | [remoteEntry](https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginGetCredentialResponse#remoteEntry()) the entry that is set to allow retrieving a credential from another device                                                                                                                                                                                                                                                                                                                                                                           |

## Public companion functions

### asBundle

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

```
fun asBundle(response: BeginGetCredentialResponse): Bundle
```

Helper method to convert the class to a parcelable[Bundle](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[fromBundle](https://developer.android.com/reference/kotlin/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)  

```
fun fromBundle(bundle: Bundle): BeginGetCredentialResponse?
```

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

## Public constructors

### BeginGetCredentialResponse

```
BeginGetCredentialResponse(
    credentialEntries: List<CredentialEntry> = listOf(),
    actions: List<Action> = listOf(),
    authenticationActions: List<AuthenticationAction> = listOf(),
    remoteEntry: RemoteEntry? = null
)
```

constructs an instance of[BeginGetCredentialResponse](https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginGetCredentialResponse)  

|                                                                                                                          Parameters                                                                                                                          |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `credentialEntries: `[List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[CredentialEntry](https://developer.android.com/reference/kotlin/androidx/credentials/provider/CredentialEntry)`> = listOf()`               | 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[BeginGetCredentialOption](https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginGetCredentialOption)from the original[BeginGetCredentialRequest](https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginGetCredentialRequest) |
| `actions: `[List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[Action](https://developer.android.com/reference/kotlin/androidx/credentials/provider/Action)`> = listOf()`                                           | 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                                                                                                                                                                                                                     |
| `authenticationActions: `[List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[AuthenticationAction](https://developer.android.com/reference/kotlin/androidx/credentials/provider/AuthenticationAction)`> = listOf()` | 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                                                                                                                                                               |
| `remoteEntry: `[RemoteEntry](https://developer.android.com/reference/kotlin/androidx/credentials/provider/RemoteEntry)`? = null`                                                                                                                             | the entry that is set to allow retrieving a credential from another device                                                                                                                                                                                                                                                                                                                                                               |

## Public properties

### actions

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

```
val actions: List<Action>
```

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  

### authenticationActions

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

```
val authenticationActions: List<AuthenticationAction>
```

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  

### credentialEntries

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

```
val credentialEntries: List<CredentialEntry>
```

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[BeginGetCredentialOption](https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginGetCredentialOption)from the original[BeginGetCredentialRequest](https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginGetCredentialRequest)  

### remoteEntry

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

```
val remoteEntry: RemoteEntry?
```

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