Most visited

Recently visited

Results for

Added in API level 5

Summary: Constants | Inherited Constants | Methods | Inherited Methods | [Expand All]

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

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 values: `PROTOCOL_CUSTOM`. Also provide the actual protocol name as `CUSTOM_PROTOCOL`. `PROTOCOL_AIM` `PROTOCOL_MSN` `PROTOCOL_YAHOO` `PROTOCOL_SKYPE` `PROTOCOL_QQ` `PROTOCOL_GOOGLE_TALK` `PROTOCOL_ICQ` `PROTOCOL_JABBER` `PROTOCOL_NETMEETING`
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`

Inherited constants

From interface android.provider.ContactsContract.CommonDataKinds.CommonColumns

From interface android.provider.BaseColumns

From interface android.provider.ContactsContract.DataColumns

`String`	`CARRIER_PRESENCE` Carrier presence information.
`int`	`CARRIER_PRESENCE_VT_CAPABLE` Indicates that the entry is Video Telephony (VT) capable on the current carrier.
`String`	`DATA1` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA10` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA11` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA12` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA13` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA14` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA15` Generic data column, the meaning is `MIMETYPE` specific.
`String`	`DATA2` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA3` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA4` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA5` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA6` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA7` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA8` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA9` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA_VERSION` The version of this data record.
`String`	`IS_PRIMARY` Whether this is the primary entry of its kind for the raw contact it belongs to.
`String`	`IS_READ_ONLY` The "read-only" flag: "0" by default, "1" if the row cannot be modified or deleted except by a sync adapter.
`String`	`IS_SUPER_PRIMARY` Whether this is the primary entry of its kind for the aggregate contact it belongs to.
`String`	`MIMETYPE` The MIME type of the item represented by this row.
`String`	`RAW_CONTACT_ID` A reference to the `_ID` that this data belongs to.
`String`	`RES_PACKAGE` The package name to use when creating `Resources` objects for this data row.
`String`	`SYNC1` Generic column for use by sync adapters.
`String`	`SYNC2` Generic column for use by sync adapters.
`String`	`SYNC3` Generic column for use by sync adapters.
`String`	`SYNC4` Generic column for use by sync adapters.

From interface android.provider.ContactsContract.StatusColumns

From interface android.provider.ContactsContract.RawContactsColumns

From interface android.provider.ContactsContract.ContactsColumns

From interface android.provider.ContactsContract.ContactNameColumns

From interface android.provider.ContactsContract.ContactOptionsColumns

From interface android.provider.ContactsContract.ContactStatusColumns

From interface android.provider.ContactsContract.DataUsageStatColumns

From interface android.provider.ContactsContract.CommonDataKinds.BaseTypes

Public methods
`static final 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 final int`	`getProtocolLabelResource(int type)` Return the string resource that best describes the given `PROTOCOL`.
`static final 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`.
`static final int`	`getTypeLabelResource(int type)` Return the string resource that best describes the given `TYPE`.

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 millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Constants

CONTENT_ITEM_TYPE

Added in API level 5

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

String CUSTOM_PROTOCOL

Constant Value: "data6"

EXTRA_ADDRESS_BOOK_INDEX

Added in API level 21

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

Added in API level 21

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

Added in API level 21

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

String PROTOCOL

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"

PROTOCOL_AIM

Added in API level 5

int PROTOCOL_AIM

Constant Value: 0 (0x00000000)

PROTOCOL_CUSTOM

Added in API level 5

int PROTOCOL_CUSTOM

Constant Value: -1 (0xffffffff)

PROTOCOL_GOOGLE_TALK

Added in API level 5

int PROTOCOL_GOOGLE_TALK

Constant Value: 5 (0x00000005)

PROTOCOL_ICQ

Added in API level 5

int PROTOCOL_ICQ

Constant Value: 6 (0x00000006)

PROTOCOL_JABBER

Added in API level 5

int PROTOCOL_JABBER

Constant Value: 7 (0x00000007)

PROTOCOL_MSN

Added in API level 5

int PROTOCOL_MSN

Constant Value: 1 (0x00000001)

PROTOCOL_NETMEETING

Added in API level 5

int PROTOCOL_NETMEETING

Constant Value: 8 (0x00000008)

PROTOCOL_QQ

Added in API level 5

int PROTOCOL_QQ

Constant Value: 4 (0x00000004)

PROTOCOL_SKYPE

Added in API level 5

int PROTOCOL_SKYPE

Constant Value: 3 (0x00000003)

PROTOCOL_YAHOO

Added in API level 5

int PROTOCOL_YAHOO

Constant Value: 2 (0x00000002)

TYPE_HOME

Added in API level 5

int TYPE_HOME

Constant Value: 1 (0x00000001)

TYPE_OTHER

Added in API level 5

int TYPE_OTHER

Constant Value: 3 (0x00000003)

TYPE_WORK

Added in API level 5

int TYPE_WORK

Constant Value: 2 (0x00000002)

Public methods

getProtocolLabel

Added in API level 5

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

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

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.

Parameters
`res`	`Resources`
`type`	`int`
`label`	`CharSequence`

Returns
`CharSequence`

getTypeLabelResource

Added in API level 5

int getTypeLabelResource (int type)

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

Parameters
`type`	`int`

Returns
`int`