ContactKeyClient

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

傳回帳戶聯絡人金鑰更新的流程。

當任何帳戶 ID 的任何金鑰更新、新增或移除時，系統就會發出流程。系統會發出所提供 accountId 的所有金鑰清單，而不只是更新的金鑰。

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

擷取屬於呼叫者可見應用程式的所有端對端加密聯絡人金鑰項目。金鑰會移除 deviceId、timeUpdated 和 keyValue 資料。

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

傳回呼叫者可見應用程式的所有端對端加密自我金鑰項目。金鑰會移除 deviceId、timeUpdated 和 keyValue 資料。

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

擷取屬於來電者應用程式的所有端對端加密帳戶聯絡人金鑰，無論是否與聯絡人相關聯。

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

擷取所有聯絡人的所有端對端加密聯絡人金鑰，這些金鑰屬於呼叫端應用程式。

這個方法只會用於擷取至少有一個相關聯聯絡人的金鑰。如要擷取未與任何聯絡人建立關聯的金鑰，請改用 getAllOwnerE2eeAccountContactKeys。

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

擷取所有聯絡人中，屬於呼叫端應用程式和呼叫端帳戶的端對端加密聯絡人金鑰項目。包括未與任何聯絡人建立關聯的金鑰。

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

根據 lookupKey、deviceId、accountId 和推斷的呼叫端套件名稱，擷取端對端加密聯絡人金鑰項目。

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

根據 deviceId、accountId 和呼叫端的推斷套件名稱，傳回端對端加密自我金鑰項目。

fun getMaxKeySizeBytes(): Task<Int>

傳回鍵的大小上限 (以位元組為單位)。

fun getOnboardingIntent(
    nextActivity: OnboardingNextActivity,
    lookupKey: String?,
    packageName: String?
): Task<PendingIntent>

傳回顯示新手上路活動的 Intent，並標示新手上路畫面已顯示在這部裝置上。這需要 nextActivity，可以是字串 show 或 scan。如果 scan，則必須提供要掃描的聯絡人 lookupKey。

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

擷取屬於呼叫端應用程式的指定 lookupKey 所有端對端加密聯絡人金鑰項目。

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

傳回呼叫端應用程式擁有的所有端對端加密自我金鑰項目。

fun getScanQrCodeIntent(lookupKey: String, skipOnboarding: Boolean = false): Task<PendingIntent>

傳回「掃描 QR code」活動的意圖。

fun getScanQrCodeIntentForAccount(packageName: String, accountId: String): Task<PendingIntent>

傳回特定帳戶「掃描 QR code」活動的意圖。

fun getShowQrCodeIntent(packageName: String?, skipOnboarding: Boolean = false): Task<PendingIntent>

傳回「顯示 QR code」活動的 Intent。

fun isEnabled(): Task<Boolean>

無論 API 是否可用，都會傳回成功完成的 Task。

如果 API 可用，傳回的工作結果會是 true，否則為 false。

系統會擷取 API 無法使用時通常會擲回的例外狀況，並改為傳回成功傳回 false 的工作。

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

註冊帳戶聯絡人金鑰更新的監聽器。

只要提供的任何 accountId 的任何金鑰更新、新增或移除，系統就會呼叫監聽器。系統會使用所提供 accountId 的所有金鑰清單呼叫這個函式，而不只是更新的金鑰。

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

移除屬於來電者應用程式的端對端加密帳戶聯絡人金鑰項目。

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

移除屬於來電應用程式的端對端加密通訊錄金鑰項目。

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

根據 deviceId 和呼叫端的推斷套件名稱，移除端對端加密自我金鑰項目。

@CanIgnoreReturnValue
fun unregisterAccountContactKeysListener(
    listener: OnAccountContactKeysUpdatedListener
): Task<Boolean>

取消註冊帳戶聯絡人金鑰更新的接聽程式。

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

插入一批帳戶聯絡人金鑰。

行為與 updateOrInsertE2eeContactKey 類似，但可一次插入/更新多個鍵。每個鍵都會插入自己的交易，因此即使工作擲回例外狀況，部分鍵仍可能會插入。

用戶端可以選擇重新傳送整個批次，處理暫時性失敗，因為這個 API 不會影響已插入金鑰的狀態。

如果為每個鍵提供 lookupKey，但未提供聯絡人基本資訊 (displayName、phoneNumber、emailAddress)，這個 API 也會嘗試從聯絡人供應商擷取聯絡人的姓名、電話號碼和電子郵件地址。擷取金鑰時，聯絡人管理應用程式應使用這項資訊，確保金鑰只用於預期聯絡人。

Android 金鑰驗證應用程式會將這項資訊儲存在裝置上，且只會向擁有 READ_CONTACTS 權限的 API 呼叫端公開。

如果未提供金鑰的 lookupKey，這個 API 會儲存未繫結至任何聯絡人的金鑰。

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

在端對端加密聯絡人金鑰資料表中插入新項目，或更新現有項目。插入/更新的端對端加密聯絡人金鑰屬於呼叫端應用程式。

這個 API 也會連同金鑰，一併儲存聯絡人提供者的聯絡人姓名、電話號碼和電子郵件地址。擷取金鑰時，聯絡人管理應用程式應使用這項資訊，確保金鑰只用於預期聯絡人。

Android 金鑰驗證應用程式會將這項資訊儲存在裝置上，且只會向擁有 READ_CONTACTS 權限的 API 呼叫端公開。

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

在端對端加密聯絡人金鑰資料表中插入新項目，或更新現有項目。插入/更新的端對端加密聯絡人金鑰屬於呼叫端應用程式。

對於提供的每個查閱鍵，這個 API 也會連同鍵，一併儲存聯絡人提供者的聯絡人姓名、電話號碼和電子郵件地址。擷取金鑰時，聯絡人管理應用程式應使用這項資訊，確保金鑰只用於預期聯絡人。

Android 金鑰驗證應用程式會將這項資訊儲存在裝置上，且只會向擁有 READ_CONTACTS 權限的 API 呼叫端公開。

如果查閱鍵清單為空白，這個 API 會儲存未與任何聯絡人建立關聯的金鑰。

使用一或多個查閱鍵呼叫這個 API 時，系統會更新鍵中繼資料，將其與提供的聯絡人建立關聯，但不會移除未在清單中提供的聯絡人現有任何關聯。如要移除聯絡人和金鑰之間的關聯，請使用適當的查閱鍵呼叫 removeE2eeContactKey。

@RequiresPermission(value = "android.permission.WRITE_CONTACTS")
fun updateOrInsertE2eeSelfKey(
    deviceId: String,
    accountId: String,
    keyValue: ByteArray
): Task<Void>

在端對端加密自訂金鑰資料表中插入新項目，或更新現有項目。