StatusUpdates

Kotlin |Java

class StatusUpdates : ContactsContract.PresenceColumns, ContactsContract.StatusColumns

kotlin.Any
↳	android.provider.ContactsContract.StatusUpdates

Known Direct Subclasses

ContactsContract.Presence

A status update is linked to a ContactsContract.Data row and captures the user's latest status update via the corresponding source, e.g. "Having lunch" via "Google Talk".

There are two ways a status update can be inserted: by explicitly linking it to a Data row using DATA_ID or indirectly linking it to a data row using a combination of PROTOCOL (or CUSTOM_PROTOCOL) and IM_HANDLE. There is no difference between insert and update, you can use either.

Inserting or updating a status update for the user's profile requires either using the DATA_ID to identify the data row to attach the update to, or StatusUpdates.PROFILE_CONTENT_URI to ensure that the change is scoped to the profile.

You cannot use android.content.ContentResolver#update to change a status, but android.content.ContentResolver#insert will replace the latests status if it already exists.

Use ContentResolver.bulkInsert(Uri, ContentValues[]) to insert/update statuses for multiple contacts at once.

Columns

StatusUpdates
long	`DATA_ID`	read/write	Reference to the `Data._ID` entry that owns this presence. If this field is not specified, the provider will attempt to find a data row that matches the `PROTOCOL` (or `CUSTOM_PROTOCOL`) and `IM_HANDLE` columns.
long	`PROTOCOL`	read/write	See `CommonDataKinds.Im` for a list of defined protocol constants.
String	`CUSTOM_PROTOCOL`	read/write	Name of the custom protocol. Should be supplied along with the `PROTOCOL` value `ContactsContract.CommonDataKinds.Im.PROTOCOL_CUSTOM`. Should be null or omitted if `PROTOCOL` value is not `ContactsContract.CommonDataKinds.Im.PROTOCOL_CUSTOM`.
String	`IM_HANDLE`	read/write	The IM handle the presence item is for. The handle is scoped to `PROTOCOL`.
String	`IM_ACCOUNT`	read/write	The IM account for the local user that the presence data came from.
int	`PRESENCE`	read/write	Contact IM presence status. The allowed values are: `OFFLINE` `INVISIBLE` `AWAY` `IDLE` `DO_NOT_DISTURB` `AVAILABLE` Since presence status is inherently volatile, the content provider may choose not to store this field in long-term storage.
int	`CHAT_CAPABILITY`	read/write	Contact IM chat compatibility value. The allowed values combinations of the following flags. If None of these flags is set, the device can only do text messaging. `CAPABILITY_HAS_VIDEO` `CAPABILITY_HAS_VOICE` `CAPABILITY_HAS_CAMERA` Since chat compatibility is inherently volatile as the contact's availability moves from one device to another, the content provider may choose not to store this field in long-term storage.
String	`STATUS`	read/write	Contact's latest status update, e.g. "having toast for breakfast"
long	`STATUS_TIMESTAMP`	read/write	The absolute time in milliseconds when the status was entered by the user. If this value is not provided, the provider will follow this logic: if there was no prior status update, the value will be left as null. If there was a prior status update, the provider will default this field to the current time.
String	`STATUS_RES_PACKAGE`	read/write	The package containing resources for this status: label and icon.
long	`STATUS_LABEL`	read/write	The resource ID of the label describing the source of contact status, e.g. "Google Talk". This resource is scoped by the `STATUS_RES_PACKAGE`.
long	`STATUS_ICON`	read/write	The resource ID of the icon for the source of contact status. This resource is scoped by the `STATUS_RES_PACKAGE`.

Summary

Constants
static String	`CONTENT_ITEM_TYPE` The MIME type of a `CONTENT_URI` subdirectory of a single status update detail.
static String	`CONTENT_TYPE` The MIME type of `CONTENT_URI` providing a directory of status update details.

Inherited constants

From class StatusColumns

