Groups

Kotlin |Java

class Groups

kotlin.Any
↳	android.provider.PeopleContract.Groups

Constants, URI definitions, and query utilities for group records aggregated from People Directories.

For client applications: Clients query CONTENT_URI using structured query arguments created via Query.Builder. Each row in the resulting android.database.Cursor represents a user group supplied by a specific directory, including LOOKUP_KEY and DISPLAY_NAME, as well as directory metadata from Directory.DIRECTORY_AUTHORITY and Directory.PACKAGE_NAME.

To ensure accurate and fresh data, see PeopleContract.EXTRA_NOTIFICATION_URI.

For People Directory applications: When the system queries a People Directory application for group records, cursors returned by the directory must populate these standard column names, as well as PeopleContract.QUERY_ARG_SELECTION_TYPE and PeopleContract.QUERY_ARG_SELECTION_VALUE indicating the exact selection criterion that matched each row.

Summary

Nested classes
	`Query` Constants and builder utilities for constructing group query argument bundles.

Constants
static String	`CONTENT_ITEM_TYPE` The MIME type of a `CONTENT_URI` subdirectory of a single group record.
static String	`CONTENT_TYPE` The MIME type of `CONTENT_URI` providing a directory of group records.
static String	`DISPLAY_NAME` Column name for the display name of the group.
static String	`LOOKUP_KEY` Column name for an opaque, stable string key that uniquely identifies this group record within its originating People Directory.

Properties
static Uri	`CONTENT_LOOKUP_URI` The content:// style base URI for persistently referencing a group record by its lookup key.
static Uri	`CONTENT_URI` The content:// style URI for querying group records aggregated from People Directories.

Constants

CONTENT_ITEM_TYPE

Added in API level 10000

static val CONTENT_ITEM_TYPE: String

The MIME type of a CONTENT_URI subdirectory of a single group record.

Value: "vnd.android.cursor.item/people_group"

CONTENT_TYPE

Added in API level 10000

static val CONTENT_TYPE: String

The MIME type of CONTENT_URI providing a directory of group records.

Value: "vnd.android.cursor.dir/people_groups"

DISPLAY_NAME

Added in API level 10000

static val DISPLAY_NAME: String

Column name for the display name of the group.

Type: TEXT

Value: "display_name"

LOOKUP_KEY

Added in API level 10000

static val LOOKUP_KEY: String

Column name for an opaque, stable string key that uniquely identifies this group record within its originating People Directory.

Type: TEXT

Value: "lookup_key"

Properties

CONTENT_LOOKUP_URI

Added in API level 10000

static val CONTENT_LOOKUP_URI: Uri

The content:// style base URI for persistently referencing a group record by its lookup key.

To construct a stable reference to a group identity in storages like call log entries, or notification attributions, append the group's LOOKUP_KEY to this URI along with the originating directory's Directory.PACKAGE_NAME as a query parameter using Uri.Builder. For example, if a group's lookup key is "foo" and the directory's package name is "com.example.app", then the persistent reference would be content://com.android.people/groups/lookup/foo?package_name=com.example.app.

Note: Direct queries against this URI on the People Provider are unsupported; to resolve a group by lookup key, client applications must query CONTENT_URI using Query.Builder.addLookupQuery(String,List).

CONTENT_URI

Added in API level 10000

static val CONTENT_URI: Uri

The content:// style URI for querying group records aggregated from People Directories.

Queries against this URI must be executed via ContentResolver.query(Uri,String[],Bundle,CancellationSignal) using structured query arguments constructed with Query.Builder. Traditional SQL selection strings are not supported.