ContactsContract.Data Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Constants for the data table, which contains data points tied to a raw contact.
[Android.Runtime.Register("android/provider/ContactsContract$Data", DoNotGenerateAcw=true)]
public sealed class ContactsContract.Data : Java.Lang.Object[<Android.Runtime.Register("android/provider/ContactsContract$Data", DoNotGenerateAcw=true)>]
type ContactsContract.Data = class
inherit Object- Inheritance
- Attributes
Remarks
Constants for the data table, which contains data points tied to a raw contact. Each row of the data table is typically used to store a single piece of contact information (such as a phone number) and its associated metadata (such as whether it is a work or home number).
<h3>Data kinds</h3>
Data is a generic table that can hold any kind of contact data. The kind of data stored in a given row is specified by the row's #MIMETYPE value, which determines the meaning of the generic columns #DATA1 through #DATA15. For example, if the data kind is CommonDataKinds.Phone Phone.CONTENT_ITEM_TYPE, then the column #DATA1 stores the phone number, but if the data kind is CommonDataKinds.Email Email.CONTENT_ITEM_TYPE, then #DATA1 stores the email address. Sync adapters and applications can introduce their own data kinds.
ContactsContract defines a small number of pre-defined data kinds, e.g. CommonDataKinds.Phone, CommonDataKinds.Email etc. As a convenience, these classes define data kind specific aliases for DATA1 etc. For example, CommonDataKinds.Phone Phone.NUMBER is the same as ContactsContract.Data Data.DATA1.
#DATA1 is an indexed column and should be used for the data element that is expected to be most frequently used in query selections. For example, in the case of a row representing email addresses #DATA1 should probably be used for the email address itself, while #DATA2 etc can be used for auxiliary information like type of email address.
By convention, #DATA15 is used for storing BLOBs (binary data).
The sync adapter for a given account type must correctly handle every data type used in the corresponding raw contacts. Otherwise it could result in lost or corrupted data.
Similarly, you should refrain from introducing new kinds of data for an other party's account types. For example, if you add a data row for "favorite song" to a raw contact owned by a Google account, it will not get synced to the server, because the Google sync adapter does not know how to handle this data kind. Thus new data kinds are typically introduced along with new account types, i.e. new sync adapters.
<h3>Batch operations</h3>
Data rows can be inserted/updated/deleted using the traditional ContentResolver#insert, ContentResolver#update and ContentResolver#delete methods, however the newer mechanism based on a batch of ContentProviderOperation will prove to be a better choice in almost all cases. All operations in a batch are executed in a single transaction, which ensures that the phone-side and server-side state of a raw contact are always consistent. Also, the batch-based approach is far more efficient: not only are the database operations faster when executed in a single transaction, but also sending a batch of commands to the content provider saves a lot of time on context switching between your process and the process in which the content provider runs.
The flip side of using batched operations is that a large batch may lock up the database for a long time preventing other applications from accessing data and potentially causing ANRs ("Application Not Responding" dialogs.)
To avoid such lockups of the database, make sure to insert "yield points" in the batch. A yield point indicates to the content provider that before executing the next operation it can commit the changes that have already been made, yield to other requests, open another transaction and continue processing operations. A yield point will not automatically commit the transaction, but only if there is another request waiting on the database. Normally a sync adapter should insert a yield point at the beginning of each raw contact operation sequence in the batch. See ContentProviderOperation.Builder#withYieldAllowed(boolean).
<h3>Operations</h3> <dl> <dt><b>Insert</b></dt> <dd>
An individual data row can be inserted using the traditional ContentResolver#insert(Uri, ContentValues) method. Multiple rows should always be inserted as a batch.
An example of a traditional insert:
ContentValues values = new ContentValues();
values.put(Data.RAW_CONTACT_ID, rawContactId);
values.put(Data.MIMETYPE, Phone.CONTENT_ITEM_TYPE);
values.put(Phone.NUMBER, "1-800-GOOG-411");
values.put(Phone.TYPE, Phone.TYPE_CUSTOM);
values.put(Phone.LABEL, "free directory assistance");
Uri dataUri = getContentResolver().insert(Data.CONTENT_URI, values);
The same done using ContentProviderOperations:
ArrayList<ContentProviderOperation> ops =
new ArrayList<ContentProviderOperation>();
ops.add(ContentProviderOperation.newInsert(Data.CONTENT_URI)
.withValue(Data.RAW_CONTACT_ID, rawContactId)
.withValue(Data.MIMETYPE, Phone.CONTENT_ITEM_TYPE)
.withValue(Phone.NUMBER, "1-800-GOOG-411")
.withValue(Phone.TYPE, Phone.TYPE_CUSTOM)
.withValue(Phone.LABEL, "free directory assistance")
.build());
getContentResolver().applyBatch(ContactsContract.AUTHORITY, ops);
</p> <dt><b>Update</b></dt> <dd>
Just as with insert, update can be done incrementally or as a batch, the batch mode being the preferred method:
ArrayList<ContentProviderOperation> ops =
new ArrayList<ContentProviderOperation>();
ops.add(ContentProviderOperation.newUpdate(Data.CONTENT_URI)
.withSelection(Data._ID + "=?", new String[]{String.valueOf(dataId)})
.withValue(Email.DATA, "somebody@android.com")
.build());
getContentResolver().applyBatch(ContactsContract.AUTHORITY, ops);
</p> </dd> <dt><b>Delete</b></dt> <dd>
Just as with insert and update, deletion can be done either using the ContentResolver#delete method or using a ContentProviderOperation:
ArrayList<ContentProviderOperation> ops =
new ArrayList<ContentProviderOperation>();
ops.add(ContentProviderOperation.newDelete(Data.CONTENT_URI)
.withSelection(Data._ID + "=?", new String[]{String.valueOf(dataId)})
.build());
getContentResolver().applyBatch(ContactsContract.AUTHORITY, ops);
</p> </dd> <dt><b>Query</b></dt> <dd>
<dl> <dt>Finding all Data of a given type for a given contact</dt> <dd>
Cursor c = getContentResolver().query(Data.CONTENT_URI,
new String[] {Data._ID, Phone.NUMBER, Phone.TYPE, Phone.LABEL},
Data.CONTACT_ID + "=?" + " AND "
+ Data.MIMETYPE + "='" + Phone.CONTENT_ITEM_TYPE + "'",
new String[] {String.valueOf(contactId)}, null);
</p>
</dd> <dt>Finding all Data of a given type for a given raw contact</dt> <dd>
Cursor c = getContentResolver().query(Data.CONTENT_URI,
new String[] {Data._ID, Phone.NUMBER, Phone.TYPE, Phone.LABEL},
Data.RAW_CONTACT_ID + "=?" + " AND "
+ Data.MIMETYPE + "='" + Phone.CONTENT_ITEM_TYPE + "'",
new String[] {String.valueOf(rawContactId)}, null);
</dd> <dt>Finding all Data for a given raw contact</dt> <dd> Most sync adapters will want to read all data rows for a raw contact along with the raw contact itself. For that you should use the RawContactsEntity. See also RawContacts. </dd> </dl> </p> </dd> </dl> <h2>Columns</h2>
Many columns are available via a Data#CONTENT_URI query. For best performance you should explicitly specify a projection to only those columns that you need.
<table class="jd-sumtable"> <tr> <th colspan='4'>Data</th> </tr> <tr> <td style="width: 7em;">long</td> <td style="width: 20em;">#_ID</td> <td style="width: 5em;">read-only</td> <td>Row ID. Sync adapter should try to preserve row IDs during updates. In other words, it would be a bad idea to delete and reinsert a data row. A sync adapter should always do an update instead.</td> </tr> <tr> <td>String</td> <td>#MIMETYPE</td> <td>read/write-once</td> <td>
The MIME type of the item represented by this row. Examples of common MIME types are: <ul> <li>CommonDataKinds.StructuredName StructuredName.CONTENT_ITEM_TYPE</li> <li>CommonDataKinds.Phone Phone.CONTENT_ITEM_TYPE</li> <li>CommonDataKinds.Email Email.CONTENT_ITEM_TYPE</li> <li>CommonDataKinds.Photo Photo.CONTENT_ITEM_TYPE</li> <li>CommonDataKinds.Organization Organization.CONTENT_ITEM_TYPE</li> <li>CommonDataKinds.Im Im.CONTENT_ITEM_TYPE</li> <li>CommonDataKinds.Nickname Nickname.CONTENT_ITEM_TYPE</li> <li>CommonDataKinds.Note Note.CONTENT_ITEM_TYPE</li> <li>CommonDataKinds.StructuredPostal StructuredPostal.CONTENT_ITEM_TYPE</li> <li>CommonDataKinds.GroupMembership GroupMembership.CONTENT_ITEM_TYPE</li> <li>CommonDataKinds.Website Website.CONTENT_ITEM_TYPE</li> <li>CommonDataKinds.Event Event.CONTENT_ITEM_TYPE</li> <li>CommonDataKinds.Relation Relation.CONTENT_ITEM_TYPE</li> <li>CommonDataKinds.SipAddress SipAddress.CONTENT_ITEM_TYPE</li> </ul>
</td> </tr> <tr> <td>long</td> <td>#RAW_CONTACT_ID</td> <td>read/write-once</td> <td>The id of the row in the RawContacts table that this data belongs to.</td> </tr> <tr> <td>int</td> <td>#IS_PRIMARY</td> <td>read/write</td> <td>Whether this is the primary entry of its kind for the raw contact it belongs to. "1" if true, "0" if false. </td> </tr> <tr> <td>int</td> <td>#IS_SUPER_PRIMARY</td> <td>read/write</td> <td>Whether this is the primary entry of its kind for the aggregate contact it belongs to. Any data record that is "super primary" must also be "primary". For example, the super-primary entry may be interpreted as the default contact value of its kind (for example, the default phone number to use for the contact).</td> </tr> <tr> <td>int</td> <td>#DATA_VERSION</td> <td>read-only</td> <td>The version of this data record. Whenever the data row changes the version goes up. This value is monotonically increasing.</td> </tr> <tr> <td>Any type</td> <td> #DATA1<br> #DATA2<br> #DATA3<br> #DATA4<br> #DATA5<br> #DATA6<br> #DATA7<br> #DATA8<br> #DATA9<br> #DATA10<br> #DATA11<br> #DATA12<br> #DATA13<br> #DATA14<br> #DATA15</td> <td>read/write</td> <td>
Generic data columns. The meaning of each column is determined by the #MIMETYPE. By convention, #DATA15 is used for storing BLOBs (binary data).
Data columns whose meaning is not explicitly defined for a given MIMETYPE should not be used. There is no guarantee that any sync adapter will preserve them. Sync adapters themselves should not use such columns either, but should instead use #SYNC1-#SYNC4.
</td> </tr> <tr> <td>Any type</td> <td> #SYNC1<br> #SYNC2<br> #SYNC3<br> #SYNC4</td> <td>read/write</td> <td>Generic columns for use by sync adapters. For example, a Photo row may store the image URL in SYNC1, a status (not loaded, loading, loaded, error) in SYNC2, server-side version number in SYNC3 and error code in SYNC4.</td> </tr> </table>
Some columns from the most recent associated status update are also available through an implicit join.
<table class="jd-sumtable"> <tr> <th colspan='4'>Join with StatusUpdates</th> </tr> <tr> <td style="width: 7em;">int</td> <td style="width: 20em;">#PRESENCE</td> <td style="width: 5em;">read-only</td> <td>IM presence status linked to this data row. Compare with #CONTACT_PRESENCE, which contains the contact's presence across all IM rows. See StatusUpdates for individual status definitions. The provider may choose not to store this value in persistent storage. The expectation is that presence status will be updated on a regular basis. </td> </tr> <tr> <td>String</td> <td>#STATUS</td> <td>read-only</td> <td>Latest status update linked with this data row.</td> </tr> <tr> <td>long</td> <td>#STATUS_TIMESTAMP</td> <td>read-only</td> <td>The absolute time in milliseconds when the latest status was inserted/updated for this data row.</td> </tr> <tr> <td>String</td> <td>#STATUS_RES_PACKAGE</td> <td>read-only</td> <td>The package containing resources for this status: label and icon.</td> </tr> <tr> <td>long</td> <td>#STATUS_LABEL</td> <td>read-only</td> <td>The resource ID of the label describing the source of status update linked to this data row. This resource is scoped by the #STATUS_RES_PACKAGE.</td> </tr> <tr> <td>long</td> <td>#STATUS_ICON</td> <td>read-only</td> <td>The resource ID of the icon for the source of the status update linked to this data row. This resource is scoped by the #STATUS_RES_PACKAGE.</td> </tr> </table>
Some columns from the associated raw contact are also available through an implicit join. The other columns are excluded as uninteresting in this context.
<table class="jd-sumtable"> <tr> <th colspan='4'>Join with ContactsContract.RawContacts</th> </tr> <tr> <td style="width: 7em;">long</td> <td style="width: 20em;">#CONTACT_ID</td> <td style="width: 5em;">read-only</td> <td>The id of the row in the Contacts table that this data belongs to.</td> </tr> <tr> <td>int</td> <td>#AGGREGATION_MODE</td> <td>read-only</td> <td>See RawContacts.</td> </tr> <tr> <td>int</td> <td>#DELETED</td> <td>read-only</td> <td>See RawContacts.</td> </tr> </table>
The ID column for the associated aggregated contact table ContactsContract.Contacts is available via the implicit join to the RawContacts table, see above. The remaining columns from this table are also available, through an implicit join. This facilitates lookup by the value of a single data element, such as the email address.
<table class="jd-sumtable"> <tr> <th colspan='4'>Join with ContactsContract.Contacts</th> </tr> <tr> <td style="width: 7em;">String</td> <td style="width: 20em;">#LOOKUP_KEY</td> <td style="width: 5em;">read-only</td> <td>See ContactsContract.Contacts</td> </tr> <tr> <td>String</td> <td>#DISPLAY_NAME</td> <td>read-only</td> <td>See ContactsContract.Contacts</td> </tr> <tr> <td>long</td> <td>#PHOTO_ID</td> <td>read-only</td> <td>See ContactsContract.Contacts.</td> </tr> <tr> <td>int</td> <td>#IN_VISIBLE_GROUP</td> <td>read-only</td> <td>See ContactsContract.Contacts.</td> </tr> <tr> <td>int</td> <td>#HAS_PHONE_NUMBER</td> <td>read-only</td> <td>See ContactsContract.Contacts.</td> </tr> <tr> <td>int</td> <td>#STARRED</td> <td>read-only</td> <td>See ContactsContract.Contacts.</td> </tr> <tr> <td>String</td> <td>#CUSTOM_RINGTONE</td> <td>read-only</td> <td>See ContactsContract.Contacts.</td> </tr> <tr> <td>int</td> <td>#SEND_TO_VOICEMAIL</td> <td>read-only</td> <td>See ContactsContract.Contacts.</td> </tr> <tr> <td>int</td> <td>#CONTACT_PRESENCE</td> <td>read-only</td> <td>See ContactsContract.Contacts.</td> </tr> <tr> <td>String</td> <td>#CONTACT_STATUS</td> <td>read-only</td> <td>See ContactsContract.Contacts.</td> </tr> <tr> <td>long</td> <td>#CONTACT_STATUS_TIMESTAMP</td> <td>read-only</td> <td>See ContactsContract.Contacts.</td> </tr> <tr> <td>String</td> <td>#CONTACT_STATUS_RES_PACKAGE</td> <td>read-only</td> <td>See ContactsContract.Contacts.</td> </tr> <tr> <td>long</td> <td>#CONTACT_STATUS_LABEL</td> <td>read-only</td> <td>See ContactsContract.Contacts.</td> </tr> <tr> <td>long</td> <td>#CONTACT_STATUS_ICON</td> <td>read-only</td> <td>See ContactsContract.Contacts.</td> </tr> </table>
Java documentation for android.provider.ContactsContract.Data.
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.
Fields
| ContentType |
The MIME type of the results from |
| ExtraAddressBookIndex | |
| ExtraAddressBookIndexCounts | |
| ExtraAddressBookIndexTitles | |
| VisibleContactsOnly |
A boolean parameter for |
Properties
| Class |
Returns the runtime class of this |
| ContentUri |
The content:// style URI for this table, which requests a directory of data rows matching the selection criteria. |
| Handle |
The handle to the underlying Android instance. (Inherited from Object) |
| JniIdentityHashCode | (Inherited from Object) |
| JniPeerMembers | |
| PeerReference | (Inherited from Object) |
| ThresholdClass |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object) |
| ThresholdType |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object) |
Methods
| Clone() |
Creates and returns a copy of this object. (Inherited from Object) |
| Dispose() | (Inherited from Object) |
| Dispose(Boolean) | (Inherited from Object) |
| Equals(Object) |
Indicates whether some other object is "equal to" this one. (Inherited from Object) |
| GetContactLookupUri(ContentResolver, Uri) |
Build a |
| GetHashCode() |
Returns a hash code value for the object. (Inherited from Object) |
| JavaFinalize() |
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object) |
| Notify() |
Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object) |
| NotifyAll() |
Wakes up all threads that are waiting on this object's monitor. (Inherited from Object) |
| SetHandle(IntPtr, JniHandleOwnership) |
Sets the Handle property. (Inherited from Object) |
| ToArray<T>() | (Inherited from Object) |
| ToString() |
Returns a string representation of the object. (Inherited from Object) |
| UnregisterFromRuntime() | (Inherited from Object) |
| Wait() |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object) |
| Wait(Int64, Int32) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
| Wait(Int64) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
Explicit Interface Implementations
| IJavaPeerable.Disposed() | (Inherited from Object) |
| IJavaPeerable.DisposeUnlessReferenced() | (Inherited from Object) |
| IJavaPeerable.Finalized() | (Inherited from Object) |
| IJavaPeerable.JniManagedPeerState | (Inherited from Object) |
| IJavaPeerable.SetJniIdentityHashCode(Int32) | (Inherited from Object) |
| IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) | (Inherited from Object) |
| IJavaPeerable.SetPeerReference(JniObjectReference) | (Inherited from Object) |
Extension Methods
| JavaCast<TResult>(IJavaObject) |
Performs an Android runtime-checked type conversion. |
| JavaCast<TResult>(IJavaObject) | |
| GetJniTypeName(IJavaPeerable) | |