GetCredentialRequest
class GetCredentialRequest : Parcelable
kotlin.Any | |
↳ | android.service.credentials.GetCredentialRequest |
Request for getting user's credential from a given credential provider.
A credential provider will receive this request once the user selects a given CredentialEntry
, or RemoteEntry
on the selector, that was sourced from provider's initial response to CredentialProviderService#onBeginGetCredential
.
Summary
Inherited constants | |
---|---|
Public constructors | |
---|---|
GetCredentialRequest(callingAppInfo: CallingAppInfo, credentialOptions: MutableList<CredentialOption!>) |
Public methods | |
---|---|
Int | |
CallingAppInfo |
Returns info pertaining to the app requesting credentials. |
MutableList<CredentialOption!> |
Returns a list of options containing parameters needed to return a given type of credential. |
Unit |
writeToParcel(dest: Parcel, flags: Int) Flatten this object in to a Parcel. |
Properties | |
---|---|
static Parcelable.Creator<GetCredentialRequest!> |
Public constructors
GetCredentialRequest
GetCredentialRequest(
callingAppInfo: CallingAppInfo,
credentialOptions: MutableList<CredentialOption!>)
Parameters | |
---|---|
callingAppInfo |
CallingAppInfo: This value cannot be null . |
credentialOptions |
MutableList<CredentialOption!>: This value cannot be null . |
Public methods
describeContents
fun describeContents(): Int
Return | |
---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR |
getCallingAppInfo
fun getCallingAppInfo(): CallingAppInfo
Returns info pertaining to the app requesting credentials.
Return | |
---|---|
CallingAppInfo |
This value cannot be null . |
getCredentialOptions
fun getCredentialOptions(): MutableList<CredentialOption!>
Returns a list of options containing parameters needed to return a given type of credential. This is part of the request that the credential provider receives after the user has selected an entry on a selector UI. When the user selects a CredentialEntry
and the credential provider receives a GetCredentialRequest
, this list is expected to contain a single CredentialOption
only. A CredentialEntry
is always created for a given BeginGetCredentialOption
, and hence when the user selects it, the provider receives a corresponding CredentialOption
that contains all the required parameters to actually retrieve the credential. When the user selects a RemoteEntry
and the credential provider receives a GetCredentialRequest
, this list may contain greater than a single CredentialOption
, representing the number of options specified by the developer in the original android.credentials.GetCredentialRequest
. This is because a RemoteEntry
indicates that the entire request will be processed on a different device and is not tied to a particular option.
Return | |
---|---|
MutableList<CredentialOption!> |
This value cannot be null . |
writeToParcel
fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
Flatten this object in to a Parcel.
Parameters | |
---|---|
dest |
Parcel: This value cannot be null . |
flags |
Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE . Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |