Contacts

Kotlin |Java

class Contacts : BaseColumns, ContactsContract.ContactNameColumns, ContactsContract.ContactOptionsColumns, ContactsContract.ContactStatusColumns, ContactsContract.ContactsColumns

kotlin.Any
↳	android.provider.ContactsContract.Contacts

Constants for the contacts table, which contains a record per aggregate of raw contacts representing the same person.

Operations

Insert

A Contact cannot be created explicitly. When a raw contact is inserted, the provider will first try to find a Contact representing the same person. If one is found, the raw contact's RawContacts.CONTACT_ID column gets the _ID of the aggregate Contact. If no match is found, the provider automatically inserts a new Contact and puts its _ID into the RawContacts.CONTACT_ID column of the newly inserted raw contact.

Update

Only certain columns of Contact are modifiable: STARRED, CUSTOM_RINGTONE, SEND_TO_VOICEMAIL. Changing any of these columns on the Contact also changes them on all constituent raw contacts.

Delete

Be careful with deleting Contacts! Deleting an aggregate contact deletes all constituent raw contacts. The corresponding sync adapters will notice the deletions of their respective raw contacts and remove them from their back end storage.

Query

If you need to read an individual contact, consider using CONTENT_LOOKUP_URI instead of CONTENT_URI.
If you need to look up a contact by the phone number, use PhoneLookup.CONTENT_FILTER_URI, which is optimized for this purpose.
If you need to look up a contact by partial name, e.g. to produce filter-as-you-type suggestions, use the CONTENT_FILTER_URI URI.
If you need to look up a contact by some data element like email address, nickname, etc, use a query against the ContactsContract.Data table. The result will contain contact ID, name etc.

Columns

Contacts
long	`_ID`	read-only	Row ID. Consider using `LOOKUP_KEY` instead.
String	`LOOKUP_KEY`	read-only	An opaque value that contains hints on how to find the contact if its row id changed as a result of a sync or aggregation.
long	NAME_RAW_CONTACT_ID	read-only	The ID of the raw contact that contributes the display name to the aggregate contact. During aggregation one of the constituent raw contacts is chosen using a heuristic: a longer name or a name with more diacritic marks or more upper case characters is chosen.
String	DISPLAY_NAME_PRIMARY	read-only	The display name for the contact. It is the display name contributed by the raw contact referred to by the NAME_RAW_CONTACT_ID column.
long	`PHOTO_ID`	read-only	Reference to the row in the `ContactsContract.Data` table holding the photo. That row has the mime type `CommonDataKinds.Photo#CONTENT_ITEM_TYPE`. The value of this field is computed automatically based on the `CommonDataKinds.Photo#IS_SUPER_PRIMARY` field of the data rows of that mime type.
long	`PHOTO_URI`	read-only	A URI that can be used to retrieve the contact's full-size photo. This column is the preferred method of retrieving the contact photo.
long	`PHOTO_THUMBNAIL_URI`	read-only	A URI that can be used to retrieve the thumbnail of contact's photo. This column is the preferred method of retrieving the contact photo.
int	`IN_VISIBLE_GROUP`	read-only	An indicator of whether this contact is supposed to be visible in the UI. "1" if the contact has at least one raw contact that belongs to a visible group; "0" otherwise.
int	`HAS_PHONE_NUMBER`	read-only	An indicator of whether this contact has at least one phone number. "1" if there is at least one phone number, "0" otherwise.
int	`STARRED`	read/write	An indicator for favorite contacts: '1' if favorite, '0' otherwise. When raw contacts are aggregated, this field is automatically computed: if any constituent raw contacts are starred, then this field is set to '1'. Setting this field automatically changes the corresponding field on all constituent raw contacts.
String	`CUSTOM_RINGTONE`	read/write	A custom ringtone associated with a contact. Typically this is the URI returned by an activity launched with the `android.media.RingtoneManager#ACTION_RINGTONE_PICKER` intent.
int	`SEND_TO_VOICEMAIL`	read/write	An indicator of whether calls from this contact should be forwarded directly to voice mail ('1') or not ('0'). When raw contacts are aggregated, this field is automatically computed: if all constituent raw contacts have SEND_TO_VOICEMAIL=1, then this field is set to '1'. Setting this field automatically changes the corresponding field on all constituent raw contacts.
int	`CONTACT_PRESENCE`	read-only	Contact IM presence status. See `StatusUpdates` for individual status definitions. Automatically computed as the highest presence of all constituent raw contacts. The provider may choose not to store this value in persistent storage. The expectation is that presence status will be updated on a regular basis.
String	`CONTACT_STATUS`	read-only	Contact's latest status update. Automatically computed as the latest of all constituent raw contacts' status updates.
long	`CONTACT_STATUS_TIMESTAMP`	read-only	The absolute time in milliseconds when the latest status was inserted/updated.
String	`CONTACT_STATUS_RES_PACKAGE`	read-only	The package containing resources for this status: label and icon.
long	`CONTACT_STATUS_LABEL`	read-only	The resource ID of the label describing the source of contact status, e.g. "Google Talk". This resource is scoped by the `CONTACT_STATUS_RES_PACKAGE`.
long	`CONTACT_STATUS_ICON`	read-only	The resource ID of the icon for the source of contact status. This resource is scoped by the `CONTACT_STATUS_RES_PACKAGE`.

