Added in API level 5

Summary: Constants | Inherited Constants | Fields | Methods | Inherited Methods

ContactsContract.Data

Kotlin |Java

public static final class ContactsContract.Data
extends Object implements ContactsContract.DataColumnsWithJoins

java.lang.Object
↳	android.provider.ContactsContract.Data

Constants for the data table, which contains data points tied to a raw contact. Each row of the data table is typically used to store a single piece of contact information (such as a phone number) and its associated metadata (such as whether it is a work or home number).

Data kinds

Data is a generic table that can hold any kind of contact data. The kind of data stored in a given row is specified by the row's ContactsContract.DataColumns.MIMETYPE value, which determines the meaning of the generic columns ContactsContract.DataColumns.DATA1 through ContactsContract.DataColumns.DATA15. For example, if the data kind is Phone.CONTENT_ITEM_TYPE, then the column ContactsContract.DataColumns.DATA1 stores the phone number, but if the data kind is Email.CONTENT_ITEM_TYPE, then ContactsContract.DataColumns.DATA1 stores the email address. Sync adapters and applications can introduce their own data kinds.

ContactsContract defines a small number of pre-defined data kinds, e.g. CommonDataKinds.Phone, CommonDataKinds.Email etc. As a convenience, these classes define data kind specific aliases for DATA1 etc. For example, Phone.NUMBER is the same as Data.DATA1.

ContactsContract.DataColumns.DATA1 is an indexed column and should be used for the data element that is expected to be most frequently used in query selections. For example, in the case of a row representing email addresses ContactsContract.DataColumns.DATA1 should probably be used for the email address itself, while ContactsContract.DataColumns.DATA2 etc can be used for auxiliary information like type of email address.

By convention, ContactsContract.DataColumns.DATA15 is used for storing BLOBs (binary data).

The sync adapter for a given account type must correctly handle every data type used in the corresponding raw contacts. Otherwise it could result in lost or corrupted data.

Similarly, you should refrain from introducing new kinds of data for an other party's account types. For example, if you add a data row for "favorite song" to a raw contact owned by a Google account, it will not get synced to the server, because the Google sync adapter does not know how to handle this data kind. Thus new data kinds are typically introduced along with new account types, i.e. new sync adapters.

Batch operations

Data rows can be inserted/updated/deleted using the traditional ContentResolver#insert, ContentResolver#update and ContentResolver#delete methods, however the newer mechanism based on a batch of ContentProviderOperation will prove to be a better choice in almost all cases. All operations in a batch are executed in a single transaction, which ensures that the phone-side and server-side state of a raw contact are always consistent. Also, the batch-based approach is far more efficient: not only are the database operations faster when executed in a single transaction, but also sending a batch of commands to the content provider saves a lot of time on context switching between your process and the process in which the content provider runs.

The flip side of using batched operations is that a large batch may lock up the database for a long time preventing other applications from accessing data and potentially causing ANRs ("Application Not Responding" dialogs.)

To avoid such lockups of the database, make sure to insert "yield points" in the batch. A yield point indicates to the content provider that before executing the next operation it can commit the changes that have already been made, yield to other requests, open another transaction and continue processing operations. A yield point will not automatically commit the transaction, but only if there is another request waiting on the database. Normally a sync adapter should insert a yield point at the beginning of each raw contact operation sequence in the batch. See ContentProviderOperation.Builder#withYieldAllowed(boolean).

Operations

Insert

An individual data row can be inserted using the traditional ContentResolver#insert(Uri, ContentValues) method. Multiple rows should always be inserted as a batch.

An example of a traditional insert:

 ContentValues values = new ContentValues();
 values.put(Data.RAW_CONTACT_ID, rawContactId);
 values.put(Data.MIMETYPE, Phone.CONTENT_ITEM_TYPE);
 values.put(Phone.NUMBER, "1-800-GOOG-411");
 values.put(Phone.TYPE, Phone.TYPE_CUSTOM);
 values.put(Phone.LABEL, "free directory assistance");
 Uri dataUri = getContentResolver().insert(Data.CONTENT_URI, values);

