Skip to content

Most visited

Recently visited

navigation

ContactsContract.Groups

public static final class ContactsContract.Groups
extends Object implements BaseColumns, ContactsContract.GroupsColumns, ContactsContract.SyncColumns

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


Constants for the groups table. Only per-account groups are supported.

Columns

#
Groups
long _ID read-only Row ID. Sync adapter should try to preserve row IDs during updates. In other words, it would be a really bad idea to delete and reinsert a group. A sync adapter should always do an update instead.
String DATA_SET read/write-once

The data set within the account that this group belongs to. This allows multiple sync adapters for the same account type to distinguish between each others' group data. The combination of ACCOUNT_TYPE, ACCOUNT_NAME, and DATA_SET identifies a set of data that is associated with a single sync adapter.

This is empty by default, and is completely optional. It only needs to be populated if multiple sync adapters are entering distinct data for the same account type and account name.

It should be set at the time the group is inserted and never changed afterwards.

String TITLE read/write The display title of this group.
String NOTES read/write Notes about the group.
String SYSTEM_ID read/write The ID of this group if it is a System Group, i.e. a group that has a special meaning to the sync adapter, null otherwise.
int SUMMARY_COUNT read-only The total number of Contacts that have ContactsContract.CommonDataKinds.GroupMembership in this group. Read-only value that is only present when querying CONTENT_SUMMARY_URI.
int SUMMARY_WITH_PHONES read-only The total number of Contacts that have both ContactsContract.CommonDataKinds.GroupMembership in this group, and also have phone numbers. Read-only value that is only present when querying CONTENT_SUMMARY_URI.
int GROUP_VISIBLE read-only Flag indicating if the contacts belonging to this group should be visible in any user interface. Allowed values: 0 and 1.
int DELETED read/write The "deleted" flag: "0" by default, "1" if the row has been marked for deletion. When delete(Uri, String, String[]) is called on a group, it is marked for deletion. The sync adaptor deletes the group on the server and then calls ContactResolver.delete once more, this time setting the the CALLER_IS_SYNCADAPTER query parameter to finalize the data removal.
int SHOULD_SYNC read/write Whether this group should be synced if the SYNC_EVERYTHING settings is false for this group's account.

Summary

Constants

String CONTENT_ITEM_TYPE

The MIME type of a single group.

String CONTENT_TYPE

The MIME type of a directory of groups.

Inherited constants

From interface android.provider.BaseColumns
From interface android.provider.ContactsContract.GroupsColumns
From interface android.provider.ContactsContract.SyncColumns
From interface android.provider.ContactsContract.BaseSyncColumns

Fields

public static final Uri CONTENT_SUMMARY_URI

The content:// style URI for this table joined with details data from ContactsContract.Data.

public static final Uri CONTENT_URI

The content:// style URI for this table

Public methods

static EntityIterator newEntityIterator(Cursor cursor)

Inherited methods

From class java.lang.Object

Constants

CONTENT_ITEM_TYPE

Added in API level 5
String CONTENT_ITEM_TYPE

The MIME type of a single group.

Constant Value: "vnd.android.cursor.item/group"

CONTENT_TYPE

Added in API level 5
String CONTENT_TYPE

The MIME type of a directory of groups.

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

Fields

CONTENT_SUMMARY_URI

Added in API level 5
Uri CONTENT_SUMMARY_URI

The content:// style URI for this table joined with details data from ContactsContract.Data.

CONTENT_URI

Added in API level 5
Uri CONTENT_URI

The content:// style URI for this table

Public methods

newEntityIterator

Added in API level 8
EntityIterator newEntityIterator (Cursor cursor)

Parameters
cursor Cursor
Returns
EntityIterator
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.