GetCustomCredentialOption

Artifact: androidx.credentials:credentials

Added in 1.2.0

Kotlin |Java

open class GetCustomCredentialOption : CredentialOption

kotlin.Any
↳	androidx.credentials.CredentialOption
	↳	androidx.credentials.GetCustomCredentialOption

Allows extending custom versions of GetCredentialOptions for unique use cases.

If you get a GetCustomCredentialOption instead of a type-safe option class such as GetPasswordOption, GetPublicKeyCredentialOption, 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.

Note: The Bundle keys for requestData and candidateQueryData should not be in the form of androidx.credentials.* as they are reserved for internal use by this androidx library.

The typePriorityHint bit helps decide where the credential will be displayed on the selector. It is used with more importance than signals like 'last recently used' but with less importance than other signals, such as the ordering of displayed accounts. It is expected to be one of the defined PriorityHints constants. By default, GetCustomCredentialOption will have PriorityHints.PRIORITY_DEFAULT, GetPasswordOption will have PriorityHints.PRIORITY_PASSWORD_OR_SIMILAR and GetPublicKeyCredentialOption will have PriorityHints.PRIORITY_PASSKEY_OR_SIMILAR. It is expected that GetCustomCredentialOption types will remain unchanged unless strong reasons arise and cannot ever have PriorityHints.PRIORITY_PASSKEY_OR_SIMILAR. Given passkeys prevent many security threats that other credentials do not, we enforce that nothing is shown higher than passkey types in order to provide end users with the safest credentials first. See the spec here for more information on passkeys.

Summary

Public constructors
`GetCustomCredentialOption( type: String, requestData: Bundle, candidateQueryData: Bundle, isSystemProviderRequired: Boolean, isAutoSelectAllowed: Boolean, allowedProviders: Set<ComponentName> )` Allows extending custom versions of GetCredentialOptions for unique use cases.
`GetCustomCredentialOption( type: String, requestData: Bundle, candidateQueryData: Bundle, isSystemProviderRequired: Boolean, isAutoSelectAllowed: Boolean, allowedProviders: Set<ComponentName>, typePriorityHint: @PriorityHints Int )` Allows extending custom versions of GetCredentialOptions for unique use cases.

Inherited properties

From androidx.credentials.CredentialOption

`Set<ComponentName>`	`allowedProviders` 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; for API level < 34, this property will not take effect and you should control the allowed provider via library dependencies)
`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
`Boolean`	`isAutoSelectAllowed` whether a credential entry will be automatically chosen if it is the only one available option
`Boolean`	`isSystemProviderRequired` true if must only be fulfilled by a system provider and false otherwise
`Bundle`	`requestData` the request data in the `Bundle` format
`String`	`type` 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`)
`@PriorityHints Int`	`typePriorityHint` 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

Public constructors