BeginGetCredentialOption

public abstract class BeginGetCredentialOption

Known direct subclasses
BeginGetCustomCredentialOption

Allows extending custom versions of BeginGetCredentialOptions for unique use cases.
BeginGetPasswordOption

A request to a password provider to begin the flow of retrieving the user's saved passwords.
BeginGetPublicKeyCredentialOption

A request to begin the flow of getting passkeys from the user's public key credential provider.

Base class that a credential provider receives during the query phase of a get-credential flow. Classes derived from this base class contain parameters required to retrieve a specific type of credential. E.g. BeginGetPasswordOption contains parameters required to retrieve passwords.

BeginGetCredentialRequest will be composed of a list of BeginGetCredentialOption subclasses to indicate the specific credential types and configurations that the credential provider must include while building the BeginGetCredentialResponse.

Throws
kotlin.NullPointerException

If id, type or candidateQueryData is null

Summary

Public methods
final @NonNull Bundle

the parameters needed to retrieve the credentials, in the form of the raw Bundle - can typically be ignored by the credential provider as the required properties are already parse into the structured subclasses
final @NonNull String

unique id representing this particular option, to be used while constructing the CredentialEntry to be set on BeginGetCredentialResponse
final @NonNull String

the type of the credential to be retrieved against this option, e.g. a BeginGetPasswordOption will have type PasswordCredential.TYPE_PASSWORD_CREDENTIAL

Public methods

getCandidateQueryData

Added in 1.2.0
public final @NonNull Bundle getCandidateQueryData()

the parameters needed to retrieve the credentials, in the form of the raw Bundle - can typically be ignored by the credential provider as the required properties are already parse into the structured subclasses

getId

Added in 1.2.0
public final @NonNull String getId()

unique id representing this particular option, to be used while constructing the CredentialEntry to be set on BeginGetCredentialResponse

getType

Added in 1.2.0
public final @NonNull String getType()

the type of the credential to be retrieved against this option, e.g. a BeginGetPasswordOption will have type PasswordCredential.TYPE_PASSWORD_CREDENTIAL