CredentialDataRequest

Kotlin |Java

open class CredentialDataRequest

kotlin.Any
↳	android.security.identity.CredentialDataRequest

An object representing a request for credential data.

Summary

Nested classes
	`Builder` A builder for `CredentialDataRequest`.

Public methods
open MutableMap<String!, MutableCollection<String!>!>	`getDeviceSignedEntriesToRequest()` Gets the device-signed entries to request.
open MutableMap<String!, MutableCollection<String!>!>	`getIssuerSignedEntriesToRequest()` Gets the issuer-signed entries to request.
open ByteArray?	`getReaderSignature()` Gets the reader signature.
open ByteArray?	`getRequestMessage()` Gets the request message CBOR.
open Boolean	`isAllowUsingExhaustedKeys()` Gets whether to allow using an authentication key which use count has been exceeded.
open Boolean	`isAllowUsingExpiredKeys()` Gets whether to allow using an authentication key which is expired.
open Boolean	`isIncrementUseCount()` Gets whether to increment the use-count for the authentication key used.

open fun getDeviceSignedEntriesToRequest(): MutableMap<String!, MutableCollection<String!>!>

Gets the device-signed entries to request.

Return
`MutableMap<String!, MutableCollection<String!>!>`	the device-signed entries to request. This value cannot be `null`.

open fun getIssuerSignedEntriesToRequest(): MutableMap<String!, MutableCollection<String!>!>

Gets the issuer-signed entries to request.

Return
`MutableMap<String!, MutableCollection<String!>!>`	the issuer-signed entries to request. This value cannot be `null`.

open fun getReaderSignature(): ByteArray?

Gets the reader signature.

This data structure is described in the documentation for the PresentationSession#getCredentialData(String, CredentialDataRequest) method.

Return
`ByteArray?`	a `COSE_Sign1` structure as described above. This value may be `null`.

open fun getRequestMessage(): ByteArray?

Gets the request message CBOR.

This data structure is described in the documentation for the PresentationSession#getCredentialData(String, CredentialDataRequest) method.

Return
`ByteArray?`	the request message CBOR as described above. This value may be `null`.

open fun isAllowUsingExhaustedKeys(): Boolean

Gets whether to allow using an authentication key which use count has been exceeded.

By default this is set to true.

Return
`Boolean`	whether to allow using an authentication key which use count has been exceeded if no other key is available.

open fun isAllowUsingExpiredKeys(): Boolean

Gets whether to allow using an authentication key which is expired.

By default this is set to false.

Return
`Boolean`	whether to allow using an authentication key which is expired if no other key is available.

open fun isIncrementUseCount(): Boolean

Gets whether to increment the use-count for the authentication key used.

By default this is set to true.

Return
`Boolean`	whether to increment the use count of the authentication key used.