GetPasswordOption

public final class GetPasswordOption extends CredentialOption

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

A request to retrieve the user's saved application password from their password provider.

Summary

Public constructors
GetPasswordOption(
    @NonNull Set<@NonNull String> allowedUserIds,
    boolean isAutoSelectAllowed,
    @NonNull Set<@NonNull ComponentName> allowedProviders
)

Constructs a GetPasswordOption.

Public methods
final @NonNull Set<@NonNull String>

a optional set of user ids with which the credentials associated are requested; leave as empty if you want to request all the available user credentials

Inherited methods
From androidx.credentials.CredentialOption
final @NonNull Set<@NonNull ComponentName>

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)
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 request data in the Bundle format
final @NonNull String

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 @PriorityHints int

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

whether a credential entry will be automatically chosen if it is the only one available option
final boolean

true if must only be fulfilled by a system provider and false otherwise

Public constructors

GetPasswordOption

Added in 1.2.0
public GetPasswordOption(
    @NonNull Set<@NonNull String> allowedUserIds,
    boolean isAutoSelectAllowed,
    @NonNull Set<@NonNull ComponentName> allowedProviders
)

Constructs a GetPasswordOption.

Parameters
@NonNull Set<@NonNull String> allowedUserIds

a optional set of user ids with which the credentials associated are requested; leave as empty if you want to request all the available user credentials
boolean isAutoSelectAllowed

false by default, allows auto selecting a password if there is only one available
@NonNull Set<@NonNull 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)

Public methods

getAllowedUserIds

Added in 1.2.0
public final @NonNull Set<@NonNull String> getAllowedUserIds()

a optional set of user ids with which the credentials associated are requested; leave as empty if you want to request all the available user credentials