ContactsContract.CommonDataKinds.Callable

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

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


Convenient functionalities for "callable" data. Note that, this is NOT a separate data kind.

This URI allows the ContactsProvider to return a unified result for "callable" data that users can use for calling purposes. ContactsContract.CommonDataKinds.Phone and ContactsContract.CommonDataKinds.SipAddress are the current examples for "callable", but may be expanded to the other types.

Each returned row may have a different MIMETYPE and thus different interpretation for each column. For example the meaning for ContactsContract.CommonDataKinds.Phone's type is different than ContactsContract.CommonDataKinds.SipAddress's.

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.

Inherited constants

Fields

public static final Uri CONTENT_FILTER_URI

Similar to ContactsContract.CommonDataKinds.Phone.CONTENT_FILTER_URI, but allows users to filter callable data.

public static final Uri CONTENT_URI

Similar to ContactsContract.CommonDataKinds.Phone.CONTENT_URI, but returns callable data instead of only phone numbers.

public static final Uri ENTERPRISE_CONTENT_FILTER_URI

Similar to ContactsContract.CommonDataKinds.Phone.ENTERPRISE_CONTENT_FILTER_URI, but allows users to filter callable data.

Public constructors

ContactsContract.CommonDataKinds.Callable()

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"

Fields

CONTENT_FILTER_URI

added in API level 21
public static final Uri CONTENT_FILTER_URI

Similar to ContactsContract.CommonDataKinds.Phone.CONTENT_FILTER_URI, but allows users to filter callable data.

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 21
public static final Uri CONTENT_URI

Similar to ContactsContract.CommonDataKinds.Phone.CONTENT_URI, but returns callable data instead of only phone numbers.

ENTERPRISE_CONTENT_FILTER_URI

added in API level 24
public static final Uri ENTERPRISE_CONTENT_FILTER_URI

Similar to ContactsContract.CommonDataKinds.Phone.ENTERPRISE_CONTENT_FILTER_URI, but allows users to filter callable data. This URI requires ContactsContract.DIRECTORY_PARAM_KEY in parameters, otherwise it will throw IllegalArgumentException.

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

Public constructors

ContactsContract.CommonDataKinds.Callable

added in API level 21
public ContactsContract.CommonDataKinds.Callable ()