BeginGetCustomCredentialOption


open class BeginGetCustomCredentialOption : BeginGetCredentialOption


Allows extending custom versions of BeginGetCredentialOptions for unique use cases.

If you get a BeginGetCustomCredentialOption instead of a type-safe option class such as BeginGetPasswordOption, BeginGetPublicKeyCredentialOption, etc., then you should check if you have any other library at interest that supports this custom type of credential option, and if so use its parsing utilities to resolve to a type-safe class within that library.

Throws
kotlin.IllegalArgumentException

If type is null or, empty

Summary

Public constructors

BeginGetCustomCredentialOption(
    id: String,
    type: String,
    candidateQueryData: Bundle
)

Inherited properties

From androidx.credentials.provider.BeginGetCredentialOption
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

String

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

String

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

Public constructors

BeginGetCustomCredentialOption

Added in 1.2.0
BeginGetCustomCredentialOption(
    id: String,
    type: String,
    candidateQueryData: Bundle
)