PublicKeyCredentialEntry

@RequiresApi(value = 23)
public final class PublicKeyCredentialEntry extends CredentialEntry

java.lang.Object
   ↳ androidx.credentials.provider.CredentialEntry
     ↳ androidx.credentials.provider.PublicKeyCredentialEntry

A public key credential entry that is displayed on the account selector UI. This entry denotes that a credential of type PublicKeyCredential.TYPE_PUBLIC_KEY_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
CredentialEntry

Summary

Nested types

Builder for PublicKeyCredentialEntry

Public constructors
PublicKeyCredentialEntry(
    @NonNull Context context,
    @NonNull CharSequence username,
    @NonNull PendingIntent pendingIntent,
    @NonNull BeginGetPublicKeyCredentialOption beginGetPublicKeyCredentialOption,
    CharSequence displayName,
    Instant lastUsedTime,
    @NonNull Icon icon,
    boolean isAutoSelectAllowed,
    boolean isDefaultIconPreferredAsSingleProvider
)
@RequiresApi
PublicKeyCredentialEntry(
    @NonNull Context context,
    @NonNull CharSequence username,
    @NonNull PendingIntent pendingIntent,
    @NonNull BeginGetPublicKeyCredentialOption beginGetPublicKeyCredentialOption,
    CharSequence displayName,
    Instant lastUsedTime,
    @NonNull Icon icon,
    boolean isAutoSelectAllowed,
    boolean isDefaultIconPreferredAsSingleProvider,
    BiometricPromptData biometricPromptData
)

Public methods
static final PublicKeyCredentialEntry

Converts a framework android.service.credentials.CredentialEntry class to a Jetpack PublicKeyCredentialEntry class
final CharSequence

the displayName of the account holding the public key credential
final @NonNull 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 public key credential icon if not provided
final Instant

the last used time of this entry.
final @NonNull 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
final @NonNull CharSequence
final @NonNull CharSequence

the username of the account holding the public key credential
final 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
final boolean
final boolean

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

Inherited methods
From androidx.credentials.provider.CredentialEntry
final 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
final @NonNull BeginGetCredentialOption

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

the data that is set optionally to utilize a credential manager flow that directly handles the biometric verification and presents back the response; set to null by default, so if not opted in, the embedded biometric prompt flow will not show
final @NonNull CharSequence

an ID used for deduplication or to group entries during display
final 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 constructors

PublicKeyCredentialEntry

Added in 1.5.0-beta01
public PublicKeyCredentialEntry(
    @NonNull Context context,
    @NonNull CharSequence username,
    @NonNull PendingIntent pendingIntent,
    @NonNull BeginGetPublicKeyCredentialOption beginGetPublicKeyCredentialOption,
    CharSequence displayName,
    Instant lastUsedTime,
    @NonNull Icon icon,
    boolean isAutoSelectAllowed,
    boolean isDefaultIconPreferredAsSingleProvider
)
Parameters
@NonNull Context context

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

the username of the account holding the public key credential
@NonNull 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
@NonNull BeginGetPublicKeyCredentialOption beginGetPublicKeyCredentialOption

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

the displayName of the account holding the public key credential
Instant lastUsedTime

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
@NonNull Icon icon

the icon to be displayed with this entry on the selector, if not set, a default icon representing a public key credential type is set by the library
boolean isAutoSelectAllowed

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
boolean isDefaultIconPreferredAsSingleProvider

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.NullPointerException

If context, username, pendingIntent, or beginGetPublicKeyCredentialOption is null
kotlin.IllegalArgumentException

if username is empty

PublicKeyCredentialEntry

Added in 1.5.0-beta01
@RequiresApi
public PublicKeyCredentialEntry(
    @NonNull Context context,
    @NonNull CharSequence username,
    @NonNull PendingIntent pendingIntent,
    @NonNull BeginGetPublicKeyCredentialOption beginGetPublicKeyCredentialOption,
    CharSequence displayName,
    Instant lastUsedTime,
    @NonNull Icon icon,
    boolean isAutoSelectAllowed,
    boolean isDefaultIconPreferredAsSingleProvider,
    BiometricPromptData biometricPromptData
)
Parameters
@NonNull Context context

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

the username of the account holding the public key credential
@NonNull 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
@NonNull BeginGetPublicKeyCredentialOption beginGetPublicKeyCredentialOption

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

the displayName of the account holding the public key credential
Instant lastUsedTime

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
@NonNull Icon icon

the icon to be displayed with this entry on the selector, if not set, a default icon representing a public key credential type is set by the library
boolean isAutoSelectAllowed

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
boolean isDefaultIconPreferredAsSingleProvider

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
BiometricPromptData biometricPromptData

the data that is set optionally to utilize a credential manager flow that directly handles the biometric verification and presents back the response; set to null by default, so if not opted in, the embedded biometric prompt flow will not show
Throws
kotlin.NullPointerException

If context, username, pendingIntent, or beginGetPublicKeyCredentialOption is null
kotlin.IllegalArgumentException

if username is empty

Public methods

fromCredentialEntry

Added in 1.5.0-beta01
public static final PublicKeyCredentialEntry fromCredentialEntry(@NonNull CredentialEntry credentialEntry)

Converts a framework android.service.credentials.CredentialEntry class to a Jetpack PublicKeyCredentialEntry 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
@NonNull CredentialEntry credentialEntry

the instance of framework class to be converted

getDisplayName

Added in 1.2.0
public final CharSequence getDisplayName()

the displayName of the account holding the public key credential

getIcon

Added in 1.2.0
public final @NonNull Icon getIcon()

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 public key credential icon if not provided

getLastUsedTime

Added in 1.2.0
public final Instant getLastUsedTime()

the last used time of this entry. Note that this value will only be distinguishable up to the milli second mark. If two entries have the same millisecond precision, they will be considered to have been used at the same time

getPendingIntent

Added in 1.2.0
public final @NonNull PendingIntent getPendingIntent()

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

getTypeDisplayName

Added in 1.2.0
public final @NonNull CharSequence getTypeDisplayName()

getUsername

Added in 1.2.0
public final @NonNull CharSequence getUsername()

the username of the account holding the public key credential

hasDefaultIcon

Added in 1.5.0-beta01
public final boolean hasDefaultIcon()

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

isAutoSelectAllowed

Added in 1.2.0
public final boolean isAutoSelectAllowed()

isAutoSelectAllowedFromOption

Added in 1.5.0-beta01
public final boolean isAutoSelectAllowedFromOption()

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