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)
Android APIs
public static final class

ContactsContract.Intents

extends Object
java.lang.Object
   ↳ android.provider.ContactsContract.Intents

Class Overview

Contains helper classes used to create or manage Intents that involve contacts.

Summary

Nested Classes
class ContactsContract.Intents.Insert Convenience class that contains string constants used to create contact Intents
Constants
String ATTACH_IMAGE Starts an Activity that lets the user pick a contact to attach an image to.
String CONTACTS_DATABASE_CREATED This is the intent that is fired when the contacts database is created.
String EXTRA_CREATE_DESCRIPTION Used with SHOW_OR_CREATE_CONTACT to specify an exact description to be shown when prompting user about creating a new contact.
String EXTRA_FORCE_CREATE Used with SHOW_OR_CREATE_CONTACT to force creating a new contact if no matching contact found.
String INVITE_CONTACT This is the intent that is fired when the user clicks the "invite to the network" button on a contact.
String SEARCH_SUGGESTION_CLICKED This is the intent that is fired when a search suggestion is clicked on.
String SEARCH_SUGGESTION_CREATE_CONTACT_CLICKED This is the intent that is fired when a search suggestion for creating a contact is clicked on.
String SEARCH_SUGGESTION_DIAL_NUMBER_CLICKED This is the intent that is fired when a search suggestion for dialing a number is clicked on.
String SHOW_OR_CREATE_CONTACT Takes as input a data URI with a mailto: or tel: scheme.
Public Constructors
ContactsContract.Intents ()
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String ATTACH_IMAGE

Added in API level 5

Starts an Activity that lets the user pick a contact to attach an image to. After picking the contact it launches the image cropper in face detection mode.

Constant Value: "com.android.contacts.action.ATTACH_IMAGE"

public static final String CONTACTS_DATABASE_CREATED

This is the intent that is fired when the contacts database is created.

The READ_CONTACT permission is required to receive these broadcasts.

Constant Value: "android.provider.Contacts.DATABASE_CREATED"

public static final String EXTRA_CREATE_DESCRIPTION

Added in API level 5

Used with SHOW_OR_CREATE_CONTACT to specify an exact description to be shown when prompting user about creating a new contact.

Type: STRING

Constant Value: "com.android.contacts.action.CREATE_DESCRIPTION"

public static final String EXTRA_FORCE_CREATE

Added in API level 5

Used with SHOW_OR_CREATE_CONTACT to force creating a new contact if no matching contact found. Otherwise, default behavior is to prompt user with dialog before creating.

Type: BOOLEAN

Constant Value: "com.android.contacts.action.FORCE_CREATE"

public static final String INVITE_CONTACT

This is the intent that is fired when the user clicks the "invite to the network" button on a contact. Only sent to an activity which is explicitly registered by a contact provider which supports the "invite to the network" feature.

getData() contains the lookup URI for the contact.

Constant Value: "com.android.contacts.action.INVITE_CONTACT"

public static final String SEARCH_SUGGESTION_CLICKED

Added in API level 5

This is the intent that is fired when a search suggestion is clicked on.

Constant Value: "android.provider.Contacts.SEARCH_SUGGESTION_CLICKED"

public static final String SEARCH_SUGGESTION_CREATE_CONTACT_CLICKED

Added in API level 5

This is the intent that is fired when a search suggestion for creating a contact is clicked on.

Constant Value: "android.provider.Contacts.SEARCH_SUGGESTION_CREATE_CONTACT_CLICKED"

public static final String SEARCH_SUGGESTION_DIAL_NUMBER_CLICKED

Added in API level 5

This is the intent that is fired when a search suggestion for dialing a number is clicked on.

Constant Value: "android.provider.Contacts.SEARCH_SUGGESTION_DIAL_NUMBER_CLICKED"

public static final String SHOW_OR_CREATE_CONTACT

Added in API level 5

Takes as input a data URI with a mailto: or tel: scheme. If a single contact exists with the given data it will be shown. If no contact exists, a dialog will ask the user if they want to create a new contact with the provided details filled in. If multiple contacts share the data the user will be prompted to pick which contact they want to view.

For mailto: URIs, the scheme specific portion must be a raw email address, such as one built using fromParts(String, String, String) .

For tel: URIs, the scheme specific portion is compared to existing numbers using the standard caller ID lookup algorithm. The number must be properly encoded, for example using fromParts(String, String, String) .

Any extras from the ContactsContract.Intents.Insert class will be passed along to the create activity if there are no contacts to show.

Passing true for the EXTRA_FORCE_CREATE extra will skip prompting the user when the contact doesn't exist.

Constant Value: "com.android.contacts.action.SHOW_OR_CREATE_CONTACT"

Public Constructors

public ContactsContract.Intents ()

Added in API level 5