PasswordCredentialEntry

@RequiresApi(value = 26)
class PasswordCredentialEntry : CredentialEntry

kotlin.Any
   ↳ androidx.credentials.provider.CredentialEntry
     ↳ androidx.credentials.provider.PasswordCredentialEntry

A password credential entry that is displayed on the account selector UI. This entry denotes that a credential of type PasswordCredential.TYPE_PASSWORD_CREDENTIAL is available for the user to select.

Once this entry is selected, the corresponding pendingIntent will be invoked. The provider can then show any activity they wish to. Before finishing the activity, provider must set the final androidx.credentials.GetCredentialResponse through the PendingIntentHandler.setGetCredentialResponse helper API.

Throws
kotlin.IllegalArgumentException

If username is empty
See also
CustomCredentialEntry
CredentialEntry

Summary

Nested types

Builder for PasswordCredentialEntry

Public companion functions
PasswordCredentialEntry?

Converts a framework android.service.credentials.CredentialEntry class to a Jetpack PasswordCredentialEntry class

Public constructors
PasswordCredentialEntry(
    context: Context,
    username: CharSequence,
    pendingIntent: PendingIntent,
    beginGetPasswordOption: BeginGetPasswordOption,
    displayName: CharSequence?,
    lastUsedTime: Instant?,
    icon: Icon,
    isAutoSelectAllowed: Boolean,
    affiliatedDomain: CharSequence?,
    isDefaultIconPreferredAsSingleProvider: Boolean
)

Public properties
CharSequence?

the displayName of the account holding the password credential
Boolean

whether this entry was created without a custom icon and hence contains a default icon set by the library, only to be used in Android API levels >= 28
Icon

the icon to be displayed with this entry on the UI, must be created using Icon.createWithResource when possible, and especially not with Icon.createWithBitmap as the latter consumes more memory and may cause undefined behavior due to memory implications on internal transactions; defaulted to a fallback password credential icon if not provided
Boolean
Boolean

whether the beginGetCredentialOption request for which this entry was created allows this entry to be auto-selected
Instant?

the last used time of this entry, distinguishable up to the milli second mark, such that if two entries have the same millisecond precision, they will be considered to have been used at the same time
PendingIntent

the PendingIntent that will get invoked when the user selects this entry, must be created with a unique request code per entry, with flag PendingIntent.FLAG_MUTABLE to allow the Android system to attach the final request, and NOT with flag PendingIntent.FLAG_ONE_SHOT as it can be invoked multiple times
CharSequence
CharSequence

the username of the account holding the password credential

Inherited properties
From androidx.credentials.provider.CredentialEntry
CharSequence?

the user visible affiliated domain, a CharSequence representation of a web domain or an app package name that the given credential in this entry is associated with when it is different from the requesting entity, default null
BeginGetCredentialOption

the option from the original BeginGetCredentialRequest, for which this credential entry is being added
CharSequence

an ID used for deduplication or to group entries during display
Boolean

when set to true, the UI prefers to render the default credential type icon when you are the only available provider; see individual subclasses for these default icons (e.g. for PublicKeyCredentialEntry, it is based on R.drawable.ic_password)

Public companion functions

fromCredentialEntry

Added in 1.3.0-alpha03
fun fromCredentialEntry(credentialEntry: CredentialEntry): PasswordCredentialEntry?

Converts a framework android.service.credentials.CredentialEntry class to a Jetpack PasswordCredentialEntry class

Note that this API is not needed in a general credential retrieval flow that is implemented using this jetpack library, where you are only required to construct an instance of CredentialEntry to populate the BeginGetCredentialResponse.

Parameters
credentialEntry: CredentialEntry

the instance of framework class to be converted

Public constructors

PasswordCredentialEntry

Added in 1.3.0-alpha03
PasswordCredentialEntry(
    context: Context,
    username: CharSequence,
    pendingIntent: PendingIntent,
    beginGetPasswordOption: BeginGetPasswordOption,
    displayName: CharSequence? = null,
    lastUsedTime: Instant? = null,
    icon: Icon = Icon.createWithResource(context, R.drawable.ic_password),
    isAutoSelectAllowed: Boolean = false,
    affiliatedDomain: CharSequence? = null,
    isDefaultIconPreferredAsSingleProvider: Boolean = false
)
Parameters
context: Context

the context of the calling app, required to retrieve fallback resources
username: CharSequence

the username of the account holding the password credential
pendingIntent: PendingIntent

the PendingIntent that will get invoked when the user selects this entry, must be created with flag PendingIntent.FLAG_MUTABLE to allow the Android system to attach the final request
beginGetPasswordOption: BeginGetPasswordOption

the option from the original BeginGetCredentialRequest, for which this credential entry is being added
displayName: CharSequence? = null

the displayName of the account holding the password credential
lastUsedTime: Instant? = null

the last used time the credential underlying this entry was used by the user, distinguishable up to the milli second mark only such that if two entries have the same millisecond precision, they will be considered to have been used at the same time
icon: Icon = Icon.createWithResource(context, R.drawable.ic_password)

the icon to be displayed with this entry on the selector, if not set, a default icon representing a password credential type is set by the library
isAutoSelectAllowed: Boolean = false

whether this entry is allowed to be auto selected if it is the only one on the UI, only takes effect if the app requesting for credentials also opts for auto select
affiliatedDomain: CharSequence? = null

the user visible affiliated domain, a CharSequence representation of a web domain or an app package name that the given credential in this entry is associated with when it is different from the requesting entity, default null
isDefaultIconPreferredAsSingleProvider: Boolean = false

when set to true, the UI prefers to render the default credential type icon (see the default value of icon) when you are the only available provider; false by default
Throws
kotlin.IllegalArgumentException

If username is empty
kotlin.NullPointerException

If context, username, pendingIntent, or beginGetPasswordOption is null

Public properties

displayName

Added in 1.2.0
val displayName: CharSequence?

the displayName of the account holding the password credential

hasDefaultIcon

Added in 1.3.0-alpha03
val hasDefaultIcon: Boolean

whether this entry was created without a custom icon and hence contains a default icon set by the library, only to be used in Android API levels >= 28

icon

Added in 1.2.0
val icon: Icon

the icon to be displayed with this entry on the UI, must be created using Icon.createWithResource when possible, and especially not with Icon.createWithBitmap as the latter consumes more memory and may cause undefined behavior due to memory implications on internal transactions; defaulted to a fallback password credential icon if not provided

isAutoSelectAllowed

Added in 1.2.0
val isAutoSelectAllowed: Boolean

isAutoSelectAllowedFromOption

Added in 1.3.0-alpha03
val isAutoSelectAllowedFromOption: Boolean

whether the beginGetCredentialOption request for which this entry was created allows this entry to be auto-selected

lastUsedTime

Added in 1.2.0
val lastUsedTime: Instant?

the last used time of this entry, distinguishable up to the milli second mark, such that if two entries have the same millisecond precision, they will be considered to have been used at the same time

pendingIntent

Added in 1.2.0
val pendingIntent: PendingIntent

the PendingIntent that will get invoked when the user selects this entry, must be created with a unique request code per entry, with flag PendingIntent.FLAG_MUTABLE to allow the Android system to attach the final request, and NOT with flag PendingIntent.FLAG_ONE_SHOT as it can be invoked multiple times

typeDisplayName

Added in 1.2.0
val typeDisplayName: CharSequence

username

Added in 1.2.0
val username: CharSequence

the username of the account holding the password credential