BeginGetCredentialRequest
public final class BeginGetCredentialRequest
Query stage request for getting user's credentials from a given credential provider.
This request contains a list of BeginGetCredentialOption that have parameters to be used to query credentials, and return a BeginGetCredentialResponse, containing a list CredentialEntry that are presented to the user on an selector.
Note : Credential providers are not expected to utilize the constructor in this class for any production flow. This constructor must only be used for testing purposes.
| Throws | |
|---|---|
kotlin.NullPointerException |
If |
Summary
Public constructors |
|---|
BeginGetCredentialRequest(constructs an instance of |
Public methods |
|
|---|---|
static final @NonNull Bundle |
asBundle(@NonNull BeginGetCredentialRequest request)Helper method to convert the class to a parcelable |
static final BeginGetCredentialRequest |
fromBundle(@NonNull Bundle bundle)Helper method to convert a |
final @NonNull List<@NonNull BeginGetCredentialOption> |
the list of type specific credential options to to be processed in order to produce a |
final CallingAppInfo |
info pertaining to the app requesting credentials |
Public constructors
BeginGetCredentialRequest
public BeginGetCredentialRequest(
@NonNull List<@NonNull BeginGetCredentialOption> beginGetCredentialOptions,
CallingAppInfo callingAppInfo
)
constructs an instance of BeginGetCredentialRequest
| Parameters | |
|---|---|
@NonNull List<@NonNull BeginGetCredentialOption> beginGetCredentialOptions |
the list of type specific credential options to to be processed in order to produce a |
CallingAppInfo callingAppInfo |
info pertaining to the app requesting credentials |
Public methods
asBundle
public static final @NonNull Bundle asBundle(@NonNull BeginGetCredentialRequest request)
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 BeginGetCredentialRequest fromBundle(@NonNull Bundle bundle)
Helper method to convert a Bundle retrieved through asBundle, back to an instance of BeginGetCredentialRequest.
getBeginGetCredentialOptions
public final @NonNull List<@NonNull BeginGetCredentialOption> getBeginGetCredentialOptions()
the list of type specific credential options to to be processed in order to produce a BeginGetCredentialResponse
getCallingAppInfo
public final CallingAppInfo getCallingAppInfo()
info pertaining to the app requesting credentials