ContactsContract.CommonDataKinds.Photo

public static final class ContactsContract.CommonDataKinds.Photo
extends Object implements ContactsContract.DataColumnsWithJoins

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


A data kind representing a photo for the contact.

Some sync adapters will choose to download photos in a separate pass. A common pattern is to use columns ContactsContract.Data#SYNC1 through ContactsContract.Data#SYNC4 to store temporary data, e.g. the image URL or ID, state of download, server-side version of the image. It is allowed for the PHOTO to be null.

You can use all columns defined for ContactsContract.Data as well as the following aliases.

Column aliases

Type AliasData column
NUMBER PHOTO_FILE_ID ContactsContract.DataColumns.DATA14 ID of the hi-res photo file.
BLOB PHOTO ContactsContract.DataColumns.DATA15 By convention, binary data is stored in DATA15. The thumbnail of the photo is stored in this column.

Summary

Constants

String CONTENT_ITEM_TYPE

MIME type used when storing this in data table.

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 PHOTO

Thumbnail photo of the raw contact.

String PHOTO_FILE_ID

Photo file ID for the display photo of the raw contact.

Inherited constants

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

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"

PHOTO

Added in API level 5
public static final String PHOTO

Thumbnail photo of the raw contact. This is the raw bytes of an image that could be inflated using BitmapFactory.

Type: BLOB

Constant Value: "data15"

PHOTO_FILE_ID

Added in API level 14
public static final String PHOTO_FILE_ID

Photo file ID for the display photo of the raw contact. See ContactsContract.DisplayPhoto.

Type: NUMBER

Constant Value: "data14"