BeginGetCredentialResponse
public final 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 |
|---|
public final class BeginGetCredentialResponse.BuilderBuilder for |
Public constructors |
|---|
BeginGetCredentialResponse(constructs an instance of |
Public methods |
|
|---|---|
static final @NonNull Bundle |
asBundle(@NonNull BeginGetCredentialResponse response)Helper method to convert the class to a parcelable |
static final BeginGetCredentialResponse |
fromBundle(@NonNull Bundle bundle)Helper method to convert a |
final @NonNull List<@NonNull 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 |
final @NonNull List<@NonNull 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 |
final @NonNull List<@NonNull 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 |
final RemoteEntry |
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 BeginGetCredentialResponse
| Parameters | |
|---|---|
@NonNull List<@NonNull 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 |
@NonNull List<@NonNull 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 |
@NonNull List<@NonNull 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 |
RemoteEntry remoteEntry |
the entry that is set to allow retrieving a credential from another device |
Public methods
asBundle
public static final @NonNull Bundle asBundle(@NonNull BeginGetCredentialResponse response)
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
public static final BeginGetCredentialResponse fromBundle(@NonNull Bundle bundle)
Helper method to convert a Bundle retrieved through asBundle, back to an instance of BeginGetCredentialResponse.
getActions
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
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
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 BeginGetCredentialOption from the original BeginGetCredentialRequest
getRemoteEntry
public final RemoteEntry getRemoteEntry()
the entry that is set to allow retrieving a credential from another device