Android APIs
public static final class

ContactsContract.CommonDataKinds.Im

extends Object
implements ContactsContract.CommonDataKinds.CommonColumns ContactsContract.DataColumnsWithJoins
java.lang.Object
   ↳ android.provider.ContactsContract.CommonDataKinds.Im

Class Overview

A data kind representing an IM address

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

Column aliases

Type AliasData column
String DATA DATA1
int TYPE DATA2 Allowed values are:

String LABEL DATA3
String PROTOCOL DATA5

Allowed values:

String CUSTOM_PROTOCOL DATA6

Summary

Constants
String CONTENT_ITEM_TYPE MIME type used when storing this in data table.
String CUSTOM_PROTOCOL
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 PROTOCOL This column should be populated with one of the defined constants, e.g.
int PROTOCOL_AIM
int PROTOCOL_CUSTOM
int PROTOCOL_GOOGLE_TALK
int PROTOCOL_ICQ
int PROTOCOL_JABBER
int PROTOCOL_MSN
int PROTOCOL_NETMEETING
int PROTOCOL_QQ
int PROTOCOL_SKYPE
int PROTOCOL_YAHOO
int TYPE_HOME
int TYPE_OTHER
int TYPE_WORK
[Expand]
Inherited Constants
From interface android.provider.BaseColumns
From interface android.provider.ContactsContract.CommonDataKinds.BaseTypes
From interface android.provider.ContactsContract.CommonDataKinds.CommonColumns
From interface android.provider.ContactsContract.ContactNameColumns
From interface android.provider.ContactsContract.ContactOptionsColumns
From interface android.provider.ContactsContract.ContactStatusColumns
From interface android.provider.ContactsContract.ContactsColumns
From interface android.provider.ContactsContract.DataColumns
From interface android.provider.ContactsContract.DataUsageStatColumns
From interface android.provider.ContactsContract.RawContactsColumns
From interface android.provider.ContactsContract.StatusColumns
Public Methods
final static CharSequence getProtocolLabel(Resources res, int type, CharSequence label)
Return a CharSequence that best describes the given protocol, possibly substituting the given CUSTOM_PROTOCOL value for PROTOCOL_CUSTOM.
final static int getProtocolLabelResource(int type)
Return the string resource that best describes the given PROTOCOL.
final static CharSequence getTypeLabel(Resources res, int type, CharSequence label)
Return a CharSequence that best describes the given type, possibly substituting the given LABEL value for TYPE_CUSTOM.
final static int getTypeLabelResource(int type)
Return the string resource that best describes the given TYPE.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String CONTENT_ITEM_TYPE

Added in API level 5

MIME type used when storing this in data table.

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

public static final String CUSTOM_PROTOCOL

Added in API level 5

Constant Value: "data6"

public static final String EXTRA_ADDRESS_BOOK_INDEX

Added in API level 21

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"

public static final String EXTRA_ADDRESS_BOOK_INDEX_COUNTS

Added in API level 21

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"

public static final String EXTRA_ADDRESS_BOOK_INDEX_TITLES

Added in API level 21

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"

public static final String PROTOCOL

Added in API level 5

This column should be populated with one of the defined constants, e.g. PROTOCOL_YAHOO. If the value of this column is PROTOCOL_CUSTOM, the CUSTOM_PROTOCOL should contain the name of the custom protocol.

Constant Value: "data5"

public static final int PROTOCOL_AIM

Added in API level 5

Constant Value: 0 (0x00000000)

public static final int PROTOCOL_CUSTOM

Added in API level 5

Constant Value: -1 (0xffffffff)

public static final int PROTOCOL_GOOGLE_TALK

Added in API level 5

Constant Value: 5 (0x00000005)

public static final int PROTOCOL_ICQ

Added in API level 5

Constant Value: 6 (0x00000006)

public static final int PROTOCOL_JABBER

Added in API level 5

Constant Value: 7 (0x00000007)

public static final int PROTOCOL_MSN

Added in API level 5

Constant Value: 1 (0x00000001)

public static final int PROTOCOL_NETMEETING

Added in API level 5

Constant Value: 8 (0x00000008)

public static final int PROTOCOL_QQ

Added in API level 5

Constant Value: 4 (0x00000004)

public static final int PROTOCOL_SKYPE

Added in API level 5

Constant Value: 3 (0x00000003)

public static final int PROTOCOL_YAHOO

Added in API level 5

Constant Value: 2 (0x00000002)

public static final int TYPE_HOME

Added in API level 5

Constant Value: 1 (0x00000001)

public static final int TYPE_OTHER

Added in API level 5

Constant Value: 3 (0x00000003)

public static final int TYPE_WORK

Added in API level 5

Constant Value: 2 (0x00000002)

Public Methods

public static final CharSequence getProtocolLabel (Resources res, int type, CharSequence label)

Added in API level 5

Return a CharSequence that best describes the given protocol, possibly substituting the given CUSTOM_PROTOCOL value for PROTOCOL_CUSTOM.

public static final int getProtocolLabelResource (int type)

Added in API level 5

Return the string resource that best describes the given PROTOCOL. Will always return a valid resource.

public static final CharSequence getTypeLabel (Resources res, int type, CharSequence label)

Added in API level 5

Return a CharSequence that best describes the given type, possibly substituting the given LABEL value for TYPE_CUSTOM.

public static final int getTypeLabelResource (int type)

Added in API level 5

Return the string resource that best describes the given TYPE. Will always return a valid resource.