The same done using ContentProviderOperations:

 ArrayList<ContentProviderOperation> ops =
          new ArrayList<ContentProviderOperation>();

 ops.add(ContentProviderOperation.newInsert(Data.CONTENT_URI)
          .withValue(Data.RAW_CONTACT_ID, rawContactId)
          .withValue(Data.MIMETYPE, Phone.CONTENT_ITEM_TYPE)
          .withValue(Phone.NUMBER, "1-800-GOOG-411")
          .withValue(Phone.TYPE, Phone.TYPE_CUSTOM)
          .withValue(Phone.LABEL, "free directory assistance")
          .build());
 getContentResolver().applyBatch(ContactsContract.AUTHORITY, ops);

Update

Just as with insert, update can be done incrementally or as a batch, the batch mode being the preferred method:

 ArrayList<ContentProviderOperation> ops =
          new ArrayList<ContentProviderOperation>();

 ops.add(ContentProviderOperation.newUpdate(Data.CONTENT_URI)
          .withSelection(Data._ID + "=?", new String[]{String.valueOf(dataId)})
          .withValue(Email.DATA, "somebody@android.com")
          .build());
 getContentResolver().applyBatch(ContactsContract.AUTHORITY, ops);

Delete

Just as with insert and update, deletion can be done either using the ContentResolver#delete method or using a ContentProviderOperation:

 ArrayList<ContentProviderOperation> ops =
          new ArrayList<ContentProviderOperation>();

 ops.add(ContentProviderOperation.newDelete(Data.CONTENT_URI)
          .withSelection(Data._ID + "=?", new String[]{String.valueOf(dataId)})
          .build());
 getContentResolver().applyBatch(ContactsContract.AUTHORITY, ops);

Query

Finding all Data of a given type for a given contact

 Cursor c = getContentResolver().query(Data.CONTENT_URI,
          new String[] {Data._ID, Phone.NUMBER, Phone.TYPE, Phone.LABEL},
          Data.CONTACT_ID + "=?" + " AND "
                  + Data.MIMETYPE + "='" + Phone.CONTENT_ITEM_TYPE + "'",
          new String[] {String.valueOf(contactId)}, null);

Finding all Data of a given type for a given raw contact

 Cursor c = getContentResolver().query(Data.CONTENT_URI,
          new String[] {Data._ID, Phone.NUMBER, Phone.TYPE, Phone.LABEL},
          Data.RAW_CONTACT_ID + "=?" + " AND "
                  + Data.MIMETYPE + "='" + Phone.CONTENT_ITEM_TYPE + "'",
          new String[] {String.valueOf(rawContactId)}, null);

Finding all Data for a given raw contact

Most sync adapters will want to read all data rows for a raw contact along with the raw contact itself. For that you should use the RawContactsEntity. See also RawContacts.

Columns

Many columns are available via a Data#CONTENT_URI query. For best performance you should explicitly specify a projection to only those columns that you need.