Summary

Nested classes
	`AggregationSuggestions` A read-only sub-directory of a single contact aggregate that contains all aggregation suggestions (other contacts).
	`Data` A sub-directory of a single contact that contains all of the constituent raw contact `ContactsContract.Data` rows.
	`Entity` A sub-directory of a contact that contains all of its `ContactsContract.RawContacts` as well as `ContactsContract.Data` rows.
	`Photo` A read-only sub-directory of a single contact that contains the contact's primary photo.

Constants
static String	`CONTENT_ITEM_TYPE` The MIME type of a `CONTENT_URI` subdirectory of a single person.
static String	`CONTENT_TYPE` The MIME type of `CONTENT_URI` providing a directory of people.
static String	`CONTENT_VCARD_TYPE` The MIME type of a `CONTENT_URI` subdirectory of a single person.
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.
static String	`QUERY_PARAMETER_VCARD_NO_PHOTO` Boolean parameter that may be used with `CONTENT_VCARD_URI` and `CONTENT_MULTI_VCARD_URI` to indicate that the returned vcard should not contain a photo.

Inherited constants

From class ContactStatusColumns

`String`	`CONTACT_CHAT_CAPABILITY` Contact Chat Capabilities. See `StatusUpdates` for individual definitions. Type: NUMBER
`String`	`CONTACT_PRESENCE` Contact presence status. See `StatusUpdates` for individual status definitions. Type: NUMBER
`String`	`CONTACT_STATUS` Contact's latest status update. Type: TEXT
`String`	`CONTACT_STATUS_ICON` The resource ID of the icon for the source of contact status. This resource is scoped by the `CONTACT_STATUS_RES_PACKAGE`. Type: NUMBER
`String`	`CONTACT_STATUS_LABEL` The resource ID of the label describing the source of contact status, e.g. "Google Talk". This resource is scoped by the `CONTACT_STATUS_RES_PACKAGE`. Type: NUMBER
`String`	`CONTACT_STATUS_RES_PACKAGE` The package containing resources for this status: label and icon. Type: TEXT
`String`	`CONTACT_STATUS_TIMESTAMP` The absolute time in milliseconds when the latest status was inserted/updated. Type: NUMBER

From class ContactsColumns

