ProviderEventsManager

default static final @NonNull ProviderEventsManager create(@NonNull Context context)

Creates a ProviderEventsManager based on the given context.

default @NonNull ProviderImportCredentialsResponse importCredentials(
    @NonNull Context context,
    @NonNull ImportCredentialsRequest request
)

Initiates a flow to import credentials from another credential provider.

This method launches a provider selector UI, allowing the user to choose a source provider from a list of those registered via registerExport. The request is then forwarded to the selected provider.

Under the hood, this API facilitates the transfer by creating a temporary file in the caller's cache directory. The framework handles the file I/O, permissions, and cleanup, providing a seamless transfer medium between the two providers.

abstract void importCredentialsAsync(
    @NonNull Context context,
    @NonNull ImportCredentialsRequest request,
    CancellationSignal cancellationSignal,
    @NonNull Executor executor,
    @NonNull CredentialManagerCallback<@NonNull ProviderImportCredentialsResponse, @NonNull ImportCredentialsException> callback
)

Initiates a flow to import credentials from another credential provider.

This method launches a provider selector UI, allowing the user to choose a source provider from a list of those registered via registerExport. The request is then forwarded to the selected provider.

Under the hood, this API facilitates the transfer by creating a temporary file in the caller's cache directory. The framework handles the file I/O, permissions, and cleanup, providing a seamless transfer medium between the two providers.

default @NonNull RegisterExportResponse registerExport(@NonNull RegisterExportRequest request)

Registers the calling credential provider as a source for exporting credentials.

Once registered, the provider's ExportEntry will be displayed in the provider selector UI when another provider initiates an importCredentials flow.

In addition to calling this method, a provider that wishes to export credentials must declare an [Activity] in its manifest that can handle the transfer request. This activity must have an intent filter configured with the following:

• An intent action of "androidx.identitycredentials.action.IMPORT_CREDENTIALS"
• A data element with a "content" scheme

The framework will invoke this activity with an intent containing a content URI, which serves as the medium for transferring the credential data. The activity can retrieve the request from the intent by calling IntentHandler.retrieveProviderImportCredentialsRequest. In addition to the ImportCredentialsRequest, the ProviderImportCredentialsRequest contains a few security measures. The importer's CallingAppInfo is provided to verify the importer. The 'credId' is provided to validate the selected ExportEntry.

After the activity processes the request, the activity should return the ImportCredentialsResponse through the 'uri' of ProviderImportCredentialsRequest to successfully return the credentials or set an exception by calling IntentHandler.setImportCredentialsException.

abstract void registerExportAsync(
    @NonNull RegisterExportRequest request,
    CancellationSignal cancellationSignal,
    @NonNull Executor executor,
    @NonNull CredentialManagerCallback<@NonNull RegisterExportResponse, @NonNull RegisterExportException> callback
)

Registers the calling credential provider as a source for exporting credentials.

Once registered, the provider's ExportEntry will be displayed in the provider selector UI when another provider initiates an importCredentials flow.

In addition to calling this method, a provider that wishes to export credentials must declare an [Activity] in its manifest that can handle the transfer request. This activity must have an intent filter configured with the following:

• An intent action of "androidx.identitycredentials.action.IMPORT_CREDENTIALS"
• A data element with a "content" scheme

The framework will invoke this activity with an intent containing a content URI, which serves as the medium for transferring the credential data. The activity can retrieve the request from the intent by calling IntentHandler.retrieveProviderImportCredentialsRequest. In addition to the ImportCredentialsRequest, the ProviderImportCredentialsRequest contains a few security measures. The importer's CallingAppInfo is provided to verify the importer. The 'credId' is provided to validate the selected ExportEntry.

After the activity processes the request, the activity should return the ImportCredentialsResponse through the 'uri' of ProviderImportCredentialsRequest to successfully return the credentials or set an exception by calling IntentHandler.setImportCredentialsException.