ContactsContract.CommonDataKinds.Contactables

public static final class ContactsContract.CommonDataKinds.Contactables
extends Object implements ContactsContract.DataColumnsWithJoins, ContactsContract.CommonDataKinds.CommonColumns

java.lang.Object
   ↳ android.provider.ContactsContract.CommonDataKinds.Contactables


A special class of data items, used to refer to types of data that can be used to attempt to start communicating with a person (ContactsContract.CommonDataKinds.Phone and ContactsContract.CommonDataKinds.Email). Note that this is NOT a separate data kind. This URI allows the ContactsProvider to return a unified result for data items that users can use to initiate communications with another contact. ContactsContract.CommonDataKinds.Phone and ContactsContract.CommonDataKinds.Email are the current data types in this category.

Summary

Constants

String EXTRA_ADDRESS_BOOK_INDEX

Add this query parameter to a URI to get back row counts grouped by the address book index as cursor extras.

String EXTRA_ADDRESS_BOOK_INDEX_COUNTS

The array of group counts for the corresponding group.

String EXTRA_ADDRESS_BOOK_INDEX_TITLES

The array of address book index titles, which are returned in the same order as the data in the cursor.

String VISIBLE_CONTACTS_ONLY

A boolean parameter for ContactsContract.Contacts.CONTENT_URI.

Inherited constants

Fields

public static final Uri CONTENT_FILTER_URI

The content:// style URI for these data items, which allows for a query parameter to be appended onto the end to filter for data items matching the query.

public static final Uri CONTENT_URI

The content:// style URI for these data items, which requests a directory of data rows matching the selection criteria.

Public constructors

ContactsContract.CommonDataKinds.Contactables()

Inherited methods

Constants

EXTRA_ADDRESS_BOOK_INDEX

added in API level 21
public static final String EXTRA_ADDRESS_BOOK_INDEX

Add this query parameter to a URI to get back row counts grouped by the address book index as cursor extras. For most languages it is the first letter of the sort key. This parameter does not affect the main content of the cursor.

 Example:

 import android.provider.ContactsContract.Contacts;

 Uri uri = Contacts.CONTENT_URI.buildUpon()
          .appendQueryParameter(Contacts.EXTRA_ADDRESS_BOOK_INDEX, "true")
          .build();
 Cursor cursor = getContentResolver().query(uri,
          new String[] {Contacts.DISPLAY_NAME},
          null, null, null);
 Bundle bundle = cursor.getExtras();
 if (bundle.containsKey(Contacts.EXTRA_ADDRESS_BOOK_INDEX_TITLES) &&
         bundle.containsKey(Contacts.EXTRA_ADDRESS_BOOK_INDEX_COUNTS)) {
     String sections[] =
             bundle.getStringArray(Contacts.EXTRA_ADDRESS_BOOK_INDEX_TITLES);
     int counts[] = bundle.getIntArray(Contacts.EXTRA_ADDRESS_BOOK_INDEX_COUNTS);
 }
 

Constant Value: "android.provider.extra.ADDRESS_BOOK_INDEX"

EXTRA_ADDRESS_BOOK_INDEX_COUNTS

added in API level 21
public static final String EXTRA_ADDRESS_BOOK_INDEX_COUNTS

The array of group counts for the corresponding group. Contains the same number of elements as the EXTRA_ADDRESS_BOOK_INDEX_TITLES array.

TYPE: int[]

Constant Value: "android.provider.extra.ADDRESS_BOOK_INDEX_COUNTS"

EXTRA_ADDRESS_BOOK_INDEX_TITLES

added in API level 21
public static final String EXTRA_ADDRESS_BOOK_INDEX_TITLES

The array of address book index titles, which are returned in the same order as the data in the cursor.

TYPE: String[]

Constant Value: "android.provider.extra.ADDRESS_BOOK_INDEX_TITLES"

VISIBLE_CONTACTS_ONLY

added in API level 18
public static final String VISIBLE_CONTACTS_ONLY

A boolean parameter for ContactsContract.Contacts.CONTENT_URI. This specifies whether or not the returned data items should be filtered to show data items belonging to visible contacts only.

Constant Value: "visible_contacts_only"

Fields

CONTENT_FILTER_URI

added in API level 18
public static final Uri CONTENT_FILTER_URI

The content:// style URI for these data items, which allows for a query parameter to be appended onto the end to filter for data items matching the query.

Caution: As of January 7, 2019, this field no longer sorts results based on contacts frequency. For more information, see the Contacts Provider page.

CONTENT_URI

added in API level 18
public static final Uri CONTENT_URI

The content:// style URI for these data items, which requests a directory of data rows matching the selection criteria.

Public constructors

ContactsContract.CommonDataKinds.Contactables

added in API level 18
public ContactsContract.CommonDataKinds.Contactables ()