`String`	`CONTACT_LAST_UPDATED_TIMESTAMP` Timestamp (milliseconds since epoch) of when this contact was last updated. This includes updates to all data associated with this contact including raw contacts. Any modification (including deletes and inserts) of underlying contact data are also reflected in this timestamp.
`String`	`DISPLAY_NAME` The display name for the contact. Type: TEXT
`String`	`HAS_PHONE_NUMBER` An indicator of whether this contact has at least one phone number. "1" if there is at least one phone number, "0" otherwise. Type: INTEGER
`String`	`IN_DEFAULT_DIRECTORY` Flag that reflects whether the contact exists inside the default directory. Ie, whether the contact is designed to only be visible outside search.
`String`	`IN_VISIBLE_GROUP` Flag that reflects the `Groups.GROUP_VISIBLE` state of any `CommonDataKinds.GroupMembership` for this contact.
`String`	`IS_USER_PROFILE` Flag that reflects whether this contact represents the user's personal profile entry.
`String`	`LOOKUP_KEY` An opaque value that contains hints on how to find the contact if its row id changed as a result of a sync or aggregation.
`String`	`NAME_RAW_CONTACT_ID` Reference to the row in the RawContacts table holding the contact name. Type: INTEGER REFERENCES raw_contacts(_id)
`String`	`PHOTO_FILE_ID` Photo file ID of the full-size photo. If present, this will be used to populate `PHOTO_URI`. The ID can also be used with `ContactsContract.DisplayPhoto.CONTENT_URI` to create a URI to the photo. If this is present, `PHOTO_ID` is also guaranteed to be populated. Type: INTEGER
`String`	`PHOTO_ID` Reference to the row in the data table holding the photo. A photo can be referred to either by ID (this field) or by URI (see `PHOTO_THUMBNAIL_URI` and `PHOTO_URI`). If PHOTO_ID is null, consult `PHOTO_URI` or `PHOTO_THUMBNAIL_URI`, which is a more generic mechanism for referencing the contact photo, especially for contacts returned by non-local directories (see `Directory`). Type: INTEGER REFERENCES data(_id)
`String`	`PHOTO_THUMBNAIL_URI` A URI that can be used to retrieve a thumbnail of the contact's photo. A photo can be referred to either by a URI (this field or `PHOTO_URI`) or by ID (see `PHOTO_ID`). If PHOTO_ID is not null, PHOTO_URI and PHOTO_THUMBNAIL_URI shall not be null (but not necessarily vice versa). If the content provider does not differentiate between full-size photos and thumbnail photos, PHOTO_THUMBNAIL_URI and `PHOTO_URI` can contain the same value, but either both shall be null or both not null. Type: TEXT
`String`	`PHOTO_URI` A URI that can be used to retrieve the contact's full-size photo. If PHOTO_FILE_ID is not null, this will be populated with a URI based off `ContactsContract.DisplayPhoto.CONTENT_URI`. Otherwise, this will be populated with the same value as `PHOTO_THUMBNAIL_URI`. A photo can be referred to either by a URI (this field) or by ID (see `PHOTO_ID`). If either PHOTO_FILE_ID or PHOTO_ID is not null, PHOTO_URI and PHOTO_THUMBNAIL_URI shall not be null (but not necessarily vice versa). Thus using PHOTO_URI is a more robust method of retrieving contact photos. Type: TEXT

From class ContactOptionsColumns

`String`	`CUSTOM_RINGTONE` URI for a custom ringtone associated with the contact. If null or missing, the default ringtone is used. Type: TEXT (URI to the ringtone)
`String`	`LAST_TIME_CONTACTED` The last time a contact was contacted. Caution: If you publish your app to the Google Play Store, this field is obsolete, regardless of Android version. For more information, see the Contacts Provider page. Type: INTEGER
`String`	`PINNED` The position at which the contact is pinned. If `PinnedPositions.UNPINNED`, the contact is not pinned. Also see `PinnedPositions`. Type: INTEGER
`String`	`SEND_TO_VOICEMAIL` Whether the contact should always be sent to voicemail. If missing, defaults to false. Type: INTEGER (0 for false, 1 for true)
`String`	`STARRED` Is the contact starred? Type: INTEGER (boolean)
`String`	`TIMES_CONTACTED` The number of times a contact has been contacted. Caution: If you publish your app to the Google Play Store, this field is obsolete, regardless of Android version. For more information, see the Contacts Provider page. Type: INTEGER

