ContactsContract.DataUsageFeedback

public static final class ContactsContract.DataUsageFeedback
extends Object

API allowing applications to send usage information for each ContactsContract.Contacts.Data row to the Contacts Provider. Applications can also clear all usage information.

With the feedback, Contacts Provider may return more contextually appropriate results for Data listing, typically supplied with CONTENT_FILTER_URI, CONTENT_FILTER_URI, CONTENT_FILTER_URI, and users can benefit from better ranked (sorted) lists in applications that show auto-complete list.

There is no guarantee for how this feedback is used, or even whether it is used at all. The ranking algorithm will make best efforts to use the feedback data, but the exact implementation, the storage data structures as well as the resulting sort order is device and version specific and can change over time.

When updating usage information, users of this API need to use update(Uri, ContentValues, String, String[]) with a Uri constructed from FEEDBACK_URI. The Uri must contain one or more data id(s) as its last path. They also need to append a query parameter to the Uri, to specify the type of the communication, which enables the Contacts Provider to differentiate between kinds of interactions using the same contact data field (for example a phone number can be used to make phone calls or send SMS).

Selection and selectionArgs are ignored and must be set to null. To get data ids, you may need to call query(Uri, String[], String, String[], String) toward CONTENT_URI.

update(Uri, ContentValues, String, String[]) returns a positive integer when successful, and returns 0 if no contact with that id was found.

Example:

 Uri uri = DataUsageFeedback.FEEDBACK_URI.buildUpon()
         .appendPath(TextUtils.join(",", dataIds))
         .appendQueryParameter(DataUsageFeedback.USAGE_TYPE,
                 DataUsageFeedback.USAGE_TYPE_CALL)
         .build();
 boolean successful = resolver.update(uri, new ContentValues(), null, null) > 0;
 

Applications can also clear all usage information with:

 boolean successful = resolver.delete(DataUsageFeedback.DELETE_USAGE_URI, null, null) > 0;
 

Summary

Inherited methods

From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long millis, int nanos) Causes the current thread to wait until another thread invokes the notify() method or the notifyAll() method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed. final void wait(long millis) Causes the current thread to wait until either another thread invokes the notify() method or the notifyAll() method for this object, or a specified amount of time has elapsed. final void wait() Causes the current thread to wait until another thread invokes the notify() method or the notifyAll() method for this object.

Constants

String USAGE_TYPE

String USAGE_TYPE_CALL

String USAGE_TYPE_LONG_TEXT

String USAGE_TYPE_SHORT_TEXT

Fields

Uri DELETE_USAGE_URI

Uri FEEDBACK_URI

Public constructors

ContactsContract.DataUsageFeedback ()