ContactKeyClient

@RequiresPermission(value = "android.permission.READ_CONTACTS")
abstract @NonNull Flow<@NonNull List<@NonNull E2eeAccountContactKeyParcelable>> getAccountContactKeysFlow(@NonNull List<@NonNull String> accountIds)

Returns a flow of account contact keys updates.

The flow will emit when any key for any accountId provided is updated, added, or removed. It will emit the list of all keys for the provided accountIds, not just the ones that were updated.

@RequiresPermission(value = "android.permission.READ_CONTACTS")
abstract @NonNull Task<@NonNull E2eeContactKeyListParcelable> getAllE2eeContactKeys(@NonNull String lookupKey)

Retrieves all end-to-end encryption contact key entries that belong to apps visible to the caller. The keys will be stripped of deviceId, timeUpdated and keyValue data.

@RequiresPermission(value = "android.permission.READ_CONTACTS")
abstract @NonNull Task<@NonNull E2eeSelfKeyListParcelable> getAllE2eeSelfKeys()

Returns all end-to-end encryption self key entries that belong to apps visible to the caller. The keys will be stripped of deviceId, timeUpdated and keyValue data.

@RequiresPermission(value = "android.permission.READ_CONTACTS")
abstract @NonNull Task<@NonNull ImmutableList<@NonNull E2eeAccountContactKeyParcelable>> getAllOwnerE2eeAccountContactKeys()

Retrieves all end-to-end encryption account contact keys that belong to the caller app, whether they are associated with a contact or not.

@RequiresPermission(value = "android.permission.READ_CONTACTS")
abstract @NonNull Task<@NonNull E2eeContactKeyListParcelable> getAllOwnerE2eeContactKeys()

Retrieves all end-to-end encryption contact keys that belong to the caller app, across all contacts.

This method should be used to only retrieve keys that have at least one contact associated with them. If you need to retrieve keys that are not associated with any contacts, use getAllOwnerE2eeAccountContactKeys instead.

@RequiresPermission(value = "android.permission.READ_CONTACTS")
abstract @NonNull Task<@NonNull ImmutableList<@NonNull E2eeAccountContactKeyParcelable>> getE2eeAccountKeysForAccount(@NonNull String accountId)

Retrieves all end-to-end encryption contact key entries that belong to the caller app and the caller's account, across all contacts. Includes keys not associated with any contact.

@RequiresPermission(value = "android.permission.READ_CONTACTS")
abstract @NonNull Task<E2eeContactKeyParcelable> getE2eeContactKey(
    @NonNull String lookupKey,
    @NonNull String deviceId,
    @NonNull String accountId
)

Retrieves an end-to-end encryption contact key entry given the lookupKey, deviceId, accountId and inferred caller package name.

@RequiresPermission(value = "android.permission.READ_CONTACTS")
abstract @NonNull Task<E2eeSelfKeyParcelable> getE2eeSelfKey(@NonNull String deviceId, @NonNull String accountId)

Returns an end-to-end encryption self key entry given the deviceId, accountId and the inferred package name of the caller.

abstract @NonNull Task<@NonNull Integer> getMaxKeySizeBytes()

Returns the maximum allowed size of a key in bytes.

abstract @NonNull Task<@NonNull PendingIntent> getOnboardingIntent(
    @NonNull OnboardingNextActivity nextActivity,
    String lookupKey,
    String packageName
)

Returns an intent to show the Onboarding activity, and marks that the Onboarding has been shown on this device. This requires a nextActivity, which can be either the string show or scan. If scan, the lookupKey of the contact to scan for is required.

@RequiresPermission(value = "android.permission.READ_CONTACTS")
abstract @NonNull Task<@NonNull E2eeContactKeyListParcelable> getOwnerE2eeContactKeys(@NonNull String lookupKey)

Retrieves all end-to-end encryption contact key entries for a given lookupKey that belong to the caller app.

@RequiresPermission(value = "android.permission.READ_CONTACTS")
abstract @NonNull Task<@NonNull E2eeSelfKeyListParcelable> getOwnerE2eeSelfKeys()

Returns all end-to-end encryption self key entries that are owned by the caller app.

abstract @NonNull Task<@NonNull PendingIntent> getScanQrCodeIntent(@NonNull String lookupKey, boolean skipOnboarding)

Returns an intent to the "Scan QR Code" activity.

abstract @NonNull Task<@NonNull PendingIntent> getScanQrCodeIntentForAccount(
    @NonNull String packageName,
    @NonNull String accountId
)

Returns an intent to the "Scan QR Code" activity for a specific account.

abstract @NonNull Task<@NonNull PendingIntent> getShowQrCodeIntent(String packageName, boolean skipOnboarding)

Returns an intent to the "Show QR Code" activity.

abstract @NonNull Task<@NonNull Boolean> isEnabled()

Returns a Task that completes successfully whether the API is available or not.

If the API is available, the returned task will have a true result, and false otherwise.

Exceptions typically thrown when the API is unavailable will be caught and a task successfully returning false will be returned instead.