`Int`	`AVAILABLE` An allowed value of `PRESENCE`.
`Int`	`AWAY` An allowed value of `PRESENCE`.
`Int`	`CAPABILITY_HAS_CAMERA` An allowed flag of `CHAT_CAPABILITY`. Indicates that the contact's device has a camera that can be used for video chat (e.g. a front-facing camera on a phone).
`Int`	`CAPABILITY_HAS_VIDEO` An allowed flag of `CHAT_CAPABILITY`. Indicates that the contact's device can display a video feed.
`Int`	`CAPABILITY_HAS_VOICE` An allowed flag of `CHAT_CAPABILITY`. Indicates audio-chat capability (microphone and speaker)
`String`	`CHAT_CAPABILITY` Contact's audio/video chat capability level. Type: INTEGER (one of the values below)
`Int`	`DO_NOT_DISTURB` An allowed value of `PRESENCE`.
`Int`	`IDLE` An allowed value of `PRESENCE`.
`Int`	`INVISIBLE` An allowed value of `PRESENCE`.
`Int`	`OFFLINE` An allowed value of `PRESENCE`.
`String`	`PRESENCE` Contact's latest presence level. Type: INTEGER (one of the values below)
`String`	`PRESENCE_CUSTOM_STATUS`
`String`	`PRESENCE_STATUS`
`String`	`STATUS` Contact latest status update. Type: TEXT
`String`	`STATUS_ICON` The resource ID of the icon for the source of the status update. This resource should be scoped by the `STATUS_RES_PACKAGE`. Type: NUMBER
`String`	`STATUS_LABEL` The resource ID of the label describing the source of the status update, e.g. "Google Talk". This resource should be scoped by the `STATUS_RES_PACKAGE`. Type: NUMBER
`String`	`STATUS_RES_PACKAGE` The package containing resources for this status: label and icon. Type: TEXT
`String`	`STATUS_TIMESTAMP` The absolute time in milliseconds when the latest status was inserted/updated. Type: NUMBER

From class PresenceColumns

`String`	`CUSTOM_PROTOCOL` Name of the custom protocol. Should be supplied along with the `PROTOCOL` value `ContactsContract.CommonDataKinds.Im.PROTOCOL_CUSTOM`. Should be null or omitted if `PROTOCOL` value is not `ContactsContract.CommonDataKinds.Im.PROTOCOL_CUSTOM`. Type: NUMBER
`String`	`DATA_ID` Reference to the `Data._ID` entry that owns this presence. Type: INTEGER
`String`	`IM_ACCOUNT` The IM account for the local user that the presence data came from. Type: TEXT
`String`	`IM_HANDLE` The IM handle the presence item is for. The handle is scoped to `PROTOCOL`. Type: TEXT
`String`	`PROTOCOL` See `CommonDataKinds.Im` for a list of defined protocol constants. Type: NUMBER

Public methods
static Int	`getPresenceIconResourceId(status: Int)` Gets the resource ID for the proper presence icon.
static Int	`getPresencePrecedence(status: Int)` Returns the precedence of the status code the higher number being the higher precedence.

Properties
static Uri!	`CONTENT_URI` The content:// style URI for this table
static Uri!	`PROFILE_CONTENT_URI` The content:// style URI for this table, specific to the user's profile.

Constants

CONTENT_ITEM_TYPE

Added in API level 5

static val CONTENT_ITEM_TYPE: String

The MIME type of a CONTENT_URI subdirectory of a single status update detail.

Value: "vnd.android.cursor.item/status-update"

CONTENT_TYPE

Added in API level 5

static val CONTENT_TYPE: String

The MIME type of CONTENT_URI providing a directory of status update details.

Value: "vnd.android.cursor.dir/status-update"

Public methods

getPresenceIconResourceId

Added in API level 5

static fun getPresenceIconResourceId(status: Int): Int

Gets the resource ID for the proper presence icon.

Parameters
`status`	Int: the status to get the icon for

Return
`Int`	the resource ID for the proper presence icon

getPresencePrecedence

Added in API level 5

static fun getPresencePrecedence(status: Int): Int

Returns the precedence of the status code the higher number being the higher precedence.

Parameters
`status`	Int: The status code.

Return
`Int`	An integer representing the precedence, 0 being the lowest.

Properties

CONTENT_URI

Added in API level 5

static val CONTENT_URI: Uri!

The content:// style URI for this table

PROFILE_CONTENT_URI

Added in API level 14

static val PROFILE_CONTENT_URI: Uri!

The content:// style URI for this table, specific to the user's profile.