Android APIs
public static final class

ContactsContract.CommonDataKinds.Phone

extends Object
implements ContactsContract.CommonDataKinds.CommonColumns ContactsContract.DataColumnsWithJoins
java.lang.Object
   ↳ android.provider.ContactsContract.CommonDataKinds.Phone

Class Overview

A data kind representing a telephone number.

You can use all columns defined for ContactsContract.Data as well as the following aliases.

Column aliases

Type AliasData column
String NUMBER DATA1
int TYPE DATA2 Allowed values are:

String LABEL DATA3

Summary

Constants
String CONTENT_ITEM_TYPE MIME type used when storing this in data table.
String CONTENT_TYPE The MIME type of CONTENT_URI providing a directory of phones.
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 NORMALIZED_NUMBER The phone number's E164 representation.
String NUMBER The phone number as the user entered it.
String SEARCH_DISPLAY_NAME_KEY A boolean query parameter that can be used with CONTENT_FILTER_URI.
String SEARCH_PHONE_NUMBER_KEY A boolean query parameter that can be used with CONTENT_FILTER_URI.
int TYPE_ASSISTANT
int TYPE_CALLBACK
int TYPE_CAR
int TYPE_COMPANY_MAIN
int TYPE_FAX_HOME
int TYPE_FAX_WORK
int TYPE_HOME
int TYPE_ISDN
int TYPE_MAIN
int TYPE_MMS
int TYPE_MOBILE
int TYPE_OTHER
int TYPE_OTHER_FAX
int TYPE_PAGER
int TYPE_RADIO
int TYPE_TELEX
int TYPE_TTY_TDD
int TYPE_WORK
int TYPE_WORK_MOBILE
int TYPE_WORK_PAGER
[Expand]
Inherited Constants
From interface android.provider.BaseColumns
From interface android.provider.ContactsContract.CommonDataKinds.BaseTypes
From interface android.provider.ContactsContract.CommonDataKinds.CommonColumns
From interface android.provider.ContactsContract.ContactNameColumns
From interface android.provider.ContactsContract.ContactOptionsColumns
From interface android.provider.ContactsContract.ContactStatusColumns
From interface android.provider.ContactsContract.ContactsColumns
From interface android.provider.ContactsContract.DataColumns
From interface android.provider.ContactsContract.DataUsageStatColumns
From interface android.provider.ContactsContract.RawContactsColumns
From interface android.provider.ContactsContract.StatusColumns
Fields
public static final Uri CONTENT_FILTER_URI The content:// style URL for phone lookup using a filter.
public static final Uri CONTENT_URI The content:// style URI for all data records of the CONTENT_ITEM_TYPE MIME type, combined with the associated raw contact and aggregate contact data.
Public Methods
final static CharSequence getTypeLabel(Resources res, int type, CharSequence label)
Return a CharSequence that best describes the given type, possibly substituting the given LABEL value for TYPE_CUSTOM.
final static int getTypeLabelResource(int type)
Return the string resource that best describes the given TYPE.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String CONTENT_ITEM_TYPE

Added in API level 5

MIME type used when storing this in data table.

Constant Value: "vnd.android.cursor.item/phone_v2"

public static final String CONTENT_TYPE

Added in API level 5

The MIME type of CONTENT_URI providing a directory of phones.

Constant Value: "vnd.android.cursor.dir/phone_v2"

public static final String EXTRA_ADDRESS_BOOK_INDEX

Added in API level 21

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"

public static final String EXTRA_ADDRESS_BOOK_INDEX_COUNTS

Added in API level 21

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"

public static final String EXTRA_ADDRESS_BOOK_INDEX_TITLES

Added in API level 21

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"

public static final String NORMALIZED_NUMBER

Added in API level 16

The phone number's E164 representation. This value can be omitted in which case the provider will try to automatically infer it. (It'll be left null if the provider fails to infer.) If present, NUMBER has to be set as well (it will be ignored otherwise).

Type: TEXT

Constant Value: "data4"

public static final String NUMBER

Added in API level 5

The phone number as the user entered it.

Type: TEXT

Constant Value: "data1"

public static final String SEARCH_DISPLAY_NAME_KEY

Added in API level 16

A boolean query parameter that can be used with CONTENT_FILTER_URI. If "1" or "true", display names are searched. If "0" or "false", display names are not searched. Default is "1".

Constant Value: "search_display_name"

public static final String SEARCH_PHONE_NUMBER_KEY

Added in API level 16

A boolean query parameter that can be used with CONTENT_FILTER_URI. If "1" or "true", phone numbers are searched. If "0" or "false", phone numbers are not searched. Default is "1".

Constant Value: "search_phone_number"

public static final int TYPE_ASSISTANT

Added in API level 5

Constant Value: 19 (0x00000013)

public static final int TYPE_CALLBACK

Added in API level 5

Constant Value: 8 (0x00000008)

public static final int TYPE_CAR

Added in API level 5

Constant Value: 9 (0x00000009)

public static final int TYPE_COMPANY_MAIN

Added in API level 5

Constant Value: 10 (0x0000000a)

public static final int TYPE_FAX_HOME

Added in API level 5

Constant Value: 5 (0x00000005)

public static final int TYPE_FAX_WORK

Added in API level 5

Constant Value: 4 (0x00000004)

public static final int TYPE_HOME

Added in API level 5

Constant Value: 1 (0x00000001)

public static final int TYPE_ISDN

Added in API level 5

Constant Value: 11 (0x0000000b)

public static final int TYPE_MAIN

Added in API level 5

Constant Value: 12 (0x0000000c)

public static final int TYPE_MMS

Added in API level 5

Constant Value: 20 (0x00000014)

public static final int TYPE_MOBILE

Added in API level 5

Constant Value: 2 (0x00000002)

public static final int TYPE_OTHER

Added in API level 5

Constant Value: 7 (0x00000007)

public static final int TYPE_OTHER_FAX

Added in API level 5

Constant Value: 13 (0x0000000d)

public static final int TYPE_PAGER

Added in API level 5

Constant Value: 6 (0x00000006)

public static final int TYPE_RADIO

Added in API level 5

Constant Value: 14 (0x0000000e)

public static final int TYPE_TELEX

Added in API level 5

Constant Value: 15 (0x0000000f)

public static final int TYPE_TTY_TDD

Added in API level 5

Constant Value: 16 (0x00000010)

public static final int TYPE_WORK

Added in API level 5

Constant Value: 3 (0x00000003)

public static final int TYPE_WORK_MOBILE

Added in API level 5

Constant Value: 17 (0x00000011)

public static final int TYPE_WORK_PAGER

Added in API level 5

Constant Value: 18 (0x00000012)

Fields

public static final Uri CONTENT_FILTER_URI

Added in API level 5

The content:// style URL for phone lookup using a filter. The filter returns records of MIME type CONTENT_ITEM_TYPE. The filter is applied to display names as well as phone numbers. The filter argument should be passed as an additional path segment after this URI.

public static final Uri CONTENT_URI

Added in API level 5

The content:// style URI for all data records of the CONTENT_ITEM_TYPE MIME type, combined with the associated raw contact and aggregate contact data.

Public Methods

public static final CharSequence getTypeLabel (Resources res, int type, CharSequence label)

Added in API level 5

Return a CharSequence that best describes the given type, possibly substituting the given LABEL value for TYPE_CUSTOM.

public static final int getTypeLabelResource (int type)

Added in API level 5

Return the string resource that best describes the given TYPE. Will always return a valid resource.