GetCredentialRequest

Kotlin |Java

class GetCredentialRequest : Parcelable

kotlin.Any
↳	android.credentials.GetCredentialRequest

A request to retrieve the user credential, potentially launching UI flows to let the user pick from different credential sources.

Summary

Nested classes
	`Builder` A builder for `GetCredentialRequest`.

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
Boolean	`alwaysSendAppInfoToProvider()` Returns a value to determine if the calling app info should be always sent to the provider in every phase (if true), or should be removed from the query phase, and only sent as part of the request in the final phase, after the user has made a selection on the UI (if false).
Int	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
MutableList<CredentialOption!>	`getCredentialOptions()` Returns the list of credential options to be requested.
Bundle	`getData()` Returns the top request level data.
String?	`getOrigin()` Returns the origin of the calling app if set otherwise returns null.
String	`toString()` Returns a string representation of the object.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

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

Public methods

alwaysSendAppInfoToProvider

Added in API level 34

fun alwaysSendAppInfoToProvider(): Boolean

Returns a value to determine if the calling app info should be always sent to the provider in every phase (if true), or should be removed from the query phase, and only sent as part of the request in the final phase, after the user has made a selection on the UI (if false).

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`

getCredentialOptions

Added in API level 34

fun getCredentialOptions(): MutableList<CredentialOption!>

Returns the list of credential options to be requested.

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

getData

Added in API level 34

fun getData(): Bundle

Returns the top request level data.

Return
`Bundle`	This value cannot be `null`.

getOrigin

Added in API level 34

fun getOrigin(): String?

Returns the origin of the calling app if set otherwise returns null.

toString

Added in API level 34

fun toString(): String

Returns a string representation of the object.

Return
`String`	a string representation of the object.

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!>