Added in API level 34

GetCredentialRequest

---

Kotlin |Java

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

From class Parcelable Int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. Int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public constructors
GetCredentialRequest(callingAppInfo: CallingAppInfo, credentialOptions: MutableList<CredentialOption!>)

Public methods
Int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
CallingAppInfo	getCallingAppInfo() Returns info pertaining to the app requesting credentials.
MutableList<CredentialOption!>	getCredentialOptions() 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!>	CREATOR

Public constructors

GetCredentialRequest

Added in API level 34

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

Added in API level 34

fun describeContents(): Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Return
Int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

getCallingAppInfo

Added in API level 34

fun getCallingAppInfo(): CallingAppInfo

Returns info pertaining to the app requesting credentials.

Return
CallingAppInfo	This value cannot be null.

getCredentialOptions

Added in API level 34

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

Added in API level 34

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 the following: PARCELABLE_WRITE_RETURN_VALUE

Properties

CREATOR

Added in API level 34

static val CREATOR: Parcelable.Creator<GetCredentialRequest!>