Added in API level 5

Summary: Nested Classes | Constants | Fields | Ctors | Methods | Inherited Methods

ContactsContract

---

Kotlin |Java

public final class ContactsContract
extends Object

java.lang.Object
↳	android.provider.ContactsContract

---

The contract between the contacts provider and applications. Contains definitions for the supported URIs and columns. These APIs supersede Contacts.

Overview

ContactsContract defines an extensible database of contact-related information. Contact information is stored in a three-tier data model:

• A row in the Data table can store any kind of personal data, such as a phone number or email addresses. The set of data kinds that can be stored in this table is open-ended. There is a predefined set of common kinds, but any application can add its own data kinds.
• A row in the RawContacts table represents a set of data describing a person and associated with a single account (for example, one of the user's Gmail accounts).
• A row in the Contacts table represents an aggregate of one or more RawContacts presumably describing the same person. When data in or associated with the RawContacts table is changed, the affected aggregate contacts are updated as necessary.

Other tables include:

• Groups, which contains information about raw contact groups such as Gmail contact groups. The current API does not support the notion of groups spanning multiple accounts.
• StatusUpdates, which contains social status updates including IM availability.
• AggregationExceptions, which is used for manual aggregation and disaggregation of raw contacts
• Settings, which contains visibility and sync settings for accounts and groups.
• SyncState, which contains free-form data maintained on behalf of sync adapters
• PhoneLookup, which is used for quick caller-ID lookup

Summary

Nested classes
class	ContactsContract.AggregationExceptions Constants for the contact aggregation exceptions table, which contains aggregation rules overriding those used by automatic aggregation.
interface	ContactsContract.BaseSyncColumns Generic columns for use by sync adapters.
class	ContactsContract.CommonDataKinds Container for definitions of common data types stored in the ContactsContract.Data table.
interface	ContactsContract.ContactNameColumns Contact name and contact name metadata columns in the RawContacts table.
interface	ContactsContract.ContactOptionsColumns Columns of ContactsContract.Contacts that track the user's preferences for, or interactions with, the contact.
interface	ContactsContract.ContactStatusColumns
class	ContactsContract.Contacts Constants for the contacts table, which contains a record per aggregate of raw contacts representing the same person.
interface	ContactsContract.ContactsColumns Columns of ContactsContract.Contacts that refer to intrinsic properties of the contact, as opposed to the user-specified options found in ContactOptionsColumns.
class	ContactsContract.Data Constants for the data table, which contains data points tied to a raw contact.
interface	ContactsContract.DataColumns Columns in the Data table.
interface	ContactsContract.DataColumnsWithJoins Combines all columns returned by ContactsContract.Data table queries.
class	ContactsContract.DataUsageFeedback This class was deprecated in API level 29. Contacts affinity information is no longer supported as of Android version Build.VERSION_CODES.Q. Both update and delete calls are always ignored.
interface	ContactsContract.DataUsageStatColumns Columns in the Data_Usage_Stat table
class	ContactsContract.DeletedContacts Constants for the deleted contact table.
interface	ContactsContract.DeletedContactsColumns
class	ContactsContract.Directory A Directory represents a contacts corpus, e.g. Local contacts, Google Apps Global Address List or Corporate Global Address List.
interface	ContactsContract.DisplayNameSources Types of data used to produce the display name for a contact.
class	ContactsContract.DisplayPhoto Helper class for accessing full-size photos by photo file ID.
interface	ContactsContract.FullNameStyle Constants for various styles of combining given name, family name etc into a full name.
class	ContactsContract.Groups Constants for the groups table.
interface	ContactsContract.GroupsColumns
class	ContactsContract.Intents Contains helper classes used to create or manage Intents that involve contacts.
class	ContactsContract.PhoneLookup A table that represents the result of looking up a phone number, for example for caller ID.
interface	ContactsContract.PhoneLookupColumns
interface	ContactsContract.PhoneticNameStyle Constants for various styles of capturing the pronunciation of a person's name.
class	ContactsContract.PinnedPositions Contact-specific information about whether or not a contact has been pinned by the user at a particular position within the system contact application's user interface.
class	ContactsContract.Presence This class was deprecated in API level 5. This old name was never meant to be made public. Do not use.
interface	ContactsContract.PresenceColumns Additional data mixed in with StatusColumns to link back to specific ContactsContract.Data#_ID entries.
class	ContactsContract.Profile Constants for the user's profile data, which is represented as a single contact on the device that represents the user.
class	ContactsContract.ProfileSyncState A table provided for sync adapters to use for storing private sync state data for the user's personal profile.
class	ContactsContract.ProviderStatus API for inquiring about the general status of the provider.
class	ContactsContract.QuickContact Helper methods to display QuickContact dialogs that display all the information belonging to a specific Contacts entry.
class	ContactsContract.RawContacts Constants for the raw contacts table, which contains one row of contact information for each person in each synced account.
interface	ContactsContract.RawContactsColumns
class	ContactsContract.RawContactsEntity Constants for the raw contacts entities table, which can be thought of as an outer join of the raw_contacts table with the data table.
class	ContactsContract.SearchSnippets Additional column returned by Contacts.CONTENT_FILTER_URI explaining why the filter matched the contact.
class	ContactsContract.Settings Contacts-specific settings for various Account's.
interface	ContactsContract.SettingsColumns
class	ContactsContract.SimAccount A parcelable class encapsulating account data for contacts that originate from a SIM card.
class	ContactsContract.SimContacts Class containing utility methods around determine what accounts in the ContactsProvider are related to the SIM cards in the device.
interface	ContactsContract.StatusColumns Social status update columns.
class	ContactsContract.StatusUpdates A status update is linked to a ContactsContract.Data row and captures the user's latest status update via the corresponding source, e.g.
interface	ContactsContract.SyncColumns Columns that appear when each row of a table belongs to a specific account, including sync information that an account may need.
class	ContactsContract.SyncState A table provided for sync adapters to use for storing private sync state data for contacts.

Constants
String	AUTHORITY The authority for the contacts provider
String	CALLER_IS_SYNCADAPTER An optional URI parameter for insert, update, or delete queries that allows the caller to specify that it is a sync adapter.
String	DEFERRED_SNIPPETING A key to a boolean in the "extras" bundle of the cursor.
String	DEFERRED_SNIPPETING_QUERY Key to retrieve the original deferred snippeting from the cursor on the client side.
String	DIRECTORY_PARAM_KEY Query parameter that should be used by the client to access a specific Directory.
String	LIMIT_PARAM_KEY A query parameter that limits the number of results returned for supported URIs.
String	PRIMARY_ACCOUNT_NAME A query parameter specifing a primary account.
String	PRIMARY_ACCOUNT_TYPE A query parameter specifing a primary account.
String	REMOVE_DUPLICATE_ENTRIES A boolean parameter for Phone.CONTENT_URI, Email.CONTENT_URI, and StructuredPostal.CONTENT_URI.
String	STREQUENT_PHONE_ONLY A boolean parameter for Contacts#CONTENT_STREQUENT_URI and Contacts#CONTENT_STREQUENT_FILTER_URI, which requires the ContactsProvider to return only phone-related results.

Fields
public static final Uri	AUTHORITY_URI A content:// style uri to the authority for the contacts provider

Public constructors
ContactsContract()

Public methods
static boolean	isProfileId(long id) This method can be used to identify whether the given ID is associated with profile data.

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

AUTHORITY

Added in API level 5

public static final String AUTHORITY

The authority for the contacts provider

Constant Value: "com.android.contacts"

CALLER_IS_SYNCADAPTER

Added in API level 5

public static final String CALLER_IS_SYNCADAPTER

An optional URI parameter for insert, update, or delete queries that allows the caller to specify that it is a sync adapter. The default value is false. If true RawContacts#DIRTY is not automatically set and the "syncToNetwork" parameter is set to false when calling ContentResolver.notifyChange(android.net.Uri, android.database.ContentObserver, boolean). This prevents an unnecessary extra synchronization, see the discussion of the delete operation in RawContacts.

Constant Value: "caller_is_syncadapter"

DEFERRED_SNIPPETING

Added in API level 21

public static final String DEFERRED_SNIPPETING

A key to a boolean in the "extras" bundle of the cursor. The boolean indicates that the provider did not create a snippet and that the client asking for the snippet should do it (true means the snippeting was deferred to the client).

See also:

• ContactsContract.SearchSnippets

Constant Value: "deferred_snippeting"

DEFERRED_SNIPPETING_QUERY

Added in API level 21

public static final String DEFERRED_SNIPPETING_QUERY

Key to retrieve the original deferred snippeting from the cursor on the client side.

See also:

• ContactsContract.SearchSnippets
• DEFERRED_SNIPPETING

Constant Value: "deferred_snippeting_query"

DIRECTORY_PARAM_KEY

Added in API level 11

public static final String DIRECTORY_PARAM_KEY

Query parameter that should be used by the client to access a specific Directory. The parameter value should be the _ID of the corresponding directory, e.g. content://com.android.contacts/data/emails/filter/acme?directory=3

Constant Value: "directory"

LIMIT_PARAM_KEY

Added in API level 11

public static final String LIMIT_PARAM_KEY

A query parameter that limits the number of results returned for supported URIs. The parameter value should be an integer.

This parameter is not supported by all URIs. Supported URIs include, but not limited to, Contacts#CONTENT_URI, RawContacts#CONTENT_URI, Data#CONTENT_URI, ContactsContract.CommonDataKinds.Phone.CONTENT_URI, ContactsContract.CommonDataKinds.Callable.CONTENT_URI, ContactsContract.CommonDataKinds.Email.CONTENT_URI, ContactsContract.CommonDataKinds.Contactables.CONTENT_URI,

In order to limit the number of rows returned by a non-supported URI, you can implement a CursorWrapper and override the CursorWrapper#getCount() methods.

Constant Value: "limit"

PRIMARY_ACCOUNT_NAME

Added in API level 14

public static final String PRIMARY_ACCOUNT_NAME

A query parameter specifing a primary account. This parameter should be used with PRIMARY_ACCOUNT_TYPE. The contacts provider handling a query may rely on this information to optimize its query results. For example, in an email composition screen, its implementation can specify an account when obtaining possible recipients, letting the provider know which account is selected during the composition. The provider may use the "primary account" information to optimize the search result.

Constant Value: "name_for_primary_account"

PRIMARY_ACCOUNT_TYPE

Added in API level 14

public static final String PRIMARY_ACCOUNT_TYPE

A query parameter specifing a primary account. This parameter should be used with PRIMARY_ACCOUNT_NAME. See the doc in PRIMARY_ACCOUNT_NAME.

Constant Value: "type_for_primary_account"

REMOVE_DUPLICATE_ENTRIES

Added in API level 21

public static final String REMOVE_DUPLICATE_ENTRIES

A boolean parameter for Phone.CONTENT_URI, Email.CONTENT_URI, and StructuredPostal.CONTENT_URI. This enables a content provider to remove duplicate entries in results.

Constant Value: "remove_duplicate_entries"

STREQUENT_PHONE_ONLY

Added in API level 21

public static final String STREQUENT_PHONE_ONLY

A boolean parameter for Contacts#CONTENT_STREQUENT_URI and Contacts#CONTENT_STREQUENT_FILTER_URI, which requires the ContactsProvider to return only phone-related results.

Constant Value: "strequent_phone_only"

Fields

AUTHORITY_URI

Added in API level 5

public static final Uri AUTHORITY_URI

A content:// style uri to the authority for the contacts provider

Public constructors

ContactsContract

public ContactsContract ()

Public methods

isProfileId

Added in API level 14

public static boolean isProfileId (long id)

This method can be used to identify whether the given ID is associated with profile data. It does not necessarily indicate that the ID is tied to valid data, merely that accessing data using this ID will result in profile access checks and will only return data from the profile.

Parameters
id	long: The ID to check.

Returns
boolean	Whether the ID is associated with profile data.