Summary: Nested Classes | Constants | Fields | Inherited Methods

ContactsPickerSessionContract

Kotlin |Java

public final class ContactsPickerSessionContract
extends Object

java.lang.Object
↳	android.provider.ContactsPickerSessionContract

The contract between the Contacts Picker session provider and client applications. This contract defines the intent actions, extras, and URI structure used to interact with the Contacts Picker to select contacts and retrieve their data.

It allows apps to select one or more contacts without requiring Manifest.permission.READ_CONTACTS, enhancing user privacy and security. The client app receives one-time access to the user-selected contacts data.

Summary

Nested classes
`class`	`ContactsPickerSessionContract.Session` Defines the contract for a Contacts Picker session, which represents the set of contacts selected by the user in a single picking operation.

Constants
`String`	`ACTION_PICK_CONTACTS` Intent action to launch the system Contacts Picker to select one or more contacts.
`String`	`AUTHORITY` The authority for the Contacts Picker session provider.
`String`	`EXTRA_PICK_CONTACTS_MATCH_ALL_DATA_FIELDS` A boolean extra that, when set to `true`, instructs the system Contacts Picker to only display contacts that possess data fields corresponding to all MIME type specified in `EXTRA_PICK_CONTACTS_REQUESTED_DATA_FIELDS`.
`String`	`EXTRA_PICK_CONTACTS_REQUESTED_DATA_FIELDS` A `List<String>` extra that specifies the types of contact data the client application is requesting.
`String`	`EXTRA_PICK_CONTACTS_SELECTION_LIMIT` An integer extra that defines the maximum number of contacts a user can select in a single session.

Fields
`public static final Uri`	`AUTHORITY_URI` The base `content://` style `Uri` for the Contacts Picker session provider.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

ACTION_PICK_CONTACTS

public static final String ACTION_PICK_CONTACTS

Intent action to launch the system Contacts Picker to select one or more contacts. This action provides a modern way for applications to obtain contact information, differing from Intent.ACTION_PICK and Intent.ACTION_GET_CONTENT in several key ways:

It is specifically designed for picking contacts, offering a streamlined user experience.
The calling application gains one-time read access to the user-selected contact data, without requiring Manifest.permission.READ_CONTACTS.
Users benefit from a consistent UI to grant temporary access to their contact data.
Client applications can specify and receive multiple data fields (MIME types) corresponding to the selected contacts.

To use this intent, create an Intent with this action and launch it using Activity.startActivityForResult(android.content.Intent, int). The system Contacts Picker UI will be displayed, allowing the user to select one or more contacts. This contacts picker UI will:

Have eligible contacts displayed as a scrollable list to the user.
Enable users to select single/multiple contacts.
Enable users to search for contacts using display name.

The display and selection behavior can be customized using the following extras:

EXTRA_PICK_CONTACTS_REQUESTED_DATA_FIELDS: (Required) Specifies the MIME types of contact data to be displayed in the picker and returned to the calling app. Contacts must have at least one of the specified MIME types, to be shown as available for selection.
EXTRA_PICK_CONTACTS_MATCH_ALL_DATA_FIELDS: (Optional) If set to true, only contacts possessing data for *all* MIME types specified in EXTRA_PICK_CONTACTS_REQUESTED_DATA_FIELDS will be shown as available for selection. Defaults to false.
EXTRA_PICK_CONTACTS_SELECTION_LIMIT: (Optional) Defines the maximum number of contacts the user can select. Defaults to 50, with a maximum allowed value of 100.
Intent.EXTRA_ALLOW_MULTIPLE: (Optional) If set to true, the user can select multiple contacts. The default behavior is single-select.

Upon successful contact(s) selection, the Activity.onActivityResult(int, int, android.content.Intent) callback will be invoked with Activity.RESULT_OK. The returned Intent will contain a session URI in its data field (see Session.CONTENT_URI), which should be used to query the selected contact data. For example:

     Uri sessionUri = data.getData();
     Cursor cursor = getContentResolver().query(sessionUri, projection, null, null, null);
     // Process cursor data

Starting from Android 17, this intent is handled by a system application by default. Third-party applications should not handle this intent as they will be ignored when the system attempts to resolve it.

Constant Value: "android.provider.action.PICK_CONTACTS"

AUTHORITY

public static final String AUTHORITY

The authority for the Contacts Picker session provider. This string is used to construct content URIs for interacting with the Contacts Picker session data.

Constant Value: "com.android.contacts.picker.sessions"

EXTRA_PICK_CONTACTS_MATCH_ALL_DATA_FIELDS

public static final String EXTRA_PICK_CONTACTS_MATCH_ALL_DATA_FIELDS

A boolean extra that, when set to true, instructs the system Contacts Picker to only display contacts that possess data fields corresponding to *all* MIME type specified in EXTRA_PICK_CONTACTS_REQUESTED_DATA_FIELDS.

If false (the default value), contacts will be displayed if they have data for *at least one* of the MIME types specified in EXTRA_PICK_CONTACTS_REQUESTED_DATA_FIELDS.

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

EXTRA_PICK_CONTACTS_REQUESTED_DATA_FIELDS

public static final String EXTRA_PICK_CONTACTS_REQUESTED_DATA_FIELDS

A List<String> extra that specifies the types of contact data the client application is requesting. This extra serves two primary purposes:

**Filtering:** Only contacts possessing data corresponding to at least one of the specified MIME types will be displayed in the Contacts Picker.
**Data Return:** For selected contacts, only data corresponding to these specified MIME types will be returned to the calling application.

This extra must be populated with one or more of the following MIME types:

If EXTRA_PICK_CONTACTS_MATCH_ALL_DATA_FIELDS is set to true, only contacts having data corresponding to *all* of the MIME types specified in this extra will be displayed.

The Contacts Picker will throw an IllegalArgumentException if any of the MIME types provided in this extra are not among the allowed types listed above.

Clients are required to set this extra to ensure the picker can determine which information should be made available for selection. Example usage:

     List<String> requestedMimeTypes = new ArrayList<>();
     requestedMimeTypes.add(ContactsContract.CommonDataKinds.Email.CONTENT_ITEM_TYPE);
     requestedMimeTypes.add(ContactsContract.CommonDataKinds.Phone.CONTENT_ITEM_TYPE);
     intent.putStringArrayListExtra(
             ContactsPickerSessionContract.EXTRA_PICK_CONTACTS_REQUESTED_DATA_FIELDS,
             (ArrayList<String>) requestedMimeTypes);

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

EXTRA_PICK_CONTACTS_SELECTION_LIMIT

public static final String EXTRA_PICK_CONTACTS_SELECTION_LIMIT

An integer extra that defines the maximum number of contacts a user can select in a single session. The Contacts Picker uses this value to configure its UI.

If this extra is not set, the default selection limit is 50. The absolute maximum allowed value is 100.

Clients should not set this value higher than the documented maximum limit. The application handling ACTION_PICK_CONTACTS will throw an IllegalArgumentException if the provided value exceeds the maximum allowed limit.

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

Fields

AUTHORITY_URI

public static final Uri AUTHORITY_URI

The base content:// style Uri for the Contacts Picker session provider. All session-specific URIs are built upon this base URI.

ContactsPickerSessionContract

Summary

Nested classes

Constants

Fields

Inherited methods

Constants

ACTION_PICK_CONTACTS

AUTHORITY

EXTRA_PICK_CONTACTS_MATCH_ALL_DATA_FIELDS

EXTRA_PICK_CONTACTS_REQUESTED_DATA_FIELDS

EXTRA_PICK_CONTACTS_SELECTION_LIMIT

Fields

AUTHORITY_URI