IdentityCredentialClient

Kotlin |Java

@DoNotMock(value = "Use canonical fakes instead.")
public interface IdentityCredentialClient

A client for the Identity Credentials API

Summary

Public methods
`abstract @NonNull Task<@NonNull ClearRegistryResponse>`	`clearRegistry(@NonNull ClearRegistryRequest request)` Returns a `Task` which asynchronously generates a `ClearRegistryResponse` on success or throws an `OperationException` on failure, when attempting to clear from the registry.
`abstract @NonNull Task<@NonNull PendingGetCredentialHandle>`	`getCredential(@NonNull GetCredentialRequest request)` Returns a `Task` which asynchronously generates a pending intent to get credentials.
`abstract @NonNull Task<@NonNull RegistrationResponse>`	`registerCredentials(@NonNull RegistrationRequest request)` Returns a `Task` which asynchronously generates a `RegistrationResponse` on success or throws an `OperationException` on failure, when attempting to write to the registry.

Public methods

clearRegistry

abstract @NonNull Task<@NonNull ClearRegistryResponse> clearRegistry(@NonNull ClearRegistryRequest request)

Returns a Task which asynchronously generates a ClearRegistryResponse on success or throws an OperationException on failure, when attempting to clear from the registry. If successful, the status of the Task should be Status.RESULT_SUCCESS. If the operation is not permitted, RegistrationResponse will be null, and the status will match (e.g. if the API is not meant to be called, Status.RESULT_API_NOT_CONNECTED should be emitted).

Parameters
`@NonNull ClearRegistryRequest request`	informs the type of operation

getCredential

abstract @NonNull Task<@NonNull PendingGetCredentialHandle> getCredential(@NonNull GetCredentialRequest request)

Returns a Task which asynchronously generates a pending intent to get credentials.

Parameters
`@NonNull GetCredentialRequest request`	the request for getting the credential

registerCredentials

abstract @NonNull Task<@NonNull RegistrationResponse> registerCredentials(@NonNull RegistrationRequest request)

Returns a Task which asynchronously generates a RegistrationResponse on success or throws an OperationException on failure, when attempting to write to the registry. If successful, the status of the Task should be Status.RESULT_SUCCESS. If the operation is not permitted, RegistrationResponse will be null, and the status will match (e.g. if the API is not meant to be called, Status.RESULT_API_NOT_CONNECTED should be emitted).

Parameters
`@NonNull RegistrationRequest request`	specifies the credential information being written to the registry