IdentityCredentialClient

Kotlin |Java

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

A client for the Identity Credentials API

Summary

Public functions
`Task<ClearCredentialStateResponse>`	`clearCredentialState(request: ClearCredentialStateRequest)` Returns a `Task` which asynchronously generates a `ClearCredentialStateResponse` on success or throws an `OperationException` on failure, when attempting to clear credential state.
`Task<ClearRegistryResponse>`	`clearRegistry(request: ClearRegistryRequest)` Returns a `Task` which asynchronously generates a `ClearRegistryResponse` on success or throws an `OperationException` on failure, when attempting to clear from the registry.
`Task<CreateCredentialHandle>`	`createCredential(request: CreateCredentialRequest)` Returns a `Task` which asynchronously generates a `CreateCredentialHandle` on success or throws an `OperationException` on failure.
`Task<PendingGetCredentialHandle>`	`getCredential(request: GetCredentialRequest)` Returns a `Task` which asynchronously generates a pending intent to get credentials.
`Task<PendingImportCredentialsHandle>`	`importCredentials(request: ImportCredentialsRequest)` Returns a `Task` which asynchronously generates a pending intent to import credentials.
`Task<RegisterCreationOptionsResponse>`	`registerCreationOptions(request: RegisterCreationOptionsRequest)` Register the creation options that may serve a `IdentityCredentialClient.createCredential` transaction.
`Task<RegistrationResponse>`	`registerCredentials(request: RegistrationRequest)` Register the credential options that may serve a `IdentityCredentialClient.getCredential` transaction.
`Task<RegisterExportResponse>`	`registerExport(request: RegisterExportRequest)` Returns a `Task` which asynchronously generates a `RegisterExportResponse` on success or throws an `OperationException` on failure, when attempting to write to the registry.

Public functions

clearCredentialState

fun clearCredentialState(request: ClearCredentialStateRequest): Task<ClearCredentialStateResponse>

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
`request: ClearCredentialStateRequest`	specifies the clear credential state request

clearRegistry

fun clearRegistry(request: ClearRegistryRequest): Task<ClearRegistryResponse>

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
`request: ClearRegistryRequest`	informs the type of operation

createCredential

fun createCredential(request: CreateCredentialRequest): Task<CreateCredentialHandle>

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

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

getCredential

fun getCredential(request: GetCredentialRequest): Task<PendingGetCredentialHandle>

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

Parameters
`request: GetCredentialRequest`	the request for getting the credential

importCredentials

fun importCredentials(request: ImportCredentialsRequest): Task<PendingImportCredentialsHandle>

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

Parameters
`request: ImportCredentialsRequest`	the information needed to import credentials from another provider

registerCreationOptions

fun registerCreationOptions(request: RegisterCreationOptionsRequest): Task<RegisterCreationOptionsResponse>

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
`request: RegisterCreationOptionsRequest`	specifies the credential information being written to the registry

registerCredentials

fun registerCredentials(request: RegistrationRequest): Task<RegistrationResponse>

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
`request: RegistrationRequest`	specifies the credential information being written to the registry

registerExport

fun registerExport(request: RegisterExportRequest): Task<RegisterExportResponse>

Returns a Task which asynchronously generates a RegisterExportResponse 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, RegisterExportResponse 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
`request: RegisterExportRequest`	specifies the information being written to the registry