Added in API level 5
Deprecated in API level 35

Im

Kotlin |Java

class Im : ContactsContract.DataColumnsWithJoins, ContactsContract.CommonDataKinds.CommonColumns

kotlin.Any
↳	android.provider.ContactsContract.CommonDataKinds.Im

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	Alias	Data column
String	`DATA`	`DATA1`
int	`TYPE`	`DATA2`	Allowed values are: `TYPE_CUSTOM`. Put the actual type in `LABEL`. `TYPE_HOME` `TYPE_WORK` `TYPE_OTHER`
String	`LABEL`	`DATA3`
String	`PROTOCOL`	`DATA5`	Allowed value: `PROTOCOL_CUSTOM`. Also provide the actual protocol name as `CUSTOM_PROTOCOL`.
String	`CUSTOM_PROTOCOL`	`DATA6`

Summary

Constants
static String	`CONTENT_ITEM_TYPE` MIME type used when storing this in data table.
static String	`CUSTOM_PROTOCOL`
static 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.
static String	`EXTRA_ADDRESS_BOOK_INDEX_COUNTS` The array of group counts for the corresponding group.
static 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.
static String	`PROTOCOL` This column should always be set to `PROTOCOL_CUSTOM` and the `CUSTOM_PROTOCOL` should contain the name of the custom protocol.
static Int	`PROTOCOL_AIM`
static Int	`PROTOCOL_CUSTOM`
static Int	`PROTOCOL_GOOGLE_TALK`
static Int	`PROTOCOL_ICQ`
static Int	`PROTOCOL_JABBER`
static Int	`PROTOCOL_MSN`
static Int	`PROTOCOL_NETMEETING`
static Int	`PROTOCOL_QQ`
static Int	`PROTOCOL_SKYPE`
static Int	`PROTOCOL_YAHOO`
static Int	`TYPE_HOME`
static Int	`TYPE_OTHER`
static Int	`TYPE_WORK`

Inherited constants

From class CommonColumns

String

DATA

The data for the contact method.

Type: TEXT

String

LABEL

The user defined label for the the contact method.

Type: TEXT

String

TYPE

The type of data, for example Home or Work.

Type: INTEGER

From class BaseTypes

Int

TYPE_CUSTOM

A custom type. The custom label should be supplied by user.

Public methods
static CharSequence!	`getProtocolLabel(res: Resources!, type: Int, label: CharSequence!)` Return a `CharSequence` that best describes the given protocol, possibly substituting the given `CUSTOM_PROTOCOL` value for `PROTOCOL_CUSTOM`.
static Int	`getProtocolLabelResource(type: Int)` Return the string resource that best describes the given `PROTOCOL`.
static CharSequence!	`getTypeLabel(res: Resources!, type: Int, label: CharSequence?)` Return a `CharSequence` that best describes the given type, possibly substituting the given `LABEL` value for `TYPE_CUSTOM`.
static Int	`getTypeLabelResource(type: Int)` Return the string resource that best describes the given `TYPE`.

Constants

CONTENT_ITEM_TYPE

Added in API level 5

static val CONTENT_ITEM_TYPE: String

Deprecated: Deprecated in Java.

MIME type used when storing this in data table.

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

CUSTOM_PROTOCOL

Added in API level 5

static val CUSTOM_PROTOCOL: String

Deprecated: Deprecated in Java.

Value: "data6"

EXTRA_ADDRESS_BOOK_INDEX

static val EXTRA_ADDRESS_BOOK_INDEX: String

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);
  }

Value: "android.provider.extra.ADDRESS_BOOK_INDEX"

EXTRA_ADDRESS_BOOK_INDEX_COUNTS

static val EXTRA_ADDRESS_BOOK_INDEX_COUNTS: String

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[]

Value: "android.provider.extra.ADDRESS_BOOK_INDEX_COUNTS"

EXTRA_ADDRESS_BOOK_INDEX_TITLES

