Added in API level 34

BeginGetCredentialOption

class BeginGetCredentialOption : Parcelable
kotlin.Any
   ↳ android.service.credentials.BeginGetCredentialOption

A specific type of credential request to be sent to the provider during the query phase of a get flow. This request contains limited parameters needed to populate a list of CredentialEntry on the BeginGetCredentialResponse.

Summary

Inherited constants
Public constructors
BeginGetCredentialOption(id: String, type: String, candidateQueryData: Bundle)

Constructs a BeginGetCredentialOption.
Public methods
Int

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

Returns the request candidate query data, denoting a set of parameters that can be used to populate a candidate list of credentials, as CredentialEntry on BeginGetCredentialResponse.
String

Returns the unique id associated with this request.
String

Returns the requested credential type.
String

Returns a string representation of the object.
Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.
Properties
static Parcelable.Creator<BeginGetCredentialOption!>

Public constructors

BeginGetCredentialOption

Added in API level 34
BeginGetCredentialOption(
    id: String, 
    type: String, 
    candidateQueryData: Bundle)

Constructs a BeginGetCredentialOption.

Parameters
id String: the unique id associated with this option.
This value cannot be null.
type String: the requested credential type.
This value cannot be null.
candidateQueryData Bundle: the request candidateQueryData.
This value cannot be null.
Exceptions
java.lang.IllegalArgumentException If id or type is empty.

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

getCandidateQueryData

Added in API level 34
fun getCandidateQueryData(): Bundle

Returns the request candidate query data, denoting a set of parameters that can be used to populate a candidate list of credentials, as CredentialEntry on BeginGetCredentialResponse. This list of entries is then presented to the user on a selector.

This data does not contain any sensitive parameters, and will be sent to all eligible providers. The complete set of parameters will only be set on the android.app.PendingIntent set on the CredentialEntry that is selected by the user.

Return
Bundle This value cannot be null.

getId

Added in API level 34
fun getId(): String

Returns the unique id associated with this request. This is for internal use only.

Return
String This value cannot be null.

getType

Added in API level 34
fun getType(): String

Returns the requested credential type.

Return
String This value cannot be 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:

Properties

CREATOR

Added in API level 34
static val CREATOR: Parcelable.Creator<BeginGetCredentialOption!>