CredentialOption

class CredentialOption : Parcelable


Base class for getting a specific type of credentials.

GetCredentialRequest will be composed of a list of CredentialOption subclasses to indicate the specific credential types and configurations that your app accepts.

Summary

Public companion properties

Parcelable.Creator<CredentialOption>

Public constructors

CredentialOption(
    type: String,
    credentialRetrievalData: Bundle,
    candidateQueryData: Bundle,
    requestMatcher: String,
    requestType: String,
    protocolType: String
)

constructs an instance of CredentialOption

Public functions

final Int
open Unit
writeToParcel(dest: Parcel, flags: Int)

Public properties

Bundle

the partial request data in the Bundle format that will be sent to the provider during the initial candidate query stage, which will not contain sensitive user information

Bundle

the retrieval data in Bundle format

String

This property is deprecated. Deprecated.

String

the criteria used to filter the request (for instance, age 21)

String

This property is deprecated. Deprecated.

String

the type of the credential to be requested

Public companion properties

Public constructors

CredentialOption

CredentialOption(
    type: String = "",
    credentialRetrievalData: Bundle,
    candidateQueryData: Bundle,
    requestMatcher: String,
    requestType: String = "",
    protocolType: String = ""
)

constructs an instance of CredentialOption

Parameters
type: String = ""

the type of the credential to be requested

credentialRetrievalData: Bundle

the retrieval data in Bundle format

candidateQueryData: Bundle

the partial request data in the Bundle format that will be sent to the provider during the initial candidate query stage, which will not contain sensitive user information

requestMatcher: String

the criteria used to filter the request (for instance, age 21)

requestType: String = ""

deprecated

protocolType: String = ""

deprecated

Public functions

describeContents

final fun describeContents(): Int

writeToParcel

open fun writeToParcel(dest: Parcel, flags: Int): Unit

Public properties

candidateQueryData

val candidateQueryDataBundle

the partial request data in the Bundle format that will be sent to the provider during the initial candidate query stage, which will not contain sensitive user information

credentialRetrievalData

val credentialRetrievalDataBundle

the retrieval data in Bundle format

protocolType

val protocolTypeString

deprecated

requestMatcher

val requestMatcherString

the criteria used to filter the request (for instance, age 21)

requestType

val requestTypeString

deprecated

type

val typeString

the type of the credential to be requested