BeginGetCredentialResponse

Artifact: androidx.credentials:credentials

View Source

Added in 1.2.0

---

Kotlin |Java

class BeginGetCredentialResponse

---

Response from a credential provider to BeginGetCredentialRequest, containing credential entries and other associated entries/data to be shown on the account selector UI.

Summary

Nested types
class BeginGetCredentialResponse.Builder Builder for BeginGetCredentialResponse.

Public companion functions
Bundle	asBundle(response: BeginGetCredentialResponse) Helper method to convert the class to a parcelable Bundle, in case the class instance needs to be sent across a process.
BeginGetCredentialResponse?	fromBundle(bundle: Bundle) Helper method to convert a Bundle retrieved through asBundle, back to an instance of BeginGetCredentialResponse.

Public constructors
BeginGetCredentialResponse(     credentialEntries: List<CredentialEntry>,     actions: List<Action>,     authenticationActions: List<AuthenticationAction>,     remoteEntry: RemoteEntry? ) constructs an instance of BeginGetCredentialResponse

Public properties
List<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
List<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
List<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 BeginGetCredentialOption from the original BeginGetCredentialRequest
RemoteEntry?	remoteEntry the entry that is set to allow retrieving a credential from another device

Public companion functions

asBundle

Added in 1.2.0

fun asBundle(response: BeginGetCredentialResponse): Bundle

Helper method to convert the class to a parcelable Bundle, in case the class 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.2.0

fun fromBundle(bundle: Bundle): BeginGetCredentialResponse?

Helper method to convert a Bundle retrieved through asBundle, back to an instance of 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

Parameters
credentialEntries: List<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 from the original BeginGetCredentialRequest
actions: List<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<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? = null	the entry that is set to allow retrieving a credential from another device

Public properties

actions

Added in 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

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

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 from the original BeginGetCredentialRequest

remoteEntry

Added in 1.2.0

val remoteEntry: RemoteEntry?

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