From class ContactNameColumns

`String`	`DISPLAY_NAME_ALTERNATIVE` An alternative representation of the display name, such as "family name first" instead of "given name first" for Western names. If an alternative is not available, the values should be the same as `DISPLAY_NAME_PRIMARY`. A contacts provider is free to provide alternatives as necessary for its target market. For example the default Android Open Source Project contacts provider currently provides an alternative in a single case: if the display name is based on the structured name and the structured name follows the Western full name style, then the field contains the "family name first" version of the full name. Other cases may be added later.
`String`	`DISPLAY_NAME_PRIMARY` The standard text shown as the contact's display name, based on the best available information for the contact (for example, it might be the email address if the name is not available). The information actually used to compute the name is stored in `DISPLAY_NAME_SOURCE`. A contacts provider is free to choose whatever representation makes most sense for its target market. For example in the default Android Open Source Project implementation, if the display name is based on the structured name and the structured name follows the Western full-name style, then this field contains the "given name first" version of the full name.
`String`	`DISPLAY_NAME_SOURCE` The kind of data that is used as the display name for the contact, such as structured name or email address. See `DisplayNameSources`.
`String`	`PHONETIC_NAME` Pronunciation of the full name in the phonetic alphabet specified by `PHONETIC_NAME_STYLE`. The value may be set manually by the user. This capability is of interest only in countries with commonly used phonetic alphabets, such as Japan and Korea. See `PhoneticNameStyle`.
`String`	`PHONETIC_NAME_STYLE` The phonetic alphabet used to represent the `PHONETIC_NAME`. See `PhoneticNameStyle`.
`String`	`SORT_KEY_ALTERNATIVE` Sort key based on the alternative representation of the full name, `DISPLAY_NAME_ALTERNATIVE`. Thus for Western names, it is the one using the "family name first" format.
`String`	`SORT_KEY_PRIMARY` Sort key that takes into account locale-based traditions for sorting names in address books. The default sort key is `DISPLAY_NAME_PRIMARY`. For Chinese names the sort key is the name's Pinyin spelling, and for Japanese names it is the Hiragana version of the phonetic name.

From class BaseColumns

String

_COUNT

The count of rows in a directory.

Type: INTEGER

String

_ID

The unique ID for a row.

Type: INTEGER (long)

Public methods
open static Uri!	`getLookupUri(resolver: ContentResolver!, contactUri: Uri!)` Builds a `CONTENT_LOOKUP_URI` style `Uri` describing the requested `Contacts` entry.
open static Uri!	`getLookupUri(contactId: Long, lookupKey: String!)` Build a `CONTENT_LOOKUP_URI` lookup `Uri` using the given `ContactsContract.Contacts._ID` and `LOOKUP_KEY`.
open static Boolean	`isEnterpriseContactId(contactId: Long)` Return `true` if a contact ID is from the contacts provider on the managed profile.
open static Uri!	`lookupContact(resolver: ContentResolver!, lookupUri: Uri!)` Computes a content URI (see `CONTENT_URI`) given a lookup URI.
open static Unit	`markAsContacted(resolver: ContentResolver!, contactId: Long)` Mark a contact as having been contacted.
open static InputStream!	`openContactPhotoInputStream(cr: ContentResolver!, contactUri: Uri!)` Opens an InputStream for the contacts's thumbnail photo and returns the photo as a byte stream.
open static InputStream!	`openContactPhotoInputStream(cr: ContentResolver!, contactUri: Uri!, preferHighres: Boolean)` Opens an InputStream for the contacts's photo and returns the photo as a byte stream.

