ContactsContract.CommonDataKinds.Im

public static final class ContactsContract.CommonDataKinds.Im
extends Object implements ContactsContract.DataColumnsWithJoins, ContactsContract.CommonDataKinds.CommonColumns

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


This class was deprecated in API level VanillaIceCream.
This field may not be well supported by some contacts apps and is discouraged to use.

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 ContactsContract.CommonDataKinds.CommonColumns.DATA ContactsContract.DataColumns.DATA1
int ContactsContract.CommonDataKinds.CommonColumns.TYPE ContactsContract.DataColumns.DATA2 Allowed values are:

String ContactsContract.CommonDataKinds.CommonColumns.LABEL ContactsContract.DataColumns.DATA3
String PROTOCOL ContactsContract.DataColumns.DATA5

Allowed value: PROTOCOL_CUSTOM. Also provide the actual protocol name as CUSTOM_PROTOCOL.

String CUSTOM_PROTOCOL ContactsContract.DataColumns.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 always be set to PROTOCOL_CUSTOM and the CUSTOM_PROTOCOL should contain the name of the custom protocol.

int PROTOCOL_AIM

This constant was deprecated in API level 31. Use PROTOCOL_CUSTOM with CUSTOM_PROTOCOL.

int PROTOCOL_CUSTOM

int PROTOCOL_GOOGLE_TALK

This constant was deprecated in API level 31. Use PROTOCOL_CUSTOM with CUSTOM_PROTOCOL.

int PROTOCOL_ICQ

This constant was deprecated in API level 31. Use PROTOCOL_CUSTOM with CUSTOM_PROTOCOL.

int PROTOCOL_JABBER

This constant was deprecated in API level 31. Use PROTOCOL_CUSTOM with CUSTOM_PROTOCOL.

int PROTOCOL_MSN

This constant was deprecated in API level 31. Use PROTOCOL_CUSTOM with CUSTOM_PROTOCOL.

int PROTOCOL_NETMEETING

This constant was deprecated in API level 31. Use PROTOCOL_CUSTOM with CUSTOM_PROTOCOL.

int PROTOCOL_QQ

This constant was deprecated in API level 31. Use PROTOCOL_CUSTOM with CUSTOM_PROTOCOL.

int PROTOCOL_SKYPE

This constant was deprecated in API level 31. Use PROTOCOL_CUSTOM with CUSTOM_PROTOCOL.

int PROTOCOL_YAHOO

This constant was deprecated in API level 31. Use PROTOCOL_CUSTOM with CUSTOM_PROTOCOL.

int TYPE_HOME

int TYPE_OTHER

int TYPE_WORK

Inherited constants

Public methods

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.

static int getProtocolLabelResource(int type)

Return the string resource that best describes the given PROTOCOL.

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

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

static int getTypeLabelResource(int type)

Return the string resource that best describes the given ContactsContract.CommonDataKinds.CommonColumns.TYPE.

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/im"

CUSTOM_PROTOCOL

Added in API level 5
public static final String CUSTOM_PROTOCOL

Constant Value: "data6"

EXTRA_ADDRESS_BOOK_INDEX

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

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

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"

PROTOCOL

Added in API level 5
public static final String PROTOCOL

This column should always be set to PROTOCOL_CUSTOM and the CUSTOM_PROTOCOL should contain the name of the custom protocol. The other predefined protocols are deprecated and should not be used.

Constant Value: "data5"

PROTOCOL_AIM

Added in API level 5
Deprecated in API level 31
public static final int PROTOCOL_AIM

This constant was deprecated in API level 31.
Use PROTOCOL_CUSTOM with CUSTOM_PROTOCOL.

Constant Value: 0 (0x00000000)

PROTOCOL_CUSTOM

Added in API level 5
public static final int PROTOCOL_CUSTOM

Constant Value: -1 (0xffffffff)

PROTOCOL_GOOGLE_TALK

Added in API level 5
Deprecated in API level 31
public static final int PROTOCOL_GOOGLE_TALK

This constant was deprecated in API level 31.
Use PROTOCOL_CUSTOM with CUSTOM_PROTOCOL.

Constant Value: 5 (0x00000005)

PROTOCOL_ICQ

Added in API level 5
Deprecated in API level 31
public static final int PROTOCOL_ICQ

This constant was deprecated in API level 31.
Use PROTOCOL_CUSTOM with CUSTOM_PROTOCOL.

Constant Value: 6 (0x00000006)

PROTOCOL_JABBER

Added in API level 5
Deprecated in API level 31
public static final int PROTOCOL_JABBER

This constant was deprecated in API level 31.
Use PROTOCOL_CUSTOM with CUSTOM_PROTOCOL.

Constant Value: 7 (0x00000007)

PROTOCOL_MSN

Added in API level 5
Deprecated in API level 31
public static final int PROTOCOL_MSN

This constant was deprecated in API level 31.
Use PROTOCOL_CUSTOM with CUSTOM_PROTOCOL.

Constant Value: 1 (0x00000001)

PROTOCOL_NETMEETING

Added in API level 5
Deprecated in API level 31
public static final int PROTOCOL_NETMEETING

This constant was deprecated in API level 31.
Use PROTOCOL_CUSTOM with CUSTOM_PROTOCOL.

Constant Value: 8 (0x00000008)

PROTOCOL_QQ

Added in API level 5
Deprecated in API level 31
public static final int PROTOCOL_QQ

This constant was deprecated in API level 31.
Use PROTOCOL_CUSTOM with CUSTOM_PROTOCOL.

Constant Value: 4 (0x00000004)

PROTOCOL_SKYPE

Added in API level 5
Deprecated in API level 31
public static final int PROTOCOL_SKYPE

This constant was deprecated in API level 31.
Use PROTOCOL_CUSTOM with CUSTOM_PROTOCOL.

Constant Value: 3 (0x00000003)

PROTOCOL_YAHOO

Added in API level 5
Deprecated in API level 31
public static final int PROTOCOL_YAHOO

This constant was deprecated in API level 31.
Use PROTOCOL_CUSTOM with CUSTOM_PROTOCOL.

Constant Value: 2 (0x00000002)

TYPE_HOME

Added in API level 5
public static final int TYPE_HOME

Constant Value: 1 (0x00000001)

TYPE_OTHER

Added in API level 5
public static final int TYPE_OTHER

Constant Value: 3 (0x00000003)

TYPE_WORK

Added in API level 5
public static final int TYPE_WORK

Constant Value: 2 (0x00000002)

Public methods

getProtocolLabel

Added in API level 5
public 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.

Parameters
res Resources

type int

label CharSequence

Returns
CharSequence

getProtocolLabelResource

Added in API level 5
public static int getProtocolLabelResource (int type)

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

Parameters
type int

Returns
int

getTypeLabel

Added in API level 5
public static CharSequence getTypeLabel (Resources res, 
                int type, 
                CharSequence label)

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

Parameters
res Resources

type int

label CharSequence: This value may be null.

Returns
CharSequence

getTypeLabelResource

Added in API level 5
public static int getTypeLabelResource (int type)

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

Parameters
type int

Returns
int