@RequiresPermission(value = "android.permission.READ_CONTACTS")
abstract @NonNull Task<@NonNull Void> registerAccountContactKeysListener(
    @NonNull List<@NonNull String> accountIds,
    @NonNull OnAccountContactKeysUpdatedListener listener
)

Registers a listener for account contact keys updates.

The listener will be called when any key for any accountId provided is updated, added, or removed. It will be called with the list of all keys for the provided accountIds, not just the ones that were updated.

@RequiresPermission(value = "android.permission.WRITE_CONTACTS")
abstract @NonNull Task<@NonNull Void> removeE2eeAccountContactKey(
    @NonNull String deviceId,
    @NonNull String accountId
)

Removes an end-to-end encryption account contact key entry that belongs to the caller app.

@RequiresPermission(value = "android.permission.WRITE_CONTACTS")
abstract @NonNull Task<@NonNull Void> removeE2eeContactKey(
    @NonNull String lookupKey,
    @NonNull String deviceId,
    @NonNull String accountId
)

Removes an end-to-end encryption contact key entry that belongs to the caller app.

@RequiresPermission(value = "android.permission.WRITE_CONTACTS")
abstract @NonNull Task<@NonNull Void> removeE2eeSelfKey(@NonNull String deviceId, @NonNull String accountId)

Removes an end-to-end encryption self key entry given the deviceId and the inferred package name of the caller.

@CanIgnoreReturnValue
abstract @NonNull Task<@NonNull Boolean> unregisterAccountContactKeysListener(
    @NonNull OnAccountContactKeysUpdatedListener listener
)

Unregisters a listener for account contact keys updates.

@RequiresPermission(allOf = ["android.permission.READ_CONTACTS", "android.permission.WRITE_CONTACTS"])
abstract @NonNull Task<@NonNull Void> updateAllE2eeAccountKeys(
    @NonNull List<@NonNull E2eeAccountKeyInfo> accountKeyInfos
)

Inserts a batch of account contact keys.

Behaves similarly to updateOrInsertE2eeContactKey, but allows for multiple keys to be inserted/updated at once. Each key is inserted in its own transaction, so some keys may be inserted even if the task throws an exception.

Clients may choose to handle temporary failures by resending the whole batch, as this API will not affect the status of already-inserted keys.

For each key, if a lookupKey is provided but the contact basic info (displayName, phoneNumber, emailAddress)is not, this API will also attempt to retrieve the contact's name, phone number, and email address from the Contacts Provider. When retrieving the key, contact management apps should use this information to make sure that the key is only used for the contact that it was intended for.

The Android Key Verification app stores this information on-device and only exposes it to API callers that hold the READ_CONTACTS permission.

If no lookupKey is provided for a key, this API will store a key that is not tied to any contact.

@RequiresPermission(allOf = ["android.permission.READ_CONTACTS", "android.permission.WRITE_CONTACTS"])
abstract @NonNull Task<@NonNull Void> updateOrInsertE2eeContactKey(
    @NonNull String lookupKey,
    @NonNull String deviceId,
    @NonNull String accountId,
    @NonNull byte[] keyValue
)

Inserts a new entry into the end-to-end encryption contact keys table or updates one if it already exists. The inserted/updated end-to-end encryption contact key is owned by the caller app.

This API will also store the contact's name, phone number, and email address from the Contacts Provider, alongside the key. When retrieving the key, contact management apps should use this information to make sure that the key is only used for the contact that it was intended for.

The Android Key Verification app stores this information on-device and only exposes it to API callers that hold the READ_CONTACTS permission.

@RequiresPermission(allOf = ["android.permission.READ_CONTACTS", "android.permission.WRITE_CONTACTS"])
abstract @NonNull Task<@NonNull Void> updateOrInsertE2eeContactKey(
    @NonNull List<@NonNull String> lookupKeys,
    @NonNull String deviceId,
    @NonNull String accountId,
    @NonNull byte[] keyValue
)

Inserts a new entry into the end-to-end encryption contact keys table or updates one if it already exists. The inserted/updated end-to-end encryption contact key is owned by the caller app.

For each provided lookup key, this API will also store the contact's name, phone number, and email address from the Contacts Provider, alongside the key. When retrieving the key, contact management apps should use this information to make sure that the key is only used for the contact that it was intended for.

The Android Key Verification app stores this information on-device and only exposes it to API callers that hold the READ_CONTACTS permission.

If the list of lookup keys is empty, this API will store a key that is not associated with any contact.

Calling this API with one or more lookup keys will update the key metadata to associate it with the provided contacts, but will not remove any existing associations for contacts that are not provided in the list. To remove an association between a contact and a key, call removeE2eeContactKey with the appropriate lookup key.

@RequiresPermission(value = "android.permission.WRITE_CONTACTS")
abstract @NonNull Task<@NonNull Void> updateOrInsertE2eeSelfKey(
    @NonNull String deviceId,
    @NonNull String accountId,
    @NonNull byte[] keyValue
)

Inserts a new entry into the end-to-end encryption self keys table or updates one if it already exists.