Data
long	`BaseColumns._ID`	read-only	Row ID. Sync adapter should try to preserve row IDs during updates. In other words, it would be a bad idea to delete and reinsert a data row. A sync adapter should always do an update instead.
String	`ContactsContract.DataColumns.MIMETYPE`	read/write-once	The MIME type of the item represented by this row. Examples of common MIME types are: `StructuredName.CONTENT_ITEM_TYPE` `Phone.CONTENT_ITEM_TYPE` `Email.CONTENT_ITEM_TYPE` `Photo.CONTENT_ITEM_TYPE` `Organization.CONTENT_ITEM_TYPE` `Im.CONTENT_ITEM_TYPE` `Nickname.CONTENT_ITEM_TYPE` `Note.CONTENT_ITEM_TYPE` `StructuredPostal.CONTENT_ITEM_TYPE` `GroupMembership.CONTENT_ITEM_TYPE` `Website.CONTENT_ITEM_TYPE` `Event.CONTENT_ITEM_TYPE` `Relation.CONTENT_ITEM_TYPE` `SipAddress.CONTENT_ITEM_TYPE`
long	`ContactsContract.DataColumns.RAW_CONTACT_ID`	read/write-once	The id of the row in the `RawContacts` table that this data belongs to.
int	`ContactsContract.DataColumns.IS_PRIMARY`	read/write	Whether this is the primary entry of its kind for the raw contact it belongs to. "1" if true, "0" if false.
int	`ContactsContract.DataColumns.IS_SUPER_PRIMARY`	read/write	Whether this is the primary entry of its kind for the aggregate contact it belongs to. Any data record that is "super primary" must also be "primary". For example, the super-primary entry may be interpreted as the default contact value of its kind (for example, the default phone number to use for the contact).
int	`ContactsContract.DataColumns.DATA_VERSION`	read-only	The version of this data record. Whenever the data row changes the version goes up. This value is monotonically increasing.
Any type	`ContactsContract.DataColumns.DATA1` `ContactsContract.DataColumns.DATA2` `ContactsContract.DataColumns.DATA3` `ContactsContract.DataColumns.DATA4` `ContactsContract.DataColumns.DATA5` `ContactsContract.DataColumns.DATA6` `ContactsContract.DataColumns.DATA7` `ContactsContract.DataColumns.DATA8` `ContactsContract.DataColumns.DATA9` `ContactsContract.DataColumns.DATA10` `ContactsContract.DataColumns.DATA11` `ContactsContract.DataColumns.DATA12` `ContactsContract.DataColumns.DATA13` `ContactsContract.DataColumns.DATA14` `ContactsContract.DataColumns.DATA15`	read/write	Generic data columns. The meaning of each column is determined by the `ContactsContract.DataColumns.MIMETYPE`. By convention, `ContactsContract.DataColumns.DATA15` is used for storing BLOBs (binary data). Data columns whose meaning is not explicitly defined for a given MIMETYPE should not be used. There is no guarantee that any sync adapter will preserve them. Sync adapters themselves should not use such columns either, but should instead use `ContactsContract.DataColumns.SYNC1`-`ContactsContract.DataColumns.SYNC4`.
Any type	`ContactsContract.DataColumns.SYNC1` `ContactsContract.DataColumns.SYNC2` `ContactsContract.DataColumns.SYNC3` `ContactsContract.DataColumns.SYNC4`	read/write	Generic columns for use by sync adapters. For example, a Photo row may store the image URL in SYNC1, a status (not loaded, loading, loaded, error) in SYNC2, server-side version number in SYNC3 and error code in SYNC4.

Some columns from the most recent associated status update are also available through an implicit join.

Join with `StatusUpdates`
int	`ContactsContract.StatusColumns.PRESENCE`	read-only	IM presence status linked to this data row. Compare with `ContactsContract.ContactStatusColumns.CONTACT_PRESENCE`, which contains the contact's presence across all IM rows. See `StatusUpdates` for individual status definitions. 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	`ContactsContract.StatusColumns.STATUS`	read-only	Latest status update linked with this data row.
long	`ContactsContract.StatusColumns.STATUS_TIMESTAMP`	read-only	The absolute time in milliseconds when the latest status was inserted/updated for this data row.
String	`ContactsContract.StatusColumns.STATUS_RES_PACKAGE`	read-only	The package containing resources for this status: label and icon.
long	`ContactsContract.StatusColumns.STATUS_LABEL`	read-only	The resource ID of the label describing the source of status update linked to this data row. This resource is scoped by the `ContactsContract.StatusColumns.STATUS_RES_PACKAGE`.
long	`ContactsContract.StatusColumns.STATUS_ICON`	read-only	The resource ID of the icon for the source of the status update linked to this data row. This resource is scoped by the `ContactsContract.StatusColumns.STATUS_RES_PACKAGE`.

Some columns from the associated raw contact are also available through an implicit join. The other columns are excluded as uninteresting in this context.