Properties
static Uri!	`CONTENT_FILTER_URI` The content:// style URI used for "type-to-filter" functionality on the `CONTENT_URI` URI.
static Uri!	`CONTENT_FREQUENT_URI` The content:// style URI for showing a list of frequently contacted people.
static Uri!	`CONTENT_GROUP_URI`
static Uri!	`CONTENT_LOOKUP_URI` A content:// style URI for this table that should be used to create shortcuts or otherwise create long-term links to contacts.
static Uri!	`CONTENT_MULTI_VCARD_URI` Base `Uri` for referencing multiple `Contacts` entry, created by appending `LOOKUP_KEY` using `Uri.withAppendedPath(Uri, String)`.
static Uri!	`CONTENT_STREQUENT_FILTER_URI` The content:// style URI used for "type-to-filter" functionality on the `CONTENT_STREQUENT_URI` URI.
static Uri!	`CONTENT_STREQUENT_URI` The content:// style URI for this table joined with useful data from `ContactsContract.Data`, filtered to include only starred contacts.
static Uri!	`CONTENT_URI` The content:// style URI for this table
static Uri!	`CONTENT_VCARD_URI` Base `Uri` for referencing a single `Contacts` entry, created by appending `LOOKUP_KEY` using `Uri.withAppendedPath(Uri, String)`.
static Uri!	`ENTERPRISE_CONTENT_FILTER_URI` It supports the similar semantics as `CONTENT_FILTER_URI` and returns the same columns.
static Uri	`ENTERPRISE_CONTENT_URI` URI used for getting all contacts from both the calling user and the managed profile that is linked to it.

Constants

CONTENT_ITEM_TYPE

Added in API level 5

static val CONTENT_ITEM_TYPE: String

The MIME type of a CONTENT_URI subdirectory of a single person.

Value: "vnd.android.cursor.item/contact"

CONTENT_TYPE

Added in API level 5

static val CONTENT_TYPE: String

The MIME type of CONTENT_URI providing a directory of people.

Value: "vnd.android.cursor.dir/contact"

CONTENT_VCARD_TYPE

Added in API level 5

static val CONTENT_VCARD_TYPE: String

The MIME type of a CONTENT_URI subdirectory of a single person.

Value: "text/x-vcard"

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"

QUERY_PARAMETER_VCARD_NO_PHOTO

Added in API level 23

static val QUERY_PARAMETER_VCARD_NO_PHOTO: String

Boolean parameter that may be used with CONTENT_VCARD_URI and CONTENT_MULTI_VCARD_URI to indicate that the returned vcard should not contain a photo. This is useful for obtaining a space efficient vcard.

Value: "no_photo"

Public methods

getLookupUri

Added in API level 5

open static fun getLookupUri(
    resolver: ContentResolver!, 
    contactUri: Uri!
): Uri!

Builds a CONTENT_LOOKUP_URI style Uri describing the requested Contacts entry.

Parameters
`contactUri`	Uri!: A `CONTENT_URI` row, or an existing `CONTENT_LOOKUP_URI` to attempt refreshing.

getLookupUri

Added in API level 5

open static fun getLookupUri(
    contactId: Long, 
    lookupKey: String!
): Uri!

Build a CONTENT_LOOKUP_URI lookup Uri using the given ContactsContract.Contacts._ID and LOOKUP_KEY.

Returns null if unable to construct a valid lookup URI from the provided parameters.

isEnterpriseContactId

Added in API level 21

open static fun isEnterpriseContactId(contactId: Long): Boolean

Return true if a contact ID is from the contacts provider on the managed profile. PhoneLookup.ENTERPRISE_CONTENT_FILTER_URI and similar APIs may return such IDs.

lookupContact

Added in API level 5

open static fun lookupContact(
    resolver: ContentResolver!, 
    lookupUri: Uri!
): Uri!

Computes a content URI (see CONTENT_URI) given a lookup URI.

