ContactsContract.StreamItems

Class Overview

Constants for the stream_items table, which contains social stream updates from the user's contact list.

Only a certain number of stream items will ever be stored under a given raw contact. Users of this API can query CONTENT_LIMIT_URI to determine this limit, and should restrict the number of items inserted in any given transaction correspondingly. Insertion of more items beyond the limit will automatically lead to deletion of the oldest items, by TIMESTAMP.

Access to the social stream through these URIs requires additional permissions beyond the read/write contact permissions required by the provider. Querying for social stream data requires android.permission.READ_SOCIAL_STREAM permission, and inserting or updating social stream items requires android.permission.WRITE_SOCIAL_STREAM permission.

Account check

The content URIs to the insert, update and delete operations are required to have the account information matching that of the owning raw contact as query parameters, namely ACCOUNT_TYPE and ACCOUNT_NAME. DATA_SET isn't required.

Operations

Insert

Social stream updates are always associated with a raw contact. There are a couple of ways to insert these entries.

Via the CONTENT_DIRECTORY sub-path of a raw contact:

 ContentValues values = new ContentValues();
 values.put(StreamItems.TEXT, "Breakfasted at Tiffanys");
 values.put(StreamItems.TIMESTAMP, timestamp);
 values.put(StreamItems.COMMENTS, "3 people reshared this");
 Uri.Builder builder = RawContacts.CONTENT_URI.buildUpon();
 ContentUris.appendId(builder, rawContactId);
 builder.appendEncodedPath(RawContacts.StreamItems.CONTENT_DIRECTORY);
 builder.appendQueryParameter(RawContacts.ACCOUNT_NAME, accountName);
 builder.appendQueryParameter(RawContacts.ACCOUNT_TYPE, accountType);
 Uri streamItemUri = getContentResolver().insert(builder.build(), values);
 long streamItemId = ContentUris.parseId(streamItemUri);
 

Via CONTENT_URI:

 ContentValues values = new ContentValues();
 values.put(StreamItems.RAW_CONTACT_ID, rawContactId);
 values.put(StreamItems.TEXT, "Breakfasted at Tiffanys");
 values.put(StreamItems.TIMESTAMP, timestamp);
 values.put(StreamItems.COMMENTS, "3 people reshared this");
 Uri.Builder builder = StreamItems.CONTENT_URI.buildUpon();
 builder.appendQueryParameter(RawContacts.ACCOUNT_NAME, accountName);
 builder.appendQueryParameter(RawContacts.ACCOUNT_TYPE, accountType);
 Uri streamItemUri = getContentResolver().insert(builder.build(), values);
 long streamItemId = ContentUris.parseId(streamItemUri);

Once a ContactsContract.Contacts.StreamItems entry has been inserted, photos associated with that social update can be inserted. For example, after one of the insertions above, photos could be added to the stream item in one of the following ways:

Via a URI including the stream item ID:

 values.clear();
 values.put(StreamItemPhotos.SORT_INDEX, 1);
 values.put(StreamItemPhotos.PHOTO, photoData);
 getContentResolver().insert(Uri.withAppendedPath(
     ContentUris.withAppendedId(StreamItems.CONTENT_URI, streamItemId),
     StreamItems.StreamItemPhotos.CONTENT_DIRECTORY), values);
 

Via CONTENT_PHOTO_URI:

 values.clear();
 values.put(StreamItemPhotos.STREAM_ITEM_ID, streamItemId);
 values.put(StreamItemPhotos.SORT_INDEX, 1);
 values.put(StreamItemPhotos.PHOTO, photoData);
 getContentResolver().insert(StreamItems.CONTENT_PHOTO_URI, values);
 

Note that this latter form allows the insertion of a stream item and its photos in a single transaction, by using ContentProviderOperation with back references to populate the stream item ID in the ContentValues.

Update

Updates can be performed by appending the stream item ID to the CONTENT_URI URI. Only social stream entries that were created by the calling package can be updated.

Delete

Deletes can be performed by appending the stream item ID to the CONTENT_URI URI. Only social stream entries that were created by the calling package can be deleted.

Query

Finding all social stream updates for a given contact

By Contact ID:

 Cursor c = getContentResolver().query(Uri.withAppendedPath(
          ContentUris.withAppendedId(Contacts.CONTENT_URI, contactId),
          Contacts.StreamItems.CONTENT_DIRECTORY),
          null, null, null, null);
 

By lookup key:

 Cursor c = getContentResolver().query(Contacts.CONTENT_URI.buildUpon()
          .appendPath(lookupKey)
          .appendPath(Contacts.StreamItems.CONTENT_DIRECTORY).build(),
          null, null, null, null);
 

Finding all social stream updates for a given raw contact

 Cursor c = getContentResolver().query(Uri.withAppendedPath(
          ContentUris.withAppendedId(RawContacts.CONTENT_URI, rawContactId),
          RawContacts.StreamItems.CONTENT_DIRECTORY)),
          null, null, null, null);
 

Querying for a specific stream item by ID

 Cursor c = getContentResolver().query(ContentUris.withAppendedId(
          StreamItems.CONTENT_URI, streamItemId),
          null, null, null, null);
 

Summary

[Expand] Inherited Constants
From interface android.provider.BaseColumns String _COUNT The count of rows in a directory. String _ID The unique ID for a row.
From interface android.provider.ContactsContract.StreamItemsColumns String ACCOUNT_NAME The account name to which the raw_contact of this item is associated. String ACCOUNT_TYPE The account type to which the raw_contact of this item is associated. String COMMENTS Summary information about the stream item, for example to indicate how many people have reshared it, how many have liked it, how many thumbs up and/or thumbs down it has, what the original source was, etc. String CONTACT_ID A reference to the _ID that this stream item belongs to. String CONTACT_LOOKUP_KEY A reference to the LOOKUP_KEY that this stream item belongs to. String DATA_SET The data set within the account that the raw_contact of this row belongs to. String RAW_CONTACT_ID A reference to the _ID that this stream item belongs to. String RAW_CONTACT_SOURCE_ID The source_id of the raw_contact that this row belongs to. String RES_ICON The resource name of the icon for the source of the stream item. String RES_LABEL The resource name of the label describing the source of the status update, e.g. String RES_PACKAGE The package name to use when creating Resources objects for this stream item. 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. String TEXT The main textual contents of the item. String TIMESTAMP The absolute time (milliseconds since epoch) when this stream item was inserted/updated.

[Expand] Inherited Methods

From class java.lang.Object Object clone() Creates and returns a copy of this Object. boolean equals(Object o) Compares this instance with the specified object and indicates if they are equal. void finalize() Invoked when the garbage collector has detected that this instance is no longer reachable. final Class<?> getClass() Returns the unique instance of Class that represents this object's class. int hashCode() Returns an integer hash code for this object. final void notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up. final void notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up. String toString() Returns a string containing a concise, human-readable description of this object. final void wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object. final void wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires. final void wait(long millis) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.