Callable

Kotlin |Java

class Callable : ContactsContract.DataColumnsWithJoins, ContactsContract.CommonDataKinds.CommonColumns

kotlin.Any
↳	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. Phone and 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 Phone's type is different than SipAddress's.

Summary

Constants
static 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.
static String	`EXTRA_ADDRESS_BOOK_INDEX_COUNTS` The array of group counts for the corresponding group.
static 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

From class CommonColumns

String

DATA

The data for the contact method.

Type: TEXT

String

LABEL

The user defined label for the the contact method.

Type: TEXT

String

TYPE

The type of data, for example Home or Work.

Type: INTEGER

From class BaseTypes

Int

TYPE_CUSTOM

A custom type. The custom label should be supplied by user.

Public constructors
`Callable()`

Properties
static Uri!	`CONTENT_FILTER_URI` Similar to `Phone#CONTENT_FILTER_URI`, but allows users to filter callable data.
static Uri!	`CONTENT_URI` Similar to `Phone#CONTENT_URI`, but returns callable data instead of only phone numbers.
static Uri!	`ENTERPRISE_CONTENT_FILTER_URI` Similar to `Phone#ENTERPRISE_CONTENT_FILTER_URI`, but allows users to filter callable data.

Constants

EXTRA_ADDRESS_BOOK_INDEX

static val EXTRA_ADDRESS_BOOK_INDEX: String

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);
  }

Value: "android.provider.extra.ADDRESS_BOOK_INDEX"

EXTRA_ADDRESS_BOOK_INDEX_COUNTS

static val EXTRA_ADDRESS_BOOK_INDEX_COUNTS: String

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[]

Value: "android.provider.extra.ADDRESS_BOOK_INDEX_COUNTS"

EXTRA_ADDRESS_BOOK_INDEX_TITLES

static val EXTRA_ADDRESS_BOOK_INDEX_TITLES: String

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

TYPE: String[]

Value: "android.provider.extra.ADDRESS_BOOK_INDEX_TITLES"

Public constructors

Callable

Callable()

Properties

CONTENT_FILTER_URI

Added in API level 21

static val CONTENT_FILTER_URI: Uri!

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

Caution: 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

static val CONTENT_URI: Uri!

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

ENTERPRISE_CONTENT_FILTER_URI

Added in API level 24

static val ENTERPRISE_CONTENT_FILTER_URI: Uri!

Similar to 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: If you publish your app to the Google Play Store, this field doesn't sort results based on contacts frequency. For more information, see the Contacts Provider page.