CustomCredentialEntry
@RequiresApi(value = 26)
public final class CustomCredentialEntry extends CredentialEntry
| java.lang.Object | ||
| ↳ | androidx.credentials.provider.CredentialEntry | |
| ↳ | androidx.credentials.provider.CustomCredentialEntry | |
Custom credential entry for a custom credential type that is displayed on the account selector UI.
Each entry corresponds to an account that can provide a credential.
| See also | |
|---|---|
CredentialEntry |
Summary
Nested types |
|---|
public final class CustomCredentialEntry.BuilderBuilder for |
Public constructors |
|---|
CustomCredentialEntry( |
Public methods |
|
|---|---|
static final CustomCredentialEntry |
fromCredentialEntry(@NonNull CredentialEntry credentialEntry)Converts a framework |
final @NonNull Icon |
getIcon()the icon to be displayed with this entry on the UI, must be created using |
final Instant |
the last used time the credential underlying this entry was used by the user. |
final @NonNull PendingIntent |
the |
final CharSequence |
the subTitle shown with this entry on the selector UI |
final @NonNull CharSequence |
getTitle()the title shown with this entry on the selector UI |
@NonNull String |
getType() |
final CharSequence |
the friendly name to be displayed on the UI for the type of the 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 |
whether this entry is allowed to be auto selected if it is the only one on the UI. |
final boolean |
whether the |
Inherited methods |
||||||||
|---|---|---|---|---|---|---|---|---|
|
Public constructors
CustomCredentialEntry
public CustomCredentialEntry(
@NonNull Context context,
@NonNull CharSequence title,
@NonNull PendingIntent pendingIntent,
@NonNull BeginGetCredentialOption beginGetCredentialOption,
CharSequence subtitle,
CharSequence typeDisplayName,
Instant lastUsedTime,
@NonNull Icon icon,
boolean isAutoSelectAllowed,
@NonNull CharSequence entryGroupId,
boolean isDefaultIconPreferredAsSingleProvider
)
| Parameters | |
|---|---|
@NonNull Context context |
the context of the calling app, required to retrieve fallback resources |
@NonNull CharSequence title |
the title shown with this entry on the selector UI |
@NonNull PendingIntent pendingIntent |
the |
@NonNull BeginGetCredentialOption beginGetCredentialOption |
the option from the original |
CharSequence subtitle |
the subTitle shown with this entry on the selector UI |
CharSequence typeDisplayName |
the friendly name to be displayed on the UI for the type of the 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 UI, if not set a default icon representing a custom 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 |
@NonNull CharSequence entryGroupId |
an ID to uniquely mark this entry for deduplication or to group entries during display, set to |
boolean isDefaultIconPreferredAsSingleProvider |
when set to true, the UI prefers to render the default credential type icon (see the default value of |
Public methods
fromCredentialEntry
public static final CustomCredentialEntry fromCredentialEntry(@NonNull CredentialEntry credentialEntry)
Converts a framework android.service.credentials.CredentialEntry class to a Jetpack CustomCredentialEntry class
| Parameters | |
|---|---|
@NonNull CredentialEntry credentialEntry |
the instance of framework class to be converted |
getIcon
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 custom credential icon if not provided
getLastUsedTime
public final Instant getLastUsedTime()
the last used time the credential underlying this entry was used by the user. 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
public final @NonNull PendingIntent getPendingIntent()
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
getSubtitle
public final CharSequence getSubtitle()
the subTitle shown with this entry on the selector UI
getTitle
public final @NonNull CharSequence getTitle()
the title shown with this entry on the selector UI
getTypeDisplayName
public final CharSequence getTypeDisplayName()
the friendly name to be displayed on the UI for the type of the credential
hasDefaultIcon
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
public final boolean isAutoSelectAllowed()
whether this entry is allowed to be auto selected if it is the only one on the UI. Note that setting this value to true does not guarantee this behavior. The developer must also set this to true, and the framework must determine that only one entry is present
isAutoSelectAllowedFromOption
public final boolean isAutoSelectAllowedFromOption()
whether the beginGetCredentialOption request for which this entry was created allows this entry to be auto-selected