Added in API level 34

CreateCredentialRequest

---

Kotlin |Java

class CreateCredentialRequest : Parcelable

kotlin.Any
↳	android.credentials.CreateCredentialRequest

A request to register a specific type of user credential, potentially launching UI flows to collect user consent and any other operation needed.

Summary

Nested classes
	Builder A builder for CreateCredentialRequest.

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() Return true/false value to determine if the calling app info should always be sent to providers (if true), or removed from the query phase (if false).
Int	describeContents()
Bundle	getCandidateQueryData() Returns the partial request data that will be sent to the provider during the initial creation candidate query stage.
Bundle	getCredentialData() Returns the full credential creation request data.
String?	getOrigin() Returns the origin of the calling app if set otherwise returns null.
String	getType() Returns the requested credential type.
Boolean	isSystemProviderRequired() Returns true if the request must only be fulfilled by a system provider, and false otherwise.
String	toString()
Unit	writeToParcel(dest: Parcel, flags: Int) Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<CreateCredentialRequest!>	CREATOR

Public methods

alwaysSendAppInfoToProvider

Added in API level 34

fun alwaysSendAppInfoToProvider(): Boolean

Return true/false value to determine if the calling app info should always be sent to providers (if true), or removed from the query phase (if false).

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

getCandidateQueryData

Added in API level 34

fun getCandidateQueryData(): Bundle

Returns the partial request data that will be sent to the provider during the initial creation candidate query stage. For security reason, a provider will receive the request data in two stages. First it gets this partial request that do not contain sensitive user information; it uses this information to provide credential creation candidates that the [@code CredentialManager] will show to the user. Next, the full request data, getCredentialData(), will be sent to a provider only if the user further grants the consent by choosing a candidate from the provider.

Return
Bundle	This value cannot be null.

getCredentialData

Added in API level 34

fun getCredentialData(): Bundle

Returns the full credential creation request data. For security reason, a provider will receive the request data in two stages. First it gets a partial request, getCandidateQueryData() that do not contain sensitive user information; it uses this information to provide credential creation candidates that the [@code CredentialManager] will show to the user. Next, this full request data will be sent to a provider only if the user further grants the consent by choosing a candidate from the provider.

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.

getType

Added in API level 34

fun getType(): String

Returns the requested credential type.

Return
String	This value cannot be null.

isSystemProviderRequired

Added in API level 34

fun isSystemProviderRequired(): Boolean

Returns true if the request must only be fulfilled by a system provider, and false otherwise.

toString

Added in API level 34

fun toString(): String

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