ProviderGetCredentialRequest

fun asBundle(request: ProviderGetCredentialRequest): Bundle

Helper method to convert the given request to a parcelable Bundle, in case the instance needs to be sent across a process. Consumers of this method should use fromBundle to reconstruct the class instance back from the bundle returned here.

fun fromBundle(bundle: Bundle): ProviderGetCredentialRequest

Helper method to convert a Bundle retrieved through asBundle, back to an instance of ProviderGetCredentialRequest.

Throws IllegalArgumentException if the conversion fails. This means that the given bundle does not contain a ProviderGetCredentialRequest. The bundle should be constructed and retrieved from asBundle itself and never be created from scratch to avoid the failure.

ProviderGetCredentialRequest(
    credentialOptions: List<CredentialOption>,
    callingAppInfo: CallingAppInfo,
    biometricPromptResult: BiometricPromptResult? = null
)

Constructs an instance of ProviderGetCredentialRequest

val biometricPromptResult: BiometricPromptResult?

the result of a Biometric Prompt authentication flow, that is propagated to the provider if the provider requested for androidx.credentials.CredentialManager to handle the authentication flow

val callingAppInfo: CallingAppInfo

information pertaining to the calling application

val credentialOptions: List<CredentialOption>

the list of credential retrieval options containing the required parameters, expected to contain a single CredentialOption when this request is retrieved from the android.app.Activity invoked by the android.app.PendingIntent set on a PasswordCredentialEntry or a PublicKeyCredentialEntry, or expected to contain multiple CredentialOption when this request is retrieved from the android.app.Activity invoked by the android.app.PendingIntent set on a RemoteEntry

val ProviderGetCredentialRequest.selectedEntryId: String?

Returns the id of the entry selected by the user. For example, for a digital credential entry, this maps to the corresponding entry's DigitalCredentialEntry.id.

A null return means that entry ID isn't supported for the given type of the use case at all. For example, a androidx.credentials.provider.PasswordCredentialEntry does not have an id property and so this getter will return null if the selected entry was a password credential.