ContactKeyClient

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

Trả về một luồng thông tin cập nhật về khoá liên hệ của tài khoản.

Luồng này sẽ phát khi có khoá cho bất kỳ accountId nào được cung cấp được cập nhật, thêm hoặc xoá. Thao tác này sẽ phát ra danh sách tất cả các khoá cho accountIds đã cung cấp, chứ không chỉ những khoá đã được cập nhật.

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

Truy xuất tất cả các mục khoá liên hệ mã hoá hai đầu thuộc về những ứng dụng mà người gọi có thể thấy. Các khoá sẽ bị xoá dữ liệu deviceId, timeUpdated và keyValue.

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

Trả về tất cả các mục khoá tự mã hoá hai đầu thuộc về những ứng dụng mà người gọi nhìn thấy. Các khoá sẽ bị xoá dữ liệu deviceId, timeUpdated và keyValue.

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

Truy xuất tất cả các khoá liên hệ tài khoản mã hoá hai đầu thuộc ứng dụng gọi, cho dù các khoá đó có được liên kết với một người liên hệ hay không.

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

Truy xuất tất cả các khoá liên hệ mã hoá hai đầu thuộc về ứng dụng gọi, trên tất cả các liên hệ.

Bạn chỉ nên dùng phương thức này để truy xuất những khoá có ít nhất một người liên hệ được liên kết. Nếu bạn cần truy xuất các khoá không liên kết với bất kỳ người liên hệ nào, hãy sử dụng getAllOwnerE2eeAccountContactKeys.

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

Truy xuất tất cả các mục khoá liên hệ mã hoá hai đầu thuộc về ứng dụng gọi và tài khoản của người gọi, trên tất cả các số liên hệ. Bao gồm cả những khoá không liên kết với bất kỳ người liên hệ nào.

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

Truy xuất một mục khoá liên hệ mã hoá hai đầu cho trước lookupKey, deviceId, accountId và tên gói người gọi được suy luận.

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

Trả về một mục khoá tự mã hoá hai đầu cho trước deviceId, accountId và tên gói suy luận của phương thức gọi.

fun getMaxKeySizeBytes(): Task<Int>

Trả về kích thước tối đa cho phép của một khoá theo byte.

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

Trả về một ý định để hiện hoạt động làm quen với ứng dụng và đánh dấu rằng hoạt động làm quen với ứng dụng đã xuất hiện trên thiết bị này. Điều này yêu cầu phải có nextActivity, có thể là chuỗi show hoặc scan. Nếu scan, thì bạn phải cung cấp lookupKey của người liên hệ cần quét.

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

Truy xuất tất cả các mục khoá liên hệ mã hoá hai đầu cho một lookupKey nhất định thuộc về ứng dụng gọi.

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

Trả về tất cả các mục khoá tự mã hoá hai đầu thuộc sở hữu của ứng dụng gọi.

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

Trả về một ý định cho hoạt động "Quét mã QR".

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

Trả về một ý định cho hoạt động "Quét mã QR" đối với một tài khoản cụ thể.

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

Trả về một ý định cho hoạt động "Hiện mã QR".

fun isEnabled(): Task<Boolean>

Trả về một Task hoàn tất thành công cho dù API có sẵn hay không.

Nếu API có sẵn, tác vụ được trả về sẽ có kết quả là true, nếu không thì kết quả sẽ là false.

Các ngoại lệ thường được gửi khi API không hoạt động sẽ được nắm bắt và thay vào đó, một tác vụ trả về giá trị false thành công sẽ được trả về.

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

Đăng ký một trình nghe để nhận thông tin cập nhật về khoá liên hệ của tài khoản.

Trình nghe sẽ được gọi khi có khoá cho bất kỳ accountId nào được cung cấp được cập nhật, thêm hoặc xoá. Hàm này sẽ được gọi bằng danh sách tất cả các khoá cho accountId được cung cấp, chứ không chỉ những khoá đã được cập nhật.

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

Xoá một mục khoá liên hệ tài khoản mã hoá hai đầu thuộc ứng dụng gọi.

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

Xoá một mục khoá liên hệ mã hoá hai đầu thuộc ứng dụng gọi.

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

