GetDigitalCredentialOption

Artifact: androidx.credentials:credentials

Added in 1.5.0

Kotlin |Java

@ExperimentalDigitalCredentialApi
public final class GetDigitalCredentialOption extends CredentialOption

java.lang.Object
↳	androidx.credentials.CredentialOption
	↳	androidx.credentials.GetDigitalCredentialOption

A request to retrieve the user's digital credential, normally used for verification or sign-in purpose.

Note that this option cannot be combined with other types of options in a single GetCredentialRequest.

Summary

Public constructors
`GetDigitalCredentialOption(@NonNull String requestJson)` Constructs a `GetDigitalCredentialOption`.

Public methods
`final @NonNull String`	`getRequestJson()` the request in the JSON format; the latest format is defined at https://wicg.github.io/digital-credentials/#the-digitalcredentialrequestoptions-dictionary

Inherited methods

From androidx.credentials.CredentialOption

`final @NonNull Set<@NonNull ComponentName>`	`getAllowedProviders()` a set of provider service `ComponentName` allowed to receive this option (Note: a `SecurityException` will be thrown if it is set as non-empty but your app does not have android.permission.CREDENTIAL_MANAGER_SET_ALLOWED_PROVIDERS; empty means every provider is eligible; for API level < 34, this property will not take effect and you should control the allowed provider via library dependencies)
`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
`final @NonNull Bundle`	`getRequestData()` the request data in the `Bundle` format
`final @NonNull String`	`getType()` the credential type determined by the credential-type-specific subclass (e.g. the type for `GetPasswordOption` is `PasswordCredential.TYPE_PASSWORD_CREDENTIAL` and for `GetPublicKeyCredentialOption` is `PublicKeyCredential.TYPE_PUBLIC_KEY_CREDENTIAL`)
`final int`	`getTypePriorityHint()` sets the priority of this entry, which defines how it appears in the credential selector, with less precedence than account ordering but more precedence than last used time; see `PriorityHints` for more information
`final boolean`	`isAutoSelectAllowed()` whether a credential entry will be automatically chosen if it is the only one available option
`final boolean`	`isSystemProviderRequired()` true if must only be fulfilled by a system provider and false otherwise

Public constructors

GetDigitalCredentialOption

Added in 1.5.0

public GetDigitalCredentialOption(@NonNull String requestJson)

Constructs a GetDigitalCredentialOption.

Note that this option cannot be combined with other types of options in a single GetCredentialRequest.

Parameters
`@NonNull String requestJson`	the request in the JSON format; the latest format is defined at https://wicg.github.io/digital-credentials/#the-digitalcredentialrequestoptions-dictionary

Throws
`kotlin.IllegalArgumentException`	if the `credentialJson` is not a valid json

Public methods

getRequestJson

Added in 1.5.0

public final @NonNull String getRequestJson()

the request in the JSON format; the latest format is defined at https://wicg.github.io/digital-credentials/#the-digitalcredentialrequestoptions-dictionary