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

Added in API level 5

public static final class

ContactsContract.CommonDataKinds.Photo

extends Object
implements ContactsContract.DataColumnsWithJoins

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

Class Overview

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 SYNC1 through 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	Alias	Data column
NUMBER	`PHOTO_FILE_ID`	`DATA14`	ID of the hi-res photo file.
BLOB	`PHOTO`	`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.

[Expand]

Inherited Constants

From interface android.provider.BaseColumns

From interface android.provider.ContactsContract.DataColumns

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

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

Constants

public static final String CONTENT_ITEM_TYPE

Added in API level 5

MIME type used when storing this in data table.

Constant Value: "vnd.android.cursor.item/photo"

public static final String EXTRA_ADDRESS_BOOK_INDEX

Added in API level 21

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"

public static final String EXTRA_ADDRESS_BOOK_INDEX_COUNTS

Added in API level 21

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"

public static final String EXTRA_ADDRESS_BOOK_INDEX_TITLES

Added in API level 21

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"

public static final String PHOTO

Added in API level 5

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"

public static final String PHOTO_FILE_ID

Added in API level 14

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

Type: NUMBER

Constant Value: "data14"

Results

Interfaces

Classes

Exceptions

ContactsContract.CommonDataKinds.Photo

Class Overview

Column aliases

Summary

Constants

public static final String CONTENT_ITEM_TYPE

public static final String EXTRA_ADDRESS_BOOK_INDEX

public static final String EXTRA_ADDRESS_BOOK_INDEX_COUNTS

public static final String EXTRA_ADDRESS_BOOK_INDEX_TITLES

public static final String PHOTO

public static final String PHOTO_FILE_ID