public final class

ContactsContract

extends Object

java.lang.Object
↳	android.provider.ContactsContract

Class Overview

The contract between the contacts provider and applications. Contains definitions for the supported URIs and columns. These APIs supersede ContactsContract.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 ContactsContract.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 ContactsContract.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 ContactsContract.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:

ContactsContract.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.
ContactsContract.StatusUpdates , which contains social status updates including IM availability.
ContactsContract.AggregationExceptions , which is used for manual aggregation and disaggregation of raw contacts
ContactsContract.Settings , which contains visibility and sync settings for accounts and groups.
ContactsContract.SyncState , which contains free-form data maintained on behalf of sync adapters
ContactsContract.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 `ContactsContract.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	API allowing applications to send usage information for each `ContactsContract.Contacts.Data` row to the Contacts Provider.
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.
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.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 `ContactsContract.ContactStatusColumns` to link back to specific `_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.QuickContact	Helper methods to display QuickContact dialogs that allow users to pivot on 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.Settings	Contacts-specific settings for various `Account` 's.
interface	ContactsContract.SettingsColumns
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.
class	ContactsContract.StreamItemPhotos	Constants for the stream_item_photos table, which contains photos associated with social stream updates.
interface	ContactsContract.StreamItemPhotosColumns	Columns in the StreamItemPhotos table.
class	ContactsContract.StreamItems	Constants for the stream_items table, which contains social stream updates from the user's contact list.
interface	ContactsContract.StreamItemsColumns	Columns in the StreamItems table.
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	DIRECTORY_PARAM_KEY	Query parameter that should be used by the client to access a specific `ContactsContract.Directory` .
String	LIMIT_PARAM_KEY	A query parameter that limits the number of results returned.
String	PRIMARY_ACCOUNT_NAME	A query parameter specifing a primary account.
String	PRIMARY_ACCOUNT_TYPE	A query parameter specifing a primary account.

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.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone () Creates and returns a copy of this `Object` .
boolean	equals ( Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize () Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class <?>	getClass () Returns the unique instance of `Class` that represents this object's class.
int	hashCode () Returns an integer hash code for this object.
final void	notify () Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll () Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString () Returns a string containing a concise, human-readable description of this object.
final void	wait () Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait (long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait (long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Constants

public static final String AUTHORITY

Added in API level 5

The authority for the contacts provider

Constant Value: "com.android.contacts"

public static final String CALLER_IS_SYNCADAPTER

Added in API level 5

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 DIRTY is not automatically set and the "syncToNetwork" parameter is set to false when calling notifyChange(android.net.Uri, android.database.ContentObserver, boolean) . This prevents an unnecessary extra synchronization, see the discussion of the delete operation in ContactsContract.RawContacts .

Constant Value: "caller_is_syncadapter"

public static final String DIRECTORY_PARAM_KEY

Added in API level 11

Query parameter that should be used by the client to access a specific ContactsContract.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"

public static final String LIMIT_PARAM_KEY

Added in API level 11

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

Constant Value: "limit"

public static final String PRIMARY_ACCOUNT_NAME

Added in API level 14

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"

public static final String PRIMARY_ACCOUNT_TYPE

Added in API level 14

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"

Fields

public static final Uri AUTHORITY_URI

Added in API level 5

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

Public Constructors

public ContactsContract ()

Added in API level 5

Public Methods

public static boolean isProfileId (long id)

Added in API level 14

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	The ID to check.

Returns

Whether the ID is associated with profile data.

Results

Interfaces

Classes

Exceptions

ContactsContract

Class Overview

Overview

Summary

Constants

public static final String AUTHORITY

public static final String CALLER_IS_SYNCADAPTER

public static final String DIRECTORY_PARAM_KEY

public static final String LIMIT_PARAM_KEY

public static final String PRIMARY_ACCOUNT_NAME

public static final String PRIMARY_ACCOUNT_TYPE

Fields

public static final Uri AUTHORITY_URI

Public Constructors

public ContactsContract ()

Public Methods

public static boolean isProfileId (long id)

Parameters

Returns