static val EXTRA_ADDRESS_BOOK_INDEX_TITLES: String

The array of address book index titles, which are returned in the same order as the data in the cursor.

TYPE: String[]

Value: "android.provider.extra.ADDRESS_BOOK_INDEX_TITLES"

PROTOCOL

Added in API level 5

static val PROTOCOL: String

Deprecated: Deprecated in Java.

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.

Value: "data5"

PROTOCOL_AIM

Added in API level 5
Deprecated in API level 31

static val PROTOCOL_AIM: Int

Deprecated: Use PROTOCOL_CUSTOM with CUSTOM_PROTOCOL.

Value: 0

PROTOCOL_CUSTOM

Added in API level 5

static val PROTOCOL_CUSTOM: Int

Deprecated: Deprecated in Java.

Value: -1

PROTOCOL_GOOGLE_TALK

Added in API level 5
Deprecated in API level 31

static val PROTOCOL_GOOGLE_TALK: Int

Deprecated: Use PROTOCOL_CUSTOM with CUSTOM_PROTOCOL.

Value: 5

PROTOCOL_ICQ

Added in API level 5
Deprecated in API level 31

static val PROTOCOL_ICQ: Int

Deprecated: Use PROTOCOL_CUSTOM with CUSTOM_PROTOCOL.

Value: 6

PROTOCOL_JABBER

Added in API level 5
Deprecated in API level 31

static val PROTOCOL_JABBER: Int

Deprecated: Use PROTOCOL_CUSTOM with CUSTOM_PROTOCOL.

Value: 7

PROTOCOL_MSN

Added in API level 5
Deprecated in API level 31

static val PROTOCOL_MSN: Int

Deprecated: Use PROTOCOL_CUSTOM with CUSTOM_PROTOCOL.

Value: 1

PROTOCOL_NETMEETING

Added in API level 5
Deprecated in API level 31

static val PROTOCOL_NETMEETING: Int

Deprecated: Use PROTOCOL_CUSTOM with CUSTOM_PROTOCOL.

Value: 8

PROTOCOL_QQ

Added in API level 5
Deprecated in API level 31

static val PROTOCOL_QQ: Int

Deprecated: Use PROTOCOL_CUSTOM with CUSTOM_PROTOCOL.

Value: 4

PROTOCOL_SKYPE

Added in API level 5
Deprecated in API level 31

static val PROTOCOL_SKYPE: Int

Deprecated: Use PROTOCOL_CUSTOM with CUSTOM_PROTOCOL.

Value: 3

PROTOCOL_YAHOO

Added in API level 5
Deprecated in API level 31

static val PROTOCOL_YAHOO: Int

Deprecated: Use PROTOCOL_CUSTOM with CUSTOM_PROTOCOL.

Value: 2

TYPE_HOME

Added in API level 5

static val TYPE_HOME: Int

Deprecated: Deprecated in Java.

Value: 1

TYPE_OTHER

Added in API level 5

static val TYPE_OTHER: Int

Deprecated: Deprecated in Java.

Value: 3

TYPE_WORK

Added in API level 5

static val TYPE_WORK: Int

Deprecated: Deprecated in Java.

Value: 2

Public methods

getProtocolLabel

Added in API level 5

static fun getProtocolLabel(
    res: Resources!, 
    type: Int, 
    label: CharSequence!
): CharSequence!

Deprecated: Deprecated in Java.

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

getProtocolLabelResource

Added in API level 5

static fun getProtocolLabelResource(type: Int): Int

Deprecated: Deprecated in Java.

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

getTypeLabel

Added in API level 5

static fun getTypeLabel(
    res: Resources!, 
    type: Int, 
    label: CharSequence?
): CharSequence!

Deprecated: Deprecated in Java.

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

Parameters
`label`	CharSequence?: This value may be `null`.

getTypeLabelResource

Added in API level 5

static fun getTypeLabelResource(type: Int): Int

Deprecated: Deprecated in Java.

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