CredentialOption

public final class CredentialOption implements 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 fields

static final @NonNull Parcelable.Creator<@NonNull CredentialOption>

Public constructors

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

constructs an instance of CredentialOption

Public methods

final int
final @NonNull 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

final @NonNull Bundle

the retrieval data in Bundle format

final @NonNull String

deprecated

final @NonNull String

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

final @NonNull String

deprecated

final @NonNull String

the type of the credential to be requested

void
writeToParcel(@NonNull Parcel dest, int flags)

Public fields

CREATOR

public static final @NonNull Parcelable.Creator<@NonNull CredentialOptionCREATOR

Public constructors

CredentialOption

public CredentialOption(
    @NonNull String type,
    @NonNull Bundle credentialRetrievalData,
    @NonNull Bundle candidateQueryData,
    @NonNull String requestMatcher,
    @NonNull String requestType,
    @NonNull String protocolType
)

constructs an instance of CredentialOption

Parameters
@NonNull String type

the type of the credential to be requested

@NonNull Bundle credentialRetrievalData

the retrieval data in Bundle format

@NonNull Bundle candidateQueryData

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

@NonNull String requestMatcher

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

@NonNull String requestType

deprecated

@NonNull String protocolType

deprecated

Public methods

describeContents

public final int describeContents()

getCandidateQueryData

public final @NonNull Bundle getCandidateQueryData()

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

getCredentialRetrievalData

public final @NonNull Bundle getCredentialRetrievalData()

the retrieval data in Bundle format

getProtocolType

public final @NonNull String getProtocolType()

deprecated

getRequestMatcher

public final @NonNull String getRequestMatcher()

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

getRequestType

public final @NonNull String getRequestType()

deprecated

getType

public final @NonNull String getType()

the type of the credential to be requested

writeToParcel

public void writeToParcel(@NonNull Parcel dest, int flags)