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 ClearCredentialStateResponse>`	`clearCredentialState(@NonNull ClearCredentialStateRequest request)` Returns a `Task` which asynchronously generates a `ClearCredentialStateResponse` on success or throws an `OperationException` on failure, when attempting to clear credential state.
`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 CreateCredentialHandle>`	`createCredential(@NonNull CreateCredentialRequest request)` Returns a `Task` which asynchronously generates a `CreateCredentialHandle` on success or throws an `OperationException` on failure.
`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 RegisterCreationOptionsResponse>`	`registerCreationOptions(@NonNull RegisterCreationOptionsRequest request)` Register the creation options that may serve a `IdentityCredentialClient.createCredential` transaction.
`abstract @NonNull Task<@NonNull RegistrationResponse>`	`registerCredentials(@NonNull RegistrationRequest request)` Register the credential options that may serve a `IdentityCredentialClient.getCredential` transaction.

Public methods

clearCredentialState

abstract @NonNull Task<@NonNull ClearCredentialStateResponse> clearCredentialState(@NonNull ClearCredentialStateRequest request)

Returns a Task which asynchronously generates a ClearCredentialStateResponse on success or throws an OperationException on failure, when attempting to clear credential state. If successful, the status of the Task should be Status.RESULT_SUCCESS. If the operation is not permitted, ClearCredentialStateResponse 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 ClearCredentialStateRequest request`	specifies the clear credential state request

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

createCredential

abstract @NonNull Task<@NonNull CreateCredentialHandle> createCredential(@NonNull CreateCredentialRequest request)

Returns a Task which asynchronously generates a CreateCredentialHandle on success or throws an OperationException on failure.

Parameters
`@NonNull CreateCredentialRequest request`	containing parameters of the credential to be created

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

registerCreationOptions

abstract @NonNull Task<@NonNull RegisterCreationOptionsResponse> registerCreationOptions(@NonNull RegisterCreationOptionsRequest request)

Returns a Task which asynchronously generates a RegistrationCreationOptionsResponse 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 RegisterCreationOptionsRequest request`	specifies the credential information being written to the registry

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