ContactKeyClient

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

アカウントの連絡先キーの更新フローを返します。

指定された accountId のキーが更新、追加、削除されると、フローが発行されます。更新されたキーだけでなく、指定された accountId のすべてのキーのリストが出力されます。

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

呼び出し元に表示されるアプリに属するすべてのエンドツーエンド暗号化連絡先キー エントリを取得します。キーから deviceId、timeUpdated、keyValue のデータが削除されます。

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

呼び出し元に表示されるアプリに属するすべてのエンドツーエンド暗号化セルフキー エントリを返します。キーから deviceId、timeUpdated、keyValue のデータが削除されます。

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

発信者アプリに属するすべてのエンドツーエンド暗号化アカウントの連絡先キーを取得します。連絡先に関連付けられているかどうかは問いません。

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

すべての連絡先について、呼び出し元アプリに属するすべてのエンドツーエンド暗号化連絡先キーを取得します。

このメソッドは、少なくとも 1 つの連絡先が関連付けられているキーのみを取得するために使用する必要があります。連絡先に関連付けられていないキーを取得する必要がある場合は、代わりに getAllOwnerE2eeAccountContactKeys を使用します。

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

すべての連絡先で、呼び出し元アプリと呼び出し元のアカウントに属するすべてのエンドツーエンド暗号化連絡先キー エントリを取得します。連絡先に関連付けられていないキーも含まれます。

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

lookupKey、deviceId、accountId、および推測された発信者パッケージ名が指定されたエンドツーエンド暗号化連絡先キー エントリを取得します。

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

deviceId、accountId、呼び出し元の推測されたパッケージ名が指定されたエンドツーエンド暗号化の自己鍵エントリを返します。

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

キーの最大許容サイズをバイト単位で返します。

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

オンボーディング アクティビティを表示するインテントを返し、このデバイスでオンボーディングが表示されたことをマークします。これには nextActivity が必要です。これは、文字列 show または scan のいずれかになります。scan の場合、スキャンする連絡先の lookupKey が必要です。

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

呼び出し元アプリに属する特定の lookupKey のすべてのエンドツーエンド暗号化連絡先キー エントリを取得します。

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

呼び出し元アプリが所有するすべてのエンドツーエンド暗号化セルフキー エントリを返します。

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

[QR コードをスキャン] アクティビティへのインテントを返します。

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

特定のアカウントの [QR コードをスキャン] アクティビティのインテントを返します。

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

[QR コードを表示] アクティビティへのインテントを返します。

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

API が利用可能かどうかに関係なく、正常に完了する Task を返します。

API が利用可能な場合、返されるタスクの結果は true になり、それ以外の場合は false になります。

通常、API が使用できない場合にスローされる例外がキャッチされ、代わりに false を正常に返すタスクが返されます。

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

アカウントの連絡先キーの更新のリスナーを登録します。

指定された accountId のキーが更新、追加、削除されると、リスナーが呼び出されます。更新されたキーだけでなく、指定された accountIds のすべてのキーのリストを使用して呼び出されます。

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

呼び出し元アプリに属するエンドツーエンドの暗号化アカウントの連絡先キー エントリを削除します。

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

呼び出し元アプリに属するエンドツーエンド暗号化の連絡先キー エントリを削除します。

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

deviceId と呼び出し元の推測されたパッケージ名に基づいて、エンドツーエンド暗号化のセルフキー エントリを削除します。

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

アカウントの連絡先キーの更新のリスナーの登録を解除します。

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

アカウント連絡先キーのバッチを挿入します。

updateOrInsertE2eeContactKey と同様の動作をしますが、複数のキーを一度に挿入/更新できます。各キーは独自のトランザクションで挿入されるため、タスクが例外をスローしても、一部のキーが挿入されることがあります。

この API はすでに挿入されたキーのステータスに影響しないため、クライアントはバッチ全体を再送信して一時的な障害を処理できます。

各キーについて、lookupKey が提供されているが、連絡先の基本情報（displayName、phoneNumber、emailAddress）が提供されていない場合、この API は連絡先の名前、電話番号、メールアドレスを連絡先プロバイダから取得しようとします。鍵を取得する際、連絡先管理アプリはこの情報を使用して、鍵が意図した連絡先でのみ使用されるようにする必要があります。

Android キー検証アプリはこの情報をデバイスに保存し、READ_CONTACTS 権限を持つ API 呼び出し元にのみ公開します。

キーに lookupKey が指定されていない場合、この API は連絡先に関連付けられていないキーを保存します。

@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
)

エンドツーエンド暗号化の連絡先キーテーブルに新しいエントリを挿入するか、既存のエントリを更新します。挿入または更新されたエンドツーエンド暗号化連絡先キーは、呼び出し元のアプリが所有しています。

この API は、キーとともに、連絡先の名前、電話番号、メールアドレスを連絡先プロバイダから保存します。鍵を取得する際、連絡先管理アプリはこの情報を使用して、鍵が意図した連絡先でのみ使用されるようにする必要があります。

Android キー検証アプリはこの情報をデバイスに保存し、READ_CONTACTS 権限を持つ API 呼び出し元にのみ公開します。

@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
)

エンドツーエンド暗号化の連絡先キーテーブルに新しいエントリを挿入するか、既存のエントリを更新します。挿入または更新されたエンドツーエンド暗号化連絡先キーは、呼び出し元のアプリが所有しています。

この API は、提供された各ルックアップ キーについて、キーとともに連絡先プロバイダから連絡先の名前、電話番号、メールアドレスも保存します。鍵を取得する際、連絡先管理アプリはこの情報を使用して、鍵が意図した連絡先でのみ使用されるようにする必要があります。

Android キー検証アプリはこの情報をデバイスに保存し、READ_CONTACTS 権限を持つ API 呼び出し元にのみ公開します。

ルックアップ キーのリストが空の場合、この API は連絡先に関連付けられていないキーを保存します。

1 つ以上のルックアップ キーを使用してこの API を呼び出すと、キーのメタデータが更新され、指定された連絡先に関連付けられます。ただし、リストに指定されていない連絡先の既存の関連付けは削除されません。連絡先とキーの関連付けを削除するには、適切なルックアップ キーを指定して removeE2eeContactKey を呼び出します。

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

エンドツーエンド暗号化のセルフキー テーブルに新しいエントリを挿入するか、すでに存在する場合はエントリを更新します。