Join with `ContactsContract.RawContacts`
long	`ContactsContract.RawContactsColumns.CONTACT_ID`	read-only	The id of the row in the `Contacts` table that this data belongs to.
int	`ContactsContract.RawContactsColumns.AGGREGATION_MODE`	read-only	See `RawContacts`.
int	`ContactsContract.RawContactsColumns.DELETED`	read-only	See `RawContacts`.

The ID column for the associated aggregated contact table ContactsContract.Contacts is available via the implicit join to the RawContacts table, see above. The remaining columns from this table are also available, through an implicit join. This facilitates lookup by the value of a single data element, such as the email address.

Join with `ContactsContract.Contacts`
String	`ContactsContract.ContactsColumns.LOOKUP_KEY`	read-only	See `ContactsContract.Contacts`
String	`ContactsContract.ContactsColumns.DISPLAY_NAME`	read-only	See `ContactsContract.Contacts`
long	`ContactsContract.ContactsColumns.PHOTO_ID`	read-only	See `ContactsContract.Contacts`.
int	`ContactsContract.ContactsColumns.IN_VISIBLE_GROUP`	read-only	See `ContactsContract.Contacts`.
int	`ContactsContract.ContactsColumns.HAS_PHONE_NUMBER`	read-only	See `ContactsContract.Contacts`.
int	`ContactsContract.ContactOptionsColumns.STARRED`	read-only	See `ContactsContract.Contacts`.
String	`ContactsContract.ContactOptionsColumns.CUSTOM_RINGTONE`	read-only	See `ContactsContract.Contacts`.
int	`ContactsContract.ContactOptionsColumns.SEND_TO_VOICEMAIL`	read-only	See `ContactsContract.Contacts`.
int	`ContactsContract.ContactStatusColumns.CONTACT_PRESENCE`	read-only	See `ContactsContract.Contacts`.
String	`ContactsContract.ContactStatusColumns.CONTACT_STATUS`	read-only	See `ContactsContract.Contacts`.
long	`ContactsContract.ContactStatusColumns.CONTACT_STATUS_TIMESTAMP`	read-only	See `ContactsContract.Contacts`.
String	`ContactsContract.ContactStatusColumns.CONTACT_STATUS_RES_PACKAGE`	read-only	See `ContactsContract.Contacts`.
long	`ContactsContract.ContactStatusColumns.CONTACT_STATUS_LABEL`	read-only	See `ContactsContract.Contacts`.
long	`ContactsContract.ContactStatusColumns.CONTACT_STATUS_ICON`	read-only	See `ContactsContract.Contacts`.

Summary

Constants
`String`	`CONTENT_TYPE` The MIME type of the results from `CONTENT_URI`.
`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 `Data#CONTENT_URI`.

Inherited constants

From interface android.provider.BaseColumns

`String`	`_COUNT` The count of rows in a directory.
`String`	`_ID` The unique ID for a row.

From interface android.provider.ContactsContract.DataColumns

`String`	`CARRIER_PRESENCE` This constant was deprecated in API level 31. The contacts database will only show presence information on devices where `CarrierConfigManager.KEY_USE_RCS_PRESENCE_BOOL` is true, otherwise use `RcsUceAdapter`.
`int`	`CARRIER_PRESENCE_VT_CAPABLE` This constant was deprecated in API level 31. Same as `DataColumns#CARRIER_PRESENCE`.
`String`	`DATA1` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA10` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA11` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA12` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA13` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA14` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA15` Generic data column, the meaning is `MIMETYPE` specific.
`String`	`DATA2` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA3` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA4` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA5` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA6` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA7` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA8` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA9` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA_VERSION` The version of this data record.
`String`	`IS_PRIMARY` Whether this is the primary entry of its kind for the raw contact it belongs to.
`String`	`IS_READ_ONLY` The "read-only" flag: "0" by default, "1" if the row cannot be modified or deleted except by a sync adapter.
`String`	`IS_SUPER_PRIMARY` Whether this is the primary entry of its kind for the aggregate contact it belongs to.
`String`	`MIMETYPE` The MIME type of the item represented by this row.
`String`	`PREFERRED_PHONE_ACCOUNT_COMPONENT_NAME` The flattened `ComponentName` of a `PhoneAccountHandle` that is the preferred `PhoneAccountHandle` to call the contact with.
`String`	`PREFERRED_PHONE_ACCOUNT_ID` The ID of a `PhoneAccountHandle` that is the preferred `PhoneAccountHandle` to call the contact with.
`String`	`RAW_CONTACT_ID` A reference to the `RawContacts#_ID` that this data belongs to.
`String`	`RES_PACKAGE` The package name to use when creating `Resources` objects for this data row.
`String`	`SYNC1` Generic column for use by sync adapters.
`String`	`SYNC2` Generic column for use by sync adapters.
`String`	`SYNC3` Generic column for use by sync adapters.
`String`	`SYNC4` Generic column for use by sync adapters.

