BeginGetCredentialRequest

Kotlin |Java

class BeginGetCredentialRequest : Parcelable

kotlin.Any
↳	android.service.credentials.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 list of CredentialEntry to be set on the BeginGetCredentialResponse. This list is then shown to the user on a selector. If a PendingIntent is set on a CredentialEntry, and the user selects that entry, a GetCredentialRequest with all parameters needed to get the actual android.credentials.Credential will be sent as part of the Intent fired through the PendingIntent.

Summary

Nested classes
	`Builder` Builder for `BeginGetCredentialRequest`.

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 methods
Int	`describeContents()`
MutableList<BeginGetCredentialOption!>	`getBeginGetCredentialOptions()` Returns the list of type specific credential options to list credentials for in `BeginGetCredentialResponse`.
CallingAppInfo?	`getCallingAppInfo()` Returns info pertaining to the app requesting credentials.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<BeginGetCredentialRequest!>	`CREATOR`

Public methods

describeContents

Added in API level 34

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`

getBeginGetCredentialOptions

Added in API level 34

fun getBeginGetCredentialOptions(): MutableList<BeginGetCredentialOption!>

Returns the list of type specific credential options to list credentials for in BeginGetCredentialResponse.

Return
`MutableList<BeginGetCredentialOption!>`	This value cannot be `null`.

getCallingAppInfo

Added in API level 34

fun getCallingAppInfo(): CallingAppInfo?

Returns info pertaining to the app requesting credentials.

Return
`CallingAppInfo?`	This value may 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 `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 34

static val CREATOR: Parcelable.Creator<BeginGetCredentialRequest!>