Xoá một mục khoá tự mã hoá hai đầu, cho trước deviceId và tên gói được suy luận của phương thức gọi.

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

Huỷ đăng ký một trình nghe để nhận thông tin cập nhật về khoá liên hệ của tài khoản.

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

Chèn một nhóm khoá liên hệ của tài khoản.

Hoạt động tương tự như updateOrInsertE2eeContactKey, nhưng cho phép chèn/cập nhật nhiều khoá cùng một lúc. Mỗi khoá được chèn vào giao dịch riêng, vì vậy, một số khoá có thể được chèn ngay cả khi tác vụ này tạo ra một ngoại lệ.

Các ứng dụng có thể chọn xử lý các lỗi tạm thời bằng cách gửi lại toàn bộ lô, vì API này sẽ không ảnh hưởng đến trạng thái của các khoá đã được chèn.

Đối với mỗi khoá, nếu bạn cung cấp lookupKey nhưng không cung cấp thông tin cơ bản về người liên hệ (displayName, phoneNumber, emailAddress), thì API này cũng sẽ cố gắng truy xuất tên, số điện thoại và địa chỉ email của người liên hệ từ Trình cung cấp danh bạ. Khi truy xuất khoá, các ứng dụng quản lý danh bạ nên sử dụng thông tin này để đảm bảo rằng khoá chỉ được dùng cho người liên hệ mà khoá đó được dự định dùng.

Ứng dụng Xác minh khoá Android lưu trữ thông tin này trên thiết bị và chỉ cung cấp thông tin đó cho những người gọi API có quyền READ_CONTACTS.

Nếu không có lookupKey nào được cung cấp cho một khoá, thì API này sẽ lưu trữ một khoá không liên kết với bất kỳ người liên hệ nào.

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

Chèn một mục mới vào bảng khoá liên hệ mã hoá đầu cuối hoặc cập nhật một mục nếu mục đó đã tồn tại. Khoá liên hệ mã hoá hai đầu đã chèn/cập nhật thuộc sở hữu của ứng dụng gọi.

API này cũng sẽ lưu trữ tên, số điện thoại và địa chỉ email của người liên hệ từ Trình cung cấp danh bạ, cùng với khoá. Khi truy xuất khoá, các ứng dụng quản lý danh bạ nên sử dụng thông tin này để đảm bảo rằng khoá chỉ được dùng cho người liên hệ mà khoá đó được dự định dùng.

Ứng dụng Xác minh khoá Android lưu trữ thông tin này trên thiết bị và chỉ cung cấp thông tin đó cho những người gọi API có quyền READ_CONTACTS.

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

Chèn một mục mới vào bảng khoá liên hệ mã hoá đầu cuối hoặc cập nhật một mục nếu mục đó đã tồn tại. Khoá liên hệ được mã hoá hai đầu đã chèn/cập nhật thuộc sở hữu của ứng dụng gọi.

Đối với mỗi khoá tìm kiếm được cung cấp, API này cũng sẽ lưu trữ tên, số điện thoại và địa chỉ email của người liên hệ từ Trình cung cấp danh bạ, cùng với khoá. Khi truy xuất khoá, các ứng dụng quản lý danh bạ nên sử dụng thông tin này để đảm bảo rằng khoá chỉ được dùng cho người liên hệ mà khoá đó được dự định dùng.

Ứng dụng Xác minh khoá Android lưu trữ thông tin này trên thiết bị và chỉ cung cấp thông tin đó cho những người gọi API có quyền READ_CONTACTS.

Nếu danh sách khoá tra cứu trống, API này sẽ lưu trữ một khoá không liên kết với bất kỳ người liên hệ nào.

Khi gọi API này bằng một hoặc nhiều khoá tra cứu, khoá này sẽ cập nhật siêu dữ liệu khoá để liên kết khoá đó với các danh bạ được cung cấp, nhưng sẽ không xoá bất kỳ mối liên kết hiện có nào cho những danh bạ không có trong danh sách. Để xoá mối liên kết giữa một người liên hệ và một khoá, hãy gọi removeE2eeContactKey bằng khoá tra cứu thích hợp.

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

Chèn một mục mới vào bảng khoá tự mã hoá hai đầu hoặc cập nhật một mục nếu mục đó đã tồn tại.