Эта страница переведена с помощью Cloud Translation API.

Выбор контактов

Интерфейс выбора контактов Android Contact Picker — это стандартизированный, удобный для просмотра интерфейс, позволяющий пользователям делиться контактами с вашим приложением. Доступный на устройствах под управлением Android 17 (уровень API 37) или выше, этот интерфейс предлагает альтернативу широкому разрешению READ_CONTACTS , обеспечивающую конфиденциальность. Вместо запроса доступа ко всей адресной книге пользователя, ваше приложение указывает необходимые поля данных, такие как номера телефонов или адреса электронной почты, а пользователь выбирает конкретные контакты для обмена. Это предоставляет вашему приложению доступ на чтение только к выбранным данным, обеспечивая детальный контроль и предоставляя единообразный пользовательский опыт со встроенным поиском, переключением профилей и возможностью множественного выбора без необходимости разработки или поддержки пользовательского интерфейса.

Интегрируйте средство выбора контактов.

Для интеграции средства выбора контактов используйте интент Intent.ACTION_PICK_CONTACTS . Этот интент запускает средство выбора и возвращает выбранные контакты в ваше приложение.

В отличие от устаревшего ACTION_PICK , Contact Picker позволяет одновременно указывать несколько полей данных, необходимых вашему приложению. Это делается с помощью Intent.EXTRA_REQUESTED_DATA_FIELDS , передавая ArrayList<String> MIME-типов, определенных в ContactsContract.CommonDataKinds .

К распространённым MIME-типам относятся:

ContactsContract.CommonDataKinds.Phone.CONTENT_ITEM_TYPE
ContactsContract.CommonDataKinds.Email.CONTENT_ITEM_TYPE
ContactsContract.CommonDataKinds.StructuredPostal.CONTENT_ITEM_TYPE

Запустите средство выбора

Используйте registerForActivityResult с контрактом StartActivityForResult для запуска средства выбора. Вы можете настроить Intent таким образом, чтобы разрешить одиночный или множественный выбор.

// Launcher for the Contact Picker intent
val pickContact = rememberLauncherForActivityResult(StartActivityForResult()) {
    if (it.resultCode == Activity.RESULT_OK) {
        val resultUri = it.data?.data ?: return@rememberLauncherForActivityResult

        // Process the result URI in a background thread to fetch all selected contacts
        coroutine.launch {
            contacts = processContactPickerResultUri(resultUri, context)
        }
    }
}ContactPickerActivity.kt

Режим выбора

Интерфейс средства выбора контактов подстраивается под запрашиваемые поля данных. В зависимости от этих требований пользователи могут либо выбрать всю запись контакта целиком, если требуется несколько полей, либо выбрать конкретные элементы данных из информации о контакте.

Различные режимы пользовательского интерфейса средства выбора контактов — **Рисунок 1.** Интерфейс выбора контактов адаптируется к запрашиваемым полям данных (выбор одного контакта, нескольких контактов и нескольких телефонных номеров).

Выберите один контакт

В этом примере приложение запрашивает только номера телефонов. Средство выбора отфильтрует список, чтобы отобразить только контакты с номерами телефонов, и позволит пользователю выбрать конкретный номер.

// Define the specific contact data fields you need
val requestedFields = arrayListOf(
    Email.CONTENT_ITEM_TYPE,
    Phone.CONTENT_ITEM_TYPE,
)

// Set up the intent for the Contact Picker
val pickContactIntent = Intent(ACTION_PICK_CONTACTS).apply {
    putStringArrayListExtra(
        EXTRA_PICK_CONTACTS_REQUESTED_DATA_FIELDS,
        requestedFields
    )
}

// Launch the picker
pickContact.launch(pickContactIntent)ContactPickerActivity.kt

Выберите несколько контактов

Чтобы включить множественный выбор, добавьте дополнительный параметр Intent.EXTRA_ALLOW_MULTIPLE . При желании вы можете ограничить количество элементов, которые может выбрать пользователь.

val requestedFields = arrayListOf(
    Email.CONTENT_ITEM_TYPE,
    Phone.CONTENT_ITEM_TYPE,
)

// Set up the intent for the Contact Picker
val pickContactIntent = Intent(ACTION_PICK_CONTACTS).apply {
    // Enable multi-select
    putExtra(Intent.EXTRA_ALLOW_MULTIPLE, true)
    // Set limit of selectable contacts
    putExtra(EXTRA_PICK_CONTACTS_SELECTION_LIMIT, 5)
    // Define the specific contact data fields you need
    putStringArrayListExtra(
        EXTRA_PICK_CONTACTS_REQUESTED_DATA_FIELDS,
        requestedFields
    )
    // Enable this option to only filter contacts that have all the requested data fields
    putExtra(EXTRA_PICK_CONTACTS_MATCH_ALL_DATA_FIELDS, false)
}

// Launch the picker
pickContact.launch(pickContactIntent)ContactPickerActivity.kt

Обработайте результаты

После завершения выбора пользователем система возвращает объект RESULT_OK и URI сессии. Этот URI предоставляет временный доступ для чтения к выбранным данным.

