CreatePasswordRequest
class CreatePasswordRequest : CreateCredentialRequest
| kotlin.Any | ||
| ↳ | androidx.credentials.CreateCredentialRequest | |
| ↳ | androidx.credentials.CreatePasswordRequest |
A request to save the user password credential with their password provider.
Summary
Public constructors |
|---|
CreatePasswordRequest(Constructs a |
CreatePasswordRequest(Constructs a |
Inherited properties |
||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Public constructors
CreatePasswordRequest
CreatePasswordRequest(
id: String,
password: String,
origin: String? = null,
preferImmediatelyAvailableCredentials: Boolean = false,
isAutoSelectAllowed: Boolean = false
)
Constructs a CreatePasswordRequest to save the user password credential with their password provider.
| Parameters | |
|---|---|
id: String |
the user id associated with the password |
password: String |
the password |
origin: String? = null |
the origin of a different application if the request is being made on behalf of that application (Note: for API level >=34, setting a non-null value for this parameter will throw a SecurityException if android.permission.CREDENTIAL_MANAGER_SET_ORIGIN is not present) |
preferImmediatelyAvailableCredentials: Boolean = false |
true if you prefer the operation to return immediately when there is no available password saving option instead of falling back to discovering remote options, and false (default) otherwise |
isAutoSelectAllowed: Boolean = false |
whether a create option will be automatically chosen if it is the only one available to the user (note that there is a chance that the credential provider does not support auto-select even if you turn this bit on); not recommended to be true for password request type to ensure that the user will always get a confirmation dialog even if the password saving provider does not offer any UI |
| Throws | |
|---|---|
kotlin.NullPointerException |
If |
kotlin.NullPointerException |
If |
kotlin.IllegalArgumentException |
If |
java.lang.SecurityException |
if |
CreatePasswordRequest
CreatePasswordRequest(
id: String,
password: String,
origin: String?,
preferDefaultProvider: String?,
preferImmediatelyAvailableCredentials: Boolean,
isAutoSelectAllowed: Boolean
)
Constructs a CreatePasswordRequest to save the user password credential with their password provider.
| Parameters | |
|---|---|
id: String |
the user id associated with the password |
password: String |
the password |
origin: String? |
the origin of a different application if the request is being made on behalf of that application (Note: for API level >=34, setting a non-null value for this parameter will throw a SecurityException if android.permission.CREDENTIAL_MANAGER_SET_ORIGIN is not present) |
preferDefaultProvider: String? |
the preferred default provider component name to prioritize in the selection UI flows (Note: your app must have the permission android.permission.CREDENTIAL_MANAGER_SET_ALLOWED_PROVIDERS to specify this, or it would not take effect; also this bit may not take effect for Android API level 33 and below, depending on the pre-34 provider(s) you have chosen) |
preferImmediatelyAvailableCredentials: Boolean |
true if you prefer the operation to return immediately when there is no available passkey registration offering instead of falling back to discovering remote options, and false (preferably) otherwise |
isAutoSelectAllowed: Boolean |
whether a create option will be automatically chosen if it is the only one available to the user (note that there is a chance that the credential provider does not support auto-select even if you turn this bit on); not recommended to be true for password request type to ensure that the user will always get a confirmation dialog even if the password saving provider does not offer any UI |
| Throws | |
|---|---|
kotlin.NullPointerException |
If |
kotlin.NullPointerException |
If |
kotlin.IllegalArgumentException |
If |
java.lang.SecurityException |
if |