CreateCredentialRequest

public final class CreateCredentialRequest
extends Object implements Parcelable

java.lang.Object
   ↳ 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

class CreateCredentialRequest.Builder

A builder for CreateCredentialRequest. 

Inherited constants

Fields

public static final Creator<CreateCredentialRequest> CREATOR

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()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

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()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

Added in API level 34 
 public static final Creator<CreateCredentialRequest> CREATOR

Public methods

alwaysSendAppInfoToProvider

Added in API level 34 
 public 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).

Returns
boolean

describeContents

Added in API level 34 
 public int describeContents ()

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.

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

getCandidateQueryData

Added in API level 34 
 public Bundle getCandidateQueryData ()

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.

Returns
Bundle This value cannot be null.

getCredentialData

Added in API level 34 
 public Bundle getCredentialData ()

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.

Returns
Bundle This value cannot be null.

getOrigin

Added in API level 34 
 public String getOrigin ()

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

Returns
String

getType

Added in API level 34 
 public String getType ()

Returns the requested credential type.

Returns
String This value cannot be null.

isSystemProviderRequired

Added in API level 34 
 public boolean isSystemProviderRequired ()

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

Returns
boolean

toString

Added in API level 34 
 public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

Added in API level 34 
 public void writeToParcel (Parcel dest, int flags)

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.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES