ExportEntry

Artifact: androidx.credentials.providerevents:providerevents

Kotlin |Java

public final class ExportEntry

Each export entry corresponds to an entry in the provider selector UI that the user can choose from.

ExportEntry serves two purposes:

Contain display data to be shown on the selector UI.
Contain fields that can be used to match an incoming ImportCredentialsRequest. By default, the supportedCredentialTypes field will be used to match against the request.

Throws
`kotlin.IllegalArgumentException`	if `supportedCredentialTypes` is empty

Summary

Public constructors
`ExportEntry( @NonNull String id, CharSequence accountDisplayName, @NonNull CharSequence userDisplayName, @NonNull Bitmap icon, @NonNull Set<@NonNull String> supportedCredentialTypes )`

Public methods
`final CharSequence`	`getAccountDisplayName()` the account display name of the entry
`final @NonNull Bitmap`	`getIcon()` the icon to display for this entry; this icon should be 32x32 and if not will be rescaled into a 32x32 pixel PGN for display
`final @NonNull String`	`getId()` the secret id that is used to identify the export entry.
`final @NonNull Set<@NonNull String>`	`getSupportedCredentialTypes()` the credential types that this entry supports.
`final @NonNull CharSequence`	`getUserDisplayName()` the user display name of the entry

Public constructors

ExportEntry

Added in 1.0.0-alpha03

public ExportEntry(
    @NonNull String id,
    CharSequence accountDisplayName,
    @NonNull CharSequence userDisplayName,
    @NonNull Bitmap icon,
    @NonNull Set<@NonNull String> supportedCredentialTypes
)

Parameters
`@NonNull String id`	the secret id that is used to identify the export entry. This should be randomly generated and stored. When the provider's credential transfer activity gets launched, the provider should verify that the `ProviderImportCredentialsRequest` contains the pre-registered id.
`CharSequence accountDisplayName`	the account display name of the entry
`@NonNull CharSequence userDisplayName`	the user display name of the entry
`@NonNull Bitmap icon`	the icon to display for this entry; this icon should be 32x32 and if not will be rescaled into a 32x32 pixel PGN for display
`@NonNull Set<@NonNull String> supportedCredentialTypes`	the credential types that this entry supports. By default, this field will be used to filter whether the entry will be displayed for an incoming import request. The values include, but not limited to, the constants in `CredentialTypes`

Public methods

getAccountDisplayName

Added in 1.0.0-alpha03

public final CharSequence getAccountDisplayName()

the account display name of the entry

getIcon

Added in 1.0.0-alpha03

public final @NonNull Bitmap getIcon()

the icon to display for this entry; this icon should be 32x32 and if not will be rescaled into a 32x32 pixel PGN for display

getId

Added in 1.0.0-alpha03

public final @NonNull String getId()

the secret id that is used to identify the export entry. This should be randomly generated and stored. When the provider's credential transfer activity gets launched, the provider should verify that the ProviderImportCredentialsRequest contains the pre-registered id.

getSupportedCredentialTypes

Added in 1.0.0-alpha03

public final @NonNull Set<@NonNull String> getSupportedCredentialTypes()

the credential types that this entry supports. By default, this field will be used to filter whether the entry will be displayed for an incoming import request. The values include, but not limited to, the constants in CredentialTypes

getUserDisplayName

Added in 1.0.0-alpha03

public final @NonNull CharSequence getUserDisplayName()

the user display name of the entry