ContactsContract.Contacts.Entity

public static final class ContactsContract.Contacts.Entity
extends Object implements BaseColumns, ContactsContract.ContactsColumns, ContactsContract.ContactNameColumns, ContactsContract.RawContactsColumns, ContactsContract.BaseSyncColumns, ContactsContract.SyncColumns, ContactsContract.DataColumns, ContactsContract.StatusColumns, ContactsContract.ContactOptionsColumns, ContactsContract.ContactStatusColumns, ContactsContract.DataUsageStatColumns

java.lang.Object
   ↳ android.provider.ContactsContract.Contacts.Entity


A sub-directory of a contact that contains all of its ContactsContract.RawContacts as well as ContactsContract.Data rows. To access this directory append CONTENT_DIRECTORY to the contact URI.

Entity has three ID fields: ContactsContract.RawContactsColumns.CONTACT_ID for the contact, RAW_CONTACT_ID for the raw contact and DATA_ID for the data rows. Entity always contains at least one row per constituent raw contact, even if there are no actual data rows. In this case the DATA_ID field will be null.

Entity reads all data for the entire contact in one transaction, to guarantee consistency. There is significant data duplication in the Entity (each row repeats all Contact columns and all RawContact columns), so the benefits of transactional consistency should be weighed against the cost of transferring large amounts of denormalized data from the Provider.

To reduce the amount of data duplication the contacts provider and directory providers implementing this protocol are allowed to provide common Contacts and RawContacts fields in the first row returned for each raw contact only and leave them as null in subsequent rows.

Summary

Constants

String CONTENT_DIRECTORY

The directory twig for this sub-table

String DATA_ID

The ID of the data row.

String RAW_CONTACT_ID

The ID of the raw contact row.

Inherited constants

Inherited methods

Constants

CONTENT_DIRECTORY

Added in API level 11
public static final String CONTENT_DIRECTORY

The directory twig for this sub-table

Constant Value: "entities"

DATA_ID

Added in API level 11
public static final String DATA_ID

The ID of the data row. The value will be null if this raw contact has no data rows.

Type: INTEGER

Constant Value: "data_id"

RAW_CONTACT_ID

Added in API level 11
public static final String RAW_CONTACT_ID

The ID of the raw contact row.

Type: INTEGER

Constant Value: "raw_contact_id"