ContactsContract

Kotlin |Java

class ContactsContract

kotlin.Any
↳	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
	`AggregationExceptions` Constants for the contact aggregation exceptions table, which contains aggregation rules overriding those used by automatic aggregation.
abstract	`BaseSyncColumns` Generic columns for use by sync adapters.
	`CommonDataKinds` Container for definitions of common data types stored in the `ContactsContract.Data` table.
abstract	`ContactNameColumns` Contact name and contact name metadata columns in the RawContacts table.
abstract	`ContactOptionsColumns` Columns of `ContactsContract.Contacts` that track the user's preferences for, or interactions with, the contact.
abstract	`ContactStatusColumns`
	`Contacts` Constants for the contacts table, which contains a record per aggregate of raw contacts representing the same person.
abstract	`ContactsColumns` Columns of `ContactsContract.Contacts` that refer to intrinsic properties of the contact, as opposed to the user-specified options found in `ContactOptionsColumns`.
	`Data` Constants for the data table, which contains data points tied to a raw contact.
abstract	`DataColumns` Columns in the Data table.
abstract	`DataColumnsWithJoins` Combines all columns returned by `ContactsContract.Data` table queries.
	`DataUsageFeedback` API allowing applications to send usage information for each `Data` row to the Contacts Provider.
abstract	`DataUsageStatColumns` Columns in the Data_Usage_Stat table
	`DeletedContacts` Constants for the deleted contact table.
abstract	`DeletedContactsColumns`
	`Directory` A Directory represents a contacts corpus, e.
abstract	`DisplayNameSources` Types of data used to produce the display name for a contact.
	`DisplayPhoto` Helper class for accessing full-size photos by photo file ID.
abstract	`FullNameStyle` Constants for various styles of combining given name, family name etc into a full name.
	`Groups` Constants for the groups table.
abstract	`GroupsColumns`
	`Intents` Contains helper classes used to create or manage `Intents` that involve contacts.
	`PhoneLookup` A table that represents the result of looking up a phone number, for example for caller ID.
abstract	`PhoneLookupColumns`
abstract	`PhoneticNameStyle` Constants for various styles of capturing the pronunciation of a person's name.
	`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.
	`Presence`
abstract	`PresenceColumns` Additional data mixed in with `StatusColumns` to link back to specific `ContactsContract.Data#_ID` entries.
	`Profile` Constants for the user's profile data, which is represented as a single contact on the device that represents the user.
	`ProfileSyncState` A table provided for sync adapters to use for storing private sync state data for the user's personal profile.
	`ProviderStatus` API for inquiring about the general status of the provider.
	`QuickContact` Helper methods to display QuickContact dialogs that display all the information belonging to a specific `Contacts` entry.
	`RawContacts` Constants for the raw contacts table, which contains one row of contact information for each person in each synced account.
abstract	`RawContactsColumns`
	`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.
	`SearchSnippets` Additional column returned by `Contacts.CONTENT_FILTER_URI` explaining why the filter matched the contact.
	`Settings` Contacts-specific settings for various `Account`'s.
abstract	`SettingsColumns`
	`SimAccount` A parcelable class encapsulating account data for contacts that originate from a SIM card.
	`SimContacts` Class containing utility methods around determine what accounts in the ContactsProvider are related to the SIM cards in the device.
abstract	`StatusColumns` Social status update columns.
	`StatusUpdates` A status update is linked to a `ContactsContract.Data` row and captures the user's latest status update via the corresponding source, e.
abstract	`SyncColumns` Columns that appear when each row of a table belongs to a specific account, including sync information that an account may need.
	`SyncState` A table provided for sync adapters to use for storing private sync state data for contacts.

Constants
static String	`AUTHORITY` The authority for the contacts provider
static 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.
static String	`DEFERRED_SNIPPETING` A key to a boolean in the "extras" bundle of the cursor.
static String	`DEFERRED_SNIPPETING_QUERY` Key to retrieve the original deferred snippeting from the cursor on the client side.
static String	`DIRECTORY_PARAM_KEY` Query parameter that should be used by the client to access a specific `Directory`.
static String	`LIMIT_PARAM_KEY` A query parameter that limits the number of results returned for supported URIs.
static String	`PRIMARY_ACCOUNT_NAME` A query parameter specifing a primary account.
static String	`PRIMARY_ACCOUNT_TYPE` A query parameter specifing a primary account.
static String	`REMOVE_DUPLICATE_ENTRIES` A boolean parameter for `Phone.CONTENT_URI`, `Email.CONTENT_URI`, and `StructuredPostal.CONTENT_URI`.
static 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.

Public constructors
`ContactsContract()`

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

Properties
static Uri!	`AUTHORITY_URI` A content:// style uri to the authority for the contacts provider

Constants

AUTHORITY

Added in API level 5

static val AUTHORITY: String

The authority for the contacts provider

Value: "com.android.contacts"

CALLER_IS_SYNCADAPTER

Added in API level 5

static val CALLER_IS_SYNCADAPTER: String

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 android.content.ContentResolver#notifyChange(android.net.Uri,android.database.ContentObserver,boolean). This prevents an unnecessary extra synchronization, see the discussion of the delete operation in RawContacts.

Value: "caller_is_syncadapter"

DEFERRED_SNIPPETING

Added in API level 21

static val DEFERRED_SNIPPETING: String

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).

Value: "deferred_snippeting"

See Also

android.provider.ContactsContract.SearchSnippets

DEFERRED_SNIPPETING_QUERY

Added in API level 21

static val DEFERRED_SNIPPETING_QUERY: String

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

Value: "deferred_snippeting_query"

See Also

DIRECTORY_PARAM_KEY

Added in API level 11

static val DIRECTORY_PARAM_KEY: String

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

Value: "directory"

LIMIT_PARAM_KEY

Added in API level 11

static val LIMIT_PARAM_KEY: String

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, CommonDataKinds.Phone#CONTENT_URI, CommonDataKinds.Callable#CONTENT_URI, CommonDataKinds.Email#CONTENT_URI, 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.

Value: "limit"

PRIMARY_ACCOUNT_NAME

Added in API level 14

static val PRIMARY_ACCOUNT_NAME: String

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.

Value: "name_for_primary_account"

PRIMARY_ACCOUNT_TYPE

Added in API level 14

static val PRIMARY_ACCOUNT_TYPE: String

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

Value: "type_for_primary_account"

REMOVE_DUPLICATE_ENTRIES

Added in API level 21

static val REMOVE_DUPLICATE_ENTRIES: String

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.

Value: "remove_duplicate_entries"

STREQUENT_PHONE_ONLY

Added in API level 21

static val STREQUENT_PHONE_ONLY: String

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

Value: "strequent_phone_only"

Public constructors