Added in API level 33

Entries

interface Entries
android.security.identity.CredentialDataResult.Entries

A class for representing data elements returned.

Summary

Constants
static Int

The entry wasn't in the request message.
static Int

The entry was not requested.
static Int

The entry was not retrieved because it was configured without any access control profile.
static Int

The entry does not exist.
static Int

Value was successfully retrieved.
static Int

The entry was not retrieved because reader authentication failed.
static Int

The entry was not retrieved because user authentication failed.
Public methods
abstract ByteArray?
getEntry(namespaceName: String, name: String)

Gets the raw CBOR data for the value of an entry.
abstract MutableCollection<String!>
getEntryNames(namespaceName: String)

Get the names of all requested entries in a name space.
abstract MutableCollection<String!>

Gets the names of namespaces with retrieved entries.
abstract MutableCollection<String!>

Get the names of all entries that was successfully retrieved from a name space.
abstract Int
getStatus(namespaceName: String, name: String)

Gets the status of an entry.

Constants

STATUS_NOT_IN_REQUEST_MESSAGE

Added in API level 33
static val STATUS_NOT_IN_REQUEST_MESSAGE: Int

The entry wasn't in the request message.

Value: 3

STATUS_NOT_REQUESTED

Added in API level 33
static val STATUS_NOT_REQUESTED: Int

The entry was not requested.

Value: 2

STATUS_NO_ACCESS_CONTROL_PROFILES

Added in API level 33
static val STATUS_NO_ACCESS_CONTROL_PROFILES: Int

The entry was not retrieved because it was configured without any access control profile.

Value: 6

STATUS_NO_SUCH_ENTRY

Added in API level 33
static val STATUS_NO_SUCH_ENTRY: Int

The entry does not exist.

Value: 1

STATUS_OK

Added in API level 33
static val STATUS_OK: Int

Value was successfully retrieved.

Value: 0

STATUS_READER_AUTHENTICATION_FAILED

Added in API level 33
static val STATUS_READER_AUTHENTICATION_FAILED: Int

The entry was not retrieved because reader authentication failed.

Value: 5

STATUS_USER_AUTHENTICATION_FAILED

Added in API level 33
static val STATUS_USER_AUTHENTICATION_FAILED: Int

The entry was not retrieved because user authentication failed.

Value: 4

Public methods

getEntry

Added in API level 33
abstract fun getEntry(
    namespaceName: String, 
    name: String
): ByteArray?

Gets the raw CBOR data for the value of an entry.

This should only be called on an entry for which the getStatus(java.lang.String,java.lang.String) method returns STATUS_OK.

Parameters
namespaceName String: the namespace name of the entry. This value cannot be null.
name String: the name of the entry to get the value for. This value cannot be null.
Return
ByteArray? the raw CBOR data or null if no entry with the given name exists.

getEntryNames

Added in API level 33
abstract fun getEntryNames(namespaceName: String): MutableCollection<String!>

Get the names of all requested entries in a name space.

This includes the name of entries that wasn't successfully retrieved.

Parameters
namespaceName String: the namespace name to get entries for. This value cannot be null.
Return
MutableCollection<String!> A collection of names for the given namespace or the empty collection if no entries was returned for the given name space. This value cannot be null.

getNamespaces

Added in API level 33
abstract fun getNamespaces(): MutableCollection<String!>

Gets the names of namespaces with retrieved entries.

Return
MutableCollection<String!> collection of name of namespaces containing retrieved entries. May be empty if no data was retrieved. This value cannot be null.

getRetrievedEntryNames

Added in API level 33
abstract fun getRetrievedEntryNames(namespaceName: String): MutableCollection<String!>

Get the names of all entries that was successfully retrieved from a name space.

This only return entries for which getStatus(java.lang.String,java.lang.String) will return STATUS_OK.

Parameters
namespaceName String: the namespace name to get entries for. This value cannot be null.
Return
MutableCollection<String!> The entries in the given namespace that were successfully rerieved or the empty collection if no entries was returned for the given name space. This value cannot be null.

getStatus

Added in API level 33
abstract fun getStatus(
    namespaceName: String, 
    name: String
): Int

Gets the status of an entry.

This returns STATUS_OK if the value was retrieved, STATUS_NO_SUCH_ENTRY if the given entry wasn't retrieved, STATUS_NOT_REQUESTED if it wasn't requested, STATUS_NOT_IN_REQUEST_MESSAGE if the request message was set but the entry wasn't present in the request message, STATUS_USER_AUTHENTICATION_FAILED if the value wasn't retrieved because the necessary user authentication wasn't performed, STATUS_READER_AUTHENTICATION_FAILED if the supplied reader certificate chain didn't match the set of certificates the entry was provisioned with, or STATUS_NO_ACCESS_CONTROL_PROFILES if the entry was configured without any access control profiles.

Parameters
namespaceName String: the namespace name of the entry. This value cannot be null.
name String: the name of the entry to get the value for. This value cannot be null.
Return
Int the status indicating whether the value was retrieved and if not, why. Value is android.security.identity.CredentialDataResult.Entries#STATUS_OK, android.security.identity.CredentialDataResult.Entries#STATUS_NO_SUCH_ENTRY, android.security.identity.CredentialDataResult.Entries#STATUS_NOT_REQUESTED, android.security.identity.CredentialDataResult.Entries#STATUS_NOT_IN_REQUEST_MESSAGE, android.security.identity.CredentialDataResult.Entries#STATUS_USER_AUTHENTICATION_FAILED, android.security.identity.CredentialDataResult.Entries#STATUS_READER_AUTHENTICATION_FAILED, or android.security.identity.CredentialDataResult.Entries#STATUS_NO_ACCESS_CONTROL_PROFILES