lightbulb_outline Help shape the future of the Google Play Console, Android Studio, and Firebase. Start survey

ContactsContract.CommonDataKinds.GroupMembership

public static final class ContactsContract.CommonDataKinds.GroupMembership
extends Object implements ContactsContract.DataColumnsWithJoins

java.lang.Object
   ↳ android.provider.ContactsContract.CommonDataKinds.GroupMembership


Group Membership.

You can use all columns defined for ContactsContract.Data as well as the following aliases.

Column aliases

Type AliasData column
long GROUP_ROW_ID ContactsContract.DataColumns.DATA1
String GROUP_SOURCE_ID none

The sourceid of the group that this group membership refers to. Exactly one of this or GROUP_ROW_ID must be set when inserting a row.

If this field is specified, the provider will first try to look up a group with this Groups.SOURCE_ID. If such a group is found, it will use the corresponding row id. If the group is not found, it will create one.

Summary

Constants

String CONTENT_ITEM_TYPE

MIME type used when storing this in data table.

String EXTRA_ADDRESS_BOOK_INDEX

Add this query parameter to a URI to get back row counts grouped by the address book index as cursor extras.

String EXTRA_ADDRESS_BOOK_INDEX_COUNTS

The array of group counts for the corresponding group.

String EXTRA_ADDRESS_BOOK_INDEX_TITLES

The array of address book index titles, which are returned in the same order as the data in the cursor.

String GROUP_ROW_ID

The row id of the group that this group membership refers to.

String GROUP_SOURCE_ID

The sourceid of the group that this group membership refers to.

Inherited constants

Inherited methods

Constants

CONTENT_ITEM_TYPE

added in API level 5
public static final String CONTENT_ITEM_TYPE

MIME type used when storing this in data table.

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

EXTRA_ADDRESS_BOOK_INDEX

added in API level 21
public static final String EXTRA_ADDRESS_BOOK_INDEX

Add this query parameter to a URI to get back row counts grouped by the address book index as cursor extras. For most languages it is the first letter of the sort key. This parameter does not affect the main content of the cursor.

 Example:

 import android.provider.ContactsContract.Contacts;

 Uri uri = Contacts.CONTENT_URI.buildUpon()
          .appendQueryParameter(Contacts.EXTRA_ADDRESS_BOOK_INDEX, "true")
          .build();
 Cursor cursor = getContentResolver().query(uri,
          new String[] {Contacts.DISPLAY_NAME},
          null, null, null);
 Bundle bundle = cursor.getExtras();
 if (bundle.containsKey(Contacts.EXTRA_ADDRESS_BOOK_INDEX_TITLES) &&
         bundle.containsKey(Contacts.EXTRA_ADDRESS_BOOK_INDEX_COUNTS)) {
     String sections[] =
             bundle.getStringArray(Contacts.EXTRA_ADDRESS_BOOK_INDEX_TITLES);
     int counts[] = bundle.getIntArray(Contacts.EXTRA_ADDRESS_BOOK_INDEX_COUNTS);
 }
 

Constant Value: "android.provider.extra.ADDRESS_BOOK_INDEX"

EXTRA_ADDRESS_BOOK_INDEX_COUNTS

added in API level 21
public static final String EXTRA_ADDRESS_BOOK_INDEX_COUNTS

The array of group counts for the corresponding group. Contains the same number of elements as the EXTRA_ADDRESS_BOOK_INDEX_TITLES array.

TYPE: int[]

Constant Value: "android.provider.extra.ADDRESS_BOOK_INDEX_COUNTS"

EXTRA_ADDRESS_BOOK_INDEX_TITLES

added in API level 21
public static final String EXTRA_ADDRESS_BOOK_INDEX_TITLES

The array of address book index titles, which are returned in the same order as the data in the cursor.

TYPE: String[]

Constant Value: "android.provider.extra.ADDRESS_BOOK_INDEX_TITLES"

GROUP_ROW_ID

added in API level 5
public static final String GROUP_ROW_ID

The row id of the group that this group membership refers to. Exactly one of this or GROUP_SOURCE_ID must be set when inserting a row.

Type: INTEGER

Constant Value: "data1"

GROUP_SOURCE_ID

added in API level 5
public static final String GROUP_SOURCE_ID

The sourceid of the group that this group membership refers to. Exactly one of this or GROUP_ROW_ID must be set when inserting a row.

Type: TEXT

Constant Value: "group_sourceid"