Returns null if the contact cannot be found.

markAsContacted

Added in API level 5
Deprecated in API level 16

open static fun markAsContacted(
    resolver: ContentResolver!, 
    contactId: Long
): Unit

Deprecated: Contacts affinity information is no longer supported as of Android version android.os.Build.VERSION_CODES#Q. This method is no-op.

Mark a contact as having been contacted. Updates two fields: TIMES_CONTACTED and LAST_TIME_CONTACTED. The TIMES_CONTACTED field is incremented by 1 and the LAST_TIME_CONTACTED field is populated with the current system time.

Caution: If you publish your app to the Google Play Store, this field is obsolete, regardless of Android version. For more information, see the Contacts Provider page.

Parameters
`resolver`	ContentResolver!: the ContentResolver to use
`contactId`	Long: the person who was contacted

openContactPhotoInputStream

Added in API level 5

open static fun openContactPhotoInputStream(
    cr: ContentResolver!, 
    contactUri: Uri!
): InputStream!

Opens an InputStream for the contacts's thumbnail photo and returns the photo as a byte stream.

Parameters
`cr`	ContentResolver!: The content resolver to use for querying
`contactUri`	Uri!: the contact whose photo should be used. This can be used with either a `CONTENT_URI` or a `CONTENT_LOOKUP_URI` URI.

Return
`InputStream!`	an InputStream of the photo, or null if no photo is present

See Also

#openContactPhotoInputStream(ContentResolver, Uri, boolean)

openContactPhotoInputStream

Added in API level 14

open static fun openContactPhotoInputStream(
    cr: ContentResolver!, 
    contactUri: Uri!, 
    preferHighres: Boolean
): InputStream!

Opens an InputStream for the contacts's photo and returns the photo as a byte stream.

Parameters
`cr`	ContentResolver!: The content resolver to use for querying
`contactUri`	Uri!: the contact whose photo should be used. This can be used with either a `CONTENT_URI` or a `CONTENT_LOOKUP_URI` URI.
`preferHighres`	Boolean: If this is true and the contact has a higher resolution photo available, it is returned. If false, this function always tries to get the thumbnail

Return
`InputStream!`	an InputStream of the photo, or null if no photo is present

Properties

CONTENT_FILTER_URI

Added in API level 5

static val CONTENT_FILTER_URI: Uri!

The content:// style URI used for "type-to-filter" functionality on the CONTENT_URI URI. The filter string will be used to match various parts of the contact name. The filter argument should be passed as an additional path segment after this URI.

CONTENT_FREQUENT_URI

Added in API level 21
Deprecated in API level 29

static val CONTENT_FREQUENT_URI: Uri!

Deprecated: Frequent contacts are no longer supported as of Android version android.os.Build.VERSION_CODES#Q. This URI always returns an empty cursor.

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.

The content:// style URI for showing a list of frequently contacted people.

CONTENT_GROUP_URI

Added in API level 5

static val CONTENT_GROUP_URI: Uri!

CONTENT_LOOKUP_URI

Added in API level 5

static val CONTENT_LOOKUP_URI: Uri!

A content:// style URI for this table that should be used to create shortcuts or otherwise create long-term links to contacts. This URI should always be followed by a "/" and the contact's LOOKUP_KEY. It can optionally also have a "/" and last known contact ID appended after that. This "complete" format is an important optimization and is highly recommended.

As long as the contact's row ID remains the same, this URI is equivalent to CONTENT_URI. If the contact's row ID changes as a result of a sync or aggregation, this URI will look up the contact using indirect information (sync IDs or constituent raw contacts).

Lookup key should be appended unencoded - it is stored in the encoded form, ready for use in a URI.

CONTENT_MULTI_VCARD_URI

Added in API level 21

static val CONTENT_MULTI_VCARD_URI: Uri!