From interface android.provider.ContactsContract.StatusColumns

`int`	`AVAILABLE` An allowed value of `PRESENCE`.
`int`	`AWAY` An allowed value of `PRESENCE`.
`int`	`CAPABILITY_HAS_CAMERA` An allowed flag of `CHAT_CAPABILITY`.
`int`	`CAPABILITY_HAS_VIDEO` An allowed flag of `CHAT_CAPABILITY`.
`int`	`CAPABILITY_HAS_VOICE` An allowed flag of `CHAT_CAPABILITY`.
`String`	`CHAT_CAPABILITY` Contact's audio/video chat capability level.
`int`	`DO_NOT_DISTURB` An allowed value of `PRESENCE`.
`int`	`IDLE` An allowed value of `PRESENCE`.
`int`	`INVISIBLE` An allowed value of `PRESENCE`.
`int`	`OFFLINE` An allowed value of `PRESENCE`.
`String`	`PRESENCE` Contact's latest presence level.
`String`	`PRESENCE_CUSTOM_STATUS` This constant was deprecated in API level 15. use `STATUS`
`String`	`PRESENCE_STATUS` This constant was deprecated in API level 15. use `PRESENCE`
`String`	`STATUS` Contact latest status update.
`String`	`STATUS_ICON` The resource ID of the icon for the source of the status update.
`String`	`STATUS_LABEL` The resource ID of the label describing the source of the status update, e.g. "Google Talk".
`String`	`STATUS_RES_PACKAGE` The package containing resources for this status: label and icon.
`String`	`STATUS_TIMESTAMP` The absolute time in milliseconds when the latest status was inserted/updated.

From interface android.provider.ContactsContract.RawContactsColumns

`String`	`ACCOUNT_TYPE_AND_DATA_SET` A concatenation of the account type and data set (delimited by a forward slash) - if the data set is empty, this will be the same as the account type.
`String`	`AGGREGATION_MODE` The aggregation mode for this contact.
`String`	`BACKUP_ID` Persistent unique id for each raw_contact within its account.
`String`	`CONTACT_ID` A reference to the `ContactsContract.Contacts#_ID` that this data belongs to.
`String`	`DATA_SET` The data set within the account that this row belongs to.
`String`	`DELETED` The "deleted" flag: "0" by default, "1" if the row has been marked for deletion.
`String`	`METADATA_DIRTY` This constant was deprecated in API level 30. This column never actually worked since added. It will not supported as of Android version `Build.VERSION_CODES.R`.
`String`	`RAW_CONTACT_IS_READ_ONLY` The "read-only" flag: "0" by default, "1" if the row cannot be modified or deleted except by a sync adapter.
`String`	`RAW_CONTACT_IS_USER_PROFILE` Flag that reflects whether this raw contact belongs to the user's personal profile entry.

From interface android.provider.ContactsContract.ContactsColumns

