PrepareGetCredentialResponse

Kotlin |Java

class PrepareGetCredentialResponse

kotlin.Any
↳	android.credentials.PrepareGetCredentialResponse

A response object that prefetches user app credentials and provides metadata about them. It can then be used to issue the full credential retrieval flow via the CredentialManager.getCredential(Context, PendingGetCredentialHandle, CancellationSignal, method to perform the remaining flows such as consent collection and credential selection, to officially retrieve a credential.

Summary

Nested classes
	`PendingGetCredentialHandle` A handle that represents a pending get-credential operation.

Public methods
PrepareGetCredentialResponse.PendingGetCredentialHandle	`getPendingGetCredentialHandle()` Returns a handle that represents this pending get-credential operation.
Boolean	`hasAuthenticationResults()` Returns true if the user has any candidate authentication actions (locked credential supplier), and false otherwise.
Boolean	`hasCredentialResults(credentialType: String)` Returns true if the user has any candidate credentials for the given `credentialType`, and false otherwise.
Boolean	`hasRemoteResults()` Returns true if the user has any candidate remote credential results, and false otherwise.

Public methods

getPendingGetCredentialHandle

Added in API level 34

fun getPendingGetCredentialHandle(): PrepareGetCredentialResponse.PendingGetCredentialHandle

Returns a handle that represents this pending get-credential operation. Pass this handle to CredentialManager.getCredential(Context, PendingGetCredentialHandle, to perform the remaining flows to officially retrieve a credential.

Return
`PrepareGetCredentialResponse.PendingGetCredentialHandle`	This value cannot be `null`.

hasAuthenticationResults

Added in API level 34

fun hasAuthenticationResults(): Boolean

Returns true if the user has any candidate authentication actions (locked credential supplier), and false otherwise.
Requires android.Manifest.permission#CREDENTIAL_MANAGER_QUERY_CANDIDATE_CREDENTIALS

hasCredentialResults

Added in API level 34

fun hasCredentialResults(credentialType: String): Boolean

Returns true if the user has any candidate credentials for the given credentialType, and false otherwise.
Requires android.Manifest.permission#CREDENTIAL_MANAGER_QUERY_CANDIDATE_CREDENTIALS

Parameters
`credentialType`	String: This value cannot be `null`.

hasRemoteResults

Added in API level 34

fun hasRemoteResults(): Boolean

Returns true if the user has any candidate remote credential results, and false otherwise.
Requires android.Manifest.permission#CREDENTIAL_MANAGER_QUERY_CANDIDATE_CREDENTIALS