Base Uri for referencing multiple Contacts entry, created by appending LOOKUP_KEY using Uri.withAppendedPath(Uri, String). The lookup keys have to be joined with the colon (":") separator, and the resulting string encoded. Provides OpenableColumns columns when queried, or returns the referenced contact formatted as a vCard when opened through ContentResolver.openAssetFileDescriptor(Uri, String).

Usage example:

The following code snippet creates a multi-vcard URI that references all the contacts in a user's database.

public Uri getAllContactsVcardUri() {
      Cursor cursor = getActivity().getContentResolver().query(Contacts.CONTENT_URI,
          new String[] {Contacts.LOOKUP_KEY}, null, null, null);
      if (cursor == null) {
          return null;
      }
      try {
          StringBuilder uriListBuilder = new StringBuilder();
          int index = 0;
          while (cursor.moveToNext()) {
              if (index != 0) uriListBuilder.append(':');
              uriListBuilder.append(cursor.getString(0));
              index++;
          }
          return Uri.withAppendedPath(Contacts.CONTENT_MULTI_VCARD_URI,
                  Uri.encode(uriListBuilder.toString()));
      } finally {
          cursor.close();
      }
  }

CONTENT_STREQUENT_FILTER_URI

Added in API level 5

static val CONTENT_STREQUENT_FILTER_URI: Uri!

The content:// style URI used for "type-to-filter" functionality on the CONTENT_STREQUENT_URI URI. The filter string will be used to match various parts of the contact name. The filter argument should be passed as an additional path segment after this URI.

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.

CONTENT_STREQUENT_URI

Added in API level 5

static val CONTENT_STREQUENT_URI: Uri!

The content:// style URI for this table joined with useful data from ContactsContract.Data, filtered to include only starred contacts. Frequent contacts are no longer included in the result as of Android version android.os.Build.VERSION_CODES#Q.

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.

CONTENT_URI

Added in API level 5

static val CONTENT_URI: Uri!

The content:// style URI for this table

CONTENT_VCARD_URI

Added in API level 5

static val CONTENT_VCARD_URI: Uri!

Base Uri for referencing a single Contacts entry, created by appending LOOKUP_KEY using Uri.withAppendedPath(Uri, String). Provides OpenableColumns columns when queried, or returns the referenced contact formatted as a vCard when opened through ContentResolver.openAssetFileDescriptor(Uri, String).

ENTERPRISE_CONTENT_FILTER_URI

Added in API level 24

static val ENTERPRISE_CONTENT_FILTER_URI: Uri!

It supports the similar semantics as CONTENT_FILTER_URI and returns the same columns. This URI requires ContactsContract.DIRECTORY_PARAM_KEY in parameters, otherwise it will throw IllegalArgumentException. The passed directory can belong either to the calling user or to a managed profile that is linked to it.

ENTERPRISE_CONTENT_URI

Added in API level 34

static val ENTERPRISE_CONTENT_URI: Uri

URI used for getting all contacts from both the calling user and the managed profile that is linked to it.

It supports the same semantics as CONTENT_URI and returns the same columns.
If the calling user has no managed profile, it behaves in the exact same way as CONTENT_URI.
If there is a managed profile linked to the calling user, it will return merged results from both.

Note: this query returns the calling user results before the managed profile results, and this order is not affected by the sorting parameter.

If a result is from the managed profile, the following changes are made to the data:

PHOTO_THUMBNAIL_URI and PHOTO_URI will be rewritten to special URIs. Use android.content.ContentResolver#openAssetFileDescriptor or its siblings to load pictures from them.
PHOTO_ID and PHOTO_FILE_ID will be set to null. Don't use them.
_ID and LOOKUP_KEY will be replaced with artificial values. These values will be consistent across multiple queries, but do not use them in places that do not explicitly say they accept them. If they are used in the selection param in android.content.ContentProvider#query, the result is undefined.
In order to tell whether a contact is from the managed profile, use ContactsContract.Contacts.isEnterpriseContactId(long).