PrepareGetCredentialResponse


@RequiresApi(value = 34)
class PrepareGetCredentialResponse


A response object that indicates the get-credential prefetch work is complete and provides metadata about it. It can then be used to issue the full credential retrieval flow via the CredentialManager.getCredential (Kotlin) / CredentialManager.getCredentialAsync (Java) method to perform the remaining flows such as consent collection and credential selection, to officially retrieve a credential.

For now this API requires Android U (level 34). However, it is designed with backward compatibility in mind and can potentially be made accessible <34 if any provider decides to support that.

This class should be constructed using the Builder (see below) for tests/prod usage.

Throws
kotlin.NullPointerException

If pendingGetCredentialHandle is null at API level >= 34.

Summary

Nested types

A handle that represents a pending get-credential operation.

A builder for PrepareGetCredentialResponse for test use only.

Public functions

Boolean
@RequiresPermission(value = "android.permission.CREDENTIAL_MANAGER_QUERY_CANDIDATE_CREDENTIALS")
hasAuthenticationResults()

Returns true if the user has any candidate authentication actions (locked credential supplier), and false otherwise.

Boolean
@RequiresPermission(value = "android.permission.CREDENTIAL_MANAGER_QUERY_CANDIDATE_CREDENTIALS")
hasCredentialResults(credentialType: String)

Returns true if the user has any candidate credentials for the given {@code credentialType}, and false otherwise.

Boolean
@RequiresPermission(value = "android.permission.CREDENTIAL_MANAGER_QUERY_CANDIDATE_CREDENTIALS")
hasRemoteResults()

Returns true if the user has any candidate remote credential results, and false otherwise.

Public properties

((String) -> Boolean)?

whether the response has a credential result handler

(() -> Boolean)?

whether the response has auth results

(() -> Boolean)?

whether the response has remote results

Boolean

whether to support null handles for test

PrepareGetCredentialResponse.PendingGetCredentialHandle?

a handle that represents this pending get-credential operation; pass this handle to CredentialManager.getCredential (Kotlin) / CredentialManager.getCredentialAsync (Java) to perform the remaining flows to officially retrieve a credential.

Public functions

hasAuthenticationResults

Added in 1.2.0
@RequiresPermission(value = "android.permission.CREDENTIAL_MANAGER_QUERY_CANDIDATE_CREDENTIALS")
fun hasAuthenticationResults(): Boolean

Returns true if the user has any candidate authentication actions (locked credential supplier), and false otherwise.

Note: this API will always return false at API level < 34.

hasCredentialResults

Added in 1.2.0
@RequiresPermission(value = "android.permission.CREDENTIAL_MANAGER_QUERY_CANDIDATE_CREDENTIALS")
fun hasCredentialResults(credentialType: String): Boolean

Returns true if the user has any candidate credentials for the given {@code credentialType}, and false otherwise.

Note: this API will always return false at API level < 34.

hasRemoteResults

Added in 1.2.0
@RequiresPermission(value = "android.permission.CREDENTIAL_MANAGER_QUERY_CANDIDATE_CREDENTIALS")
fun hasRemoteResults(): Boolean

Returns true if the user has any candidate remote credential results, and false otherwise.

Note: this API will always return false at API level < 34.

Public properties

credentialTypeDelegate

Added in 1.2.0
val credentialTypeDelegate: ((String) -> Boolean)?

whether the response has a credential result handler

hasAuthResultsDelegate

Added in 1.2.0
val hasAuthResultsDelegate: (() -> Boolean)?

whether the response has auth results

hasRemoteResultsDelegate

Added in 1.2.0
val hasRemoteResultsDelegate: (() -> Boolean)?

whether the response has remote results

isNullHandlesForTest

Added in 1.2.0
val isNullHandlesForTestBoolean

whether to support null handles for test

pendingGetCredentialHandle

Added in 1.2.0
val pendingGetCredentialHandlePrepareGetCredentialResponse.PendingGetCredentialHandle?

a handle that represents this pending get-credential operation; pass this handle to CredentialManager.getCredential (Kotlin) / CredentialManager.getCredentialAsync (Java) to perform the remaining flows to officially retrieve a credential.