interface ProviderEventsApiProvider


Provider interface to be implemented by the OEMs that will support provider events APIs.

Summary

Public functions

Boolean

Returns true if the provider is available on this device, or otherwise false.

Unit

Invoked on a request to clear all accounts registered for exporting credentials.

Unit
onImportCredentials(
    context: Context,
    request: ImportCredentialsRequest,
    cancellationSignal: CancellationSignal?,
    executor: Executor,
    callback: CredentialManagerCallback<ProviderImportCredentialsResponseImportCredentialsException>
)

Invoked on a request to import credentials.

Unit

Invoked on a request to register accounts capable for exporting credentials.

Public functions

isAvailable

Added in 1.0.0-alpha04
fun isAvailable(): Boolean

Returns true if the provider is available on this device, or otherwise false.

onClearExport

Added in 1.0.0-alpha04
fun onClearExport(
    request: ClearExportRequest,
    executor: Executor,
    callback: CredentialManagerCallback<ClearExportResponseClearExportException>
): Unit

Invoked on a request to clear all accounts registered for exporting credentials.

Parameters
request: ClearExportRequest

the request for clearing all export entries

executor: Executor

the callback will take place on this executor

callback: CredentialManagerCallback<ClearExportResponseClearExportException>

the callback invoked when the request succeeds or fails

onImportCredentials

Added in 1.0.0-alpha04
fun onImportCredentials(
    context: Context,
    request: ImportCredentialsRequest,
    cancellationSignal: CancellationSignal?,
    executor: Executor,
    callback: CredentialManagerCallback<ProviderImportCredentialsResponseImportCredentialsException>
): Unit

Invoked on a request to import credentials.

Parameters
context: Context

the client calling context used to potentially launch any UI

request: ImportCredentialsRequest

the request for importing the credentials

cancellationSignal: CancellationSignal?

an optional signal that allows for cancelling this call

executor: Executor

the callback will take place on this executor

callback: CredentialManagerCallback<ProviderImportCredentialsResponseImportCredentialsException>

the callback invoked when the request succeeds or fails

onRegisterExport

Added in 1.0.0-alpha04
fun onRegisterExport(
    request: RegisterExportRequest,
    executor: Executor,
    callback: CredentialManagerCallback<RegisterExportResponseRegisterExportException>
): Unit

Invoked on a request to register accounts capable for exporting credentials.

Parameters
request: RegisterExportRequest

the request for registering export entries

executor: Executor

the callback will take place on this executor

callback: CredentialManagerCallback<RegisterExportResponseRegisterExportException>

the callback invoked when the request succeeds or fails