Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)

Added in API level 5

public static final class

ContactsContract.Groups

extends Object
implements BaseColumns ContactsContract.GroupsColumns ContactsContract.SyncColumns

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

Class Overview

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.

[Expand]

Inherited Constants

From interface android.provider.BaseColumns

From interface android.provider.ContactsContract.BaseSyncColumns

From interface android.provider.ContactsContract.GroupsColumns

String	AUTO_ADD	Any newly created contacts will automatically be added to groups that have this flag set to true.
String	DATA_SET	The data set within the account that this group belongs to.
String	DELETED	The "deleted" flag: "0" by default, "1" if the row has been marked for deletion.
String	FAVORITES	When a contacts is marked as a favorites it will be automatically added to the groups that have this flag set, and when it is removed from favorites it will be removed from these groups.
String	GROUP_IS_READ_ONLY	The "read-only" flag: "0" by default, "1" if the row cannot be modified or deleted except by a sync adapter.
String	GROUP_VISIBLE	Flag indicating if the contacts belonging to this group should be visible in any user interface.
String	NOTES	Notes about the group.
String	SHOULD_SYNC	Whether this group should be synced if the SYNC_EVERYTHING settings is false for this group's account.
String	SUMMARY_COUNT	The total number of `Contacts` that have `ContactsContract.CommonDataKinds.GroupMembership` in this group.
String	SUMMARY_WITH_PHONES	The total number of `Contacts` that have both `ContactsContract.CommonDataKinds.GroupMembership` in this group, and also have phone numbers.
String	SYSTEM_ID	The ID of this group if it is a System Group, i.e.
String	TITLE	The display title of this group.

From interface android.provider.ContactsContract.SyncColumns

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)

[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 CONTENT_ITEM_TYPE

Added in API level 5

The MIME type of a single group.

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

public static final String CONTENT_TYPE

Added in API level 5

The MIME type of a directory of groups.

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

Fields

public static final Uri CONTENT_SUMMARY_URI

Added in API level 5

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

public static final Uri CONTENT_URI

Added in API level 5

The content:// style URI for this table

Public Methods

public static EntityIterator newEntityIterator ( Cursor cursor)

Added in API level 8

Results

Interfaces

Classes

Exceptions

ContactsContract.Groups

Class Overview

Columns

Summary

Constants

public static final String CONTENT_ITEM_TYPE

public static final String CONTENT_TYPE

Fields

public static final Uri CONTENT_SUMMARY_URI

public static final Uri CONTENT_URI

Public Methods

public static EntityIterator newEntityIterator ( Cursor cursor)