Вы можете запросить этот URI, используя стандартный ContentResolver . Полученный Cursor содержит запрошенные поля данных и соответствует схеме ContactsContract.Data .

// Data class representing a parsed Contact with selected details.
data class Contact(
    val lookupKey: String,
    val name: String,
    val emails: List<String>,
    val phones: List<String>
)

// Helper function to query the content resolver with the URI returned by the Contact Picker.
// Parses the cursor to extract contact details such as name, email, and phone number.
private suspend fun processContactPickerResultUri(
    sessionUri: Uri,
    context: Context
): List<Contact> = withContext(Dispatchers.IO) {
    // Define the columns we want to retrieve from the ContactPicker ContentProvider
    val projection = arrayOf(
        ContactsContract.Contacts.LOOKUP_KEY,
        ContactsContract.Contacts.DISPLAY_NAME_PRIMARY,
        ContactsContract.Data.MIMETYPE, // Type of data (e.g., email or phone)
        ContactsContract.Data.DATA1, // The actual data (Phone number / Email string)
    )

    // We use `LOOKUP_KEY` as a unique ID to aggregate all contact info related to a same person
    val contactsMap = mutableMapOf<String, Contact>()

    // Note: The Contact Picker Session Uri doesn't support custom selection & selectionArgs.
    // We query the URI directly to get the results chosen by the user.
    context.contentResolver.query(sessionUri, projection, null, null, null)?.use { cursor ->
        // Get the column indices for our requested projection
        val lookupKeyIdx = cursor.getColumnIndex(ContactsContract.Contacts.LOOKUP_KEY)
        val mimeTypeIdx = cursor.getColumnIndex(ContactsContract.Data.MIMETYPE)
        val nameIdx = cursor.getColumnIndex(ContactsContract.Contacts.DISPLAY_NAME_PRIMARY)
        val data1Idx = cursor.getColumnIndex(ContactsContract.Data.DATA1)

        while (cursor.moveToNext()) {
            val lookupKey = cursor.getString(lookupKeyIdx)
            val mimeType = cursor.getString(mimeTypeIdx)
            val name = cursor.getString(nameIdx) ?: ""
            val data1 = cursor.getString(data1Idx) ?: ""

            val email = if (mimeType == Email.CONTENT_ITEM_TYPE) data1 else null
            val phone = if (mimeType == Phone.CONTENT_ITEM_TYPE) data1 else null

            val existingContact = contactsMap[lookupKey]
            if (existingContact != null) {
                contactsMap[lookupKey] = existingContact.copy(
                    emails = if (email != null) existingContact.emails + email else existingContact.emails,
                    phones = if (phone != null) existingContact.phones + phone else existingContact.phones
                )
            } else {
                contactsMap[lookupKey] = Contact(
                    lookupKey = lookupKey,
                    name = name,
                    emails = if (email != null) listOf(email) else emptyList(),
                    phones = if (phone != null) listOf(phone) else emptyList()
                )
            }
        }
    }

    return@withContext contactsMap.values.toList()
}ContactPickerActivity.kt

Обратная совместимость

Для приложений, ориентированных на Android 17 (уровень API 37) и выше, система автоматически обновляет существующий Intent.ACTION_PICK для использования нового интерфейса выбора контактов.

Если ваше приложение уже использует ACTION_PICK , вам не нужно менять код для получения нового пользовательского интерфейса. Однако, чтобы воспользоваться новыми функциями, такими как получение одного Uri для запроса контактных данных, переключение между личным и рабочим профилями или запросы нескольких полей данных, вам необходимо обновить свою реализацию, чтобы использовать Intent.ACTION_PICK_CONTACTS или новые дополнительные параметры Intent.

Тестирование на более старых целевых SDK.

Вы можете протестировать новое поведение средства выбора на устройствах под управлением Android 17 и выше, даже если ваше приложение ориентировано на более старую версию SDK, добавив логическую переменную EXTRA_USE_SYSTEM_CONTACTS_PICKER в ваш интент ACTION_PICK .

Передовые методы

Запрашивайте только то, что вам нужно : если вашему приложению нужно только отправить SMS, запросите Phone.CONTENT_ITEM_TYPE . Средство выбора автоматически отфильтрует контакты, у которых нет номеров телефонов, что обеспечит более удобный пользовательский интерфейс.
Управление несколькими записями данных для каждого контакта : Отдельные контакты часто содержат различные адреса электронной почты или номера телефонов. Для обеспечения четкого и интуитивно понятного отображения этой информации пользователю рекомендуется группировать контакты с помощью ContactsContract.Contacts.LOOKUP_KEY . Кроме того, вы можете получить конкретные метки для каждой записи (например, рабочая или личная), чтобы предложить более детальные варианты выбора в интерфейсе вашего приложения.
Сохранение данных немедленно : URI сессии предоставляет временное разрешение на чтение. Если вам потребуется получить доступ к этой контактной информации позже (после завершения процесса вашего приложения), ваше приложение должно сохранить контактные данные.
Не полагайтесь на данные учетной записи : для защиты конфиденциальности пользователей и предотвращения идентификации по отпечатку учетной записи метаданные, относящиеся к конкретной учетной записи, удаляются из результатов.