`String`	`CONTACT_LAST_UPDATED_TIMESTAMP` Timestamp (milliseconds since epoch) of when this contact was last updated.
`String`	`DISPLAY_NAME` The display name for the contact.
`String`	`HAS_PHONE_NUMBER` An indicator of whether this contact has at least one phone number.
`String`	`IN_DEFAULT_DIRECTORY` Flag that reflects whether the contact exists inside the default directory.
`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.
`String`	`PHOTO_FILE_ID` Photo file ID of the full-size photo.
`String`	`PHOTO_ID` Reference to the row in the data table holding the photo.
`String`	`PHOTO_THUMBNAIL_URI` A URI that can be used to retrieve a thumbnail of the contact's photo.
`String`	`PHOTO_URI` A URI that can be used to retrieve the contact's full-size photo.

From interface android.provider.ContactsContract.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.
`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).
`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.
`String`	`PHONETIC_NAME` Pronunciation of the full name in the phonetic alphabet specified by `PHONETIC_NAME_STYLE`.
`String`	`PHONETIC_NAME_STYLE` The phonetic alphabet used to represent the `PHONETIC_NAME`.
`String`	`SORT_KEY_ALTERNATIVE` Sort key based on the alternative representation of the full name, `DISPLAY_NAME_ALTERNATIVE`.
`String`	`SORT_KEY_PRIMARY` Sort key that takes into account locale-based traditions for sorting names in address books.

From interface android.provider.ContactsContract.ContactOptionsColumns

`String`	`CUSTOM_RINGTONE` URI for a custom ringtone associated with the contact.
`String`	`LAST_TIME_CONTACTED` This constant was deprecated in API level 29. Contacts affinity information is no longer supported as of Android version `Build.VERSION_CODES.Q`. This column always contains 0.
`String`	`PINNED` The position at which the contact is pinned.
`String`	`SEND_TO_VOICEMAIL` Whether the contact should always be sent to voicemail.
`String`	`STARRED` Is the contact starred? Type: INTEGER (boolean)
`String`	`TIMES_CONTACTED` This constant was deprecated in API level 29. Contacts affinity information is no longer supported as of Android version `Build.VERSION_CODES.Q`. This column always contains 0.

From interface android.provider.ContactsContract.ContactStatusColumns

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

From interface android.provider.ContactsContract.DataUsageStatColumns

String

LAST_TIME_USED

This constant was deprecated in API level 29. Contacts affinity information is no longer supported as of Android version Build.VERSION_CODES.Q. This column always contains 0.

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.

String

TIMES_USED

This constant was deprecated in API level 29. Contacts affinity information is no longer supported as of Android version Build.VERSION_CODES.Q. This column always contains 0.

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.

Fields
`public static final Uri`	`CONTENT_URI` The content:// style URI for this table, which requests a directory of data rows matching the selection criteria.

Public methods
`static Uri`	`getContactLookupUri(ContentResolver resolver, Uri dataUri)` Build a `ContactsContract.Contacts.CONTENT_LOOKUP_URI` style `Uri` for the parent `ContactsContract.Contacts` entry of the given `ContactsContract.Data` entry.

Public methods


      getContactLookupUri(ContentResolver resolver, Uri dataUri)

Build a ContactsContract.Contacts.CONTENT_LOOKUP_URI style Uri for the parent ContactsContract.Contacts entry of the given ContactsContract.Data entry.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

CONTENT_TYPE

Added in API level 5

public static final String CONTENT_TYPE

The MIME type of the results from CONTENT_URI.

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

EXTRA_ADDRESS_BOOK_INDEX

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

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

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 Data#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_URI

Added in API level 5

public static final Uri CONTENT_URI

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

Public methods

getContactLookupUri

Added in API level 5

public static Uri getContactLookupUri (ContentResolver resolver, 
                Uri dataUri)

Build a ContactsContract.Contacts.CONTENT_LOOKUP_URI style Uri for the parent ContactsContract.Contacts entry of the given ContactsContract.Data entry.

Returns the Uri for the contact in the first entry returned by ContentResolver#query(Uri, String[], String, String[], String) for the provided dataUri. If the query returns null or empty results, silently returns null.

Parameters
`resolver`	`ContentResolver`
`dataUri`	`Uri`

Returns
`Uri`