Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Added callouts related to obsolete contacts data fields.

Browse Source 
Also added callouts for fields that no longer sort results based on
contacts frequency.

Test: make ds-docs -j32

Bug: 116422556
Change-Id: Iddcd0b41b6ad991423a5ced78522a9ab2ad831a1
Original-Change-Id: I738e08bd4686e30b875fa37123ecebb4a5e179d3
This commit is contained in:
Kevin Hufnagle
2018-10-01 07:04:44 -07:00
parent 97267fe833
commit 94b9e05f76
1 changed files with 105 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

120
core/java/android/provider/ContactsContract.java
View File

@@ -868,7 +868,11 @@ public final class ContactsContract {
*/
protected interface ContactOptionsColumns {
/**
* The number of times a contact has been contacted
* The number of times a contact has been contacted.
* <p class="caution"><b>Caution: </b>As of January 7, 2019, this field is obsolete. For
* more information, see the
* <a href="/guide/topics/providers/contacts-provider#ObsoleteData">Contacts Provider</a>
* page.</p>
* <P>Type: INTEGER</P>
*
* @deprecated Contacts affinity information is no longer supported as of
@@ -880,6 +884,10 @@ public final class ContactsContract {
/**
* The last time a contact was contacted.
* <p class="caution"><b>Caution: </b>As of January 7, 2019, this field is obsolete. For
* more information, see the
* <a href="/guide/topics/providers/contacts-provider#ObsoleteData">Contacts Provider</a>
* page.</p>
* <P>Type: INTEGER</P>
*
* @deprecated Contacts affinity information is no longer supported as of
@@ -1682,6 +1690,11 @@ public final class ContactsContract {
* TIMES_CONTACTED field is incremented by 1 and the LAST_TIME_CONTACTED
* field is populated with the current system time.
*
* <p class="caution"><b>Caution: </b>As of January 7, 2019, this method is obsolete. For
* more information, see the
* <a href="/guide/topics/providers/contacts-provider#ObsoleteData">Contacts Provider</a>
* page.
*
* @param resolver the ContentResolver to use
* @param contactId the person who was contacted
*
@@ -1715,6 +1728,11 @@ public final class ContactsContract {
* {@link ContactsContract.Data}, filtered to include only starred contacts.
* Frequent contacts are no longer included in the result as of
* Android version {@link android.os.Build.VERSION_CODES#Q}.
*
* <p class="caution"><b>Caution: </b>As of January 7, 2019, this field no longer sorts
* results based on contacts frequency. For more information, see the
* <a href="/guide/topics/providers/contacts-provider#ObsoleteData">Contacts Provider</a>
* page.
*/
public static final Uri CONTENT_STREQUENT_URI = Uri.withAppendedPath(
CONTENT_URI, "strequent");
@@ -1725,16 +1743,26 @@ public final class ContactsContract {
* @deprecated Frequent contacts are no longer supported as of
* Android version {@link android.os.Build.VERSION_CODES#Q}.
* This URI always returns an empty cursor.
*
* <p class="caution"><b>Caution: </b>As of January 7, 2019, this field no longer sorts
* results based on contacts frequency. For more information, see the
* <a href="/guide/topics/providers/contacts-provider#ObsoleteData">Contacts Provider</a>
* page.
*/
@Deprecated
public static final Uri CONTENT_FREQUENT_URI = Uri.withAppendedPath(
CONTENT_URI, "frequent");
/**
* The content:// style URI used for "type-to-filter" functionality on the
* <p>The content:// style URI used for "type-to-filter" functionality on the
* {@link #CONTENT_STREQUENT_URI} URI. The filter string will be used to match
* various parts of the contact name. The filter argument should be passed
* as an additional path segment after this URI.
*
* <p class="caution"><b>Caution: </b>As of January 7, 2019, this field no longer sorts
* results based on contacts frequency. For more information, see the
* <a href="/guide/topics/providers/contacts-provider#ObsoleteData">Contacts Provider</a>
* page.
*/
public static final Uri CONTENT_STREQUENT_FILTER_URI = Uri.withAppendedPath(
CONTENT_STREQUENT_URI, "filter");
@@ -4262,6 +4290,11 @@ public final class ContactsContract {
* @deprecated Contacts affinity information is no longer supported as of
* Android version {@link android.os.Build.VERSION_CODES#Q}.
* This column always contains 0.
*
* <p class="caution"><b>Caution: </b>As of January 7, 2019, this field is obsolete.
* For more information, see the
* <a href="/guide/topics/providers/contacts-provider#ObsoleteData">Contacts Provider</a>
* page.
*/
@Deprecated
public static final String LAST_TIME_USED = "last_time_used";
@@ -4271,6 +4304,11 @@ public final class ContactsContract {
* @deprecated Contacts affinity information is no longer supported as of
* Android version {@link android.os.Build.VERSION_CODES#Q}.
* This column always contains 0.
*
* <p class="caution"><b>Caution: </b>As of January 7, 2019, this field is obsolete.
* For more information, see the
* <a href="/guide/topics/providers/contacts-provider#ObsoleteData">Contacts Provider</a>
* page.
*/
@Deprecated
public static final String TIMES_USED = "times_used";
@@ -5218,7 +5256,14 @@ public final class ContactsContract {
private PhoneLookup() {}
/**
* The content:// style URI for this table. Append the phone number you want to lookup
* The content:// style URI for this table.
*
* <p class="caution"><b>Caution: </b>As of January 7, 2019, this field no longer
* sorts results based on contacts frequency. For more information, see the
* <a href="/guide/topics/providers/contacts-provider#ObsoleteData">Contacts Provider</a>
* page.
*
* Append the phone number you want to lookup
* to this URI and query it to perform a lookup. For example:
* <pre>
* Uri lookupUri = Uri.withAppendedPath(PhoneLookup.CONTENT_FILTER_URI,
@@ -5231,6 +5276,11 @@ public final class ContactsContract {
/**
* <p>URI used for the "enterprise caller-id".</p>
*
* <p class="caution"><b>Caution: </b>As of January 7, 2019, this field no longer
* sorts results based on contacts frequency. For more information, see the
* <a href="/guide/topics/providers/contacts-provider#ObsoleteData">Contacts Provider</a>
* page.
*
* <p>
* It supports the same semantics as {@link #CONTENT_FILTER_URI} and returns the same
* columns. If the device has no corp profile that is linked to the current profile, it
@@ -6023,18 +6073,28 @@ public final class ContactsContract {
Uri.withAppendedPath(Data.ENTERPRISE_CONTENT_URI, "phones");
/**
* The content:// style URL for phone lookup using a filter. The filter returns
* <p>The content:// style URL for phone lookup using a filter. The filter returns
* records of MIME type {@link #CONTENT_ITEM_TYPE}. The filter is applied
* to display names as well as phone numbers. The filter argument should be passed
* as an additional path segment after this URI.
*
* <p class="caution"><b>Caution: </b>As of January 7, 2019, this field no longer
* sorts results based on contacts frequency. For more information, see the
* <a href="/guide/topics/providers/contacts-provider#ObsoleteData">Contacts Provider</a>
* page.
*/
public static final Uri CONTENT_FILTER_URI = Uri.withAppendedPath(CONTENT_URI,
"filter");
/**
* It supports the similar semantics as {@link #CONTENT_FILTER_URI} and returns the same
* columns. This URI requires {@link ContactsContract#DIRECTORY_PARAM_KEY} in
* <p>It supports the similar semantics as {@link #CONTENT_FILTER_URI} and returns the
* same columns. This URI requires {@link ContactsContract#DIRECTORY_PARAM_KEY} in
* parameters, otherwise it will throw IllegalArgumentException.
*
* <p class="caution"><b>Caution: </b>As of January 7, 2019, this field no longer sorts
* results based on contacts frequency. For more information, see the
* <a href="/guide/topics/providers/contacts-provider#ObsoleteData">Contacts Provider</a>
* page.
*/
public static final Uri ENTERPRISE_CONTENT_FILTER_URI = Uri.withAppendedPath(
CONTENT_URI, "filter_enterprise");
@@ -6202,7 +6262,7 @@ public final class ContactsContract {
*/
public static final class Email implements DataColumnsWithJoins, CommonColumns,
ContactCounts {
/**
/*
* This utility class cannot be instantiated
*/
private Email() {}
@@ -6293,12 +6353,17 @@ public final class ContactsContract {
Uri.withAppendedPath(CONTENT_URI, "lookup_enterprise");
/**
* <p>
* The content:// style URL for email lookup using a filter. The filter returns
* <p>The content:// style URL for email lookup using a filter. The filter returns
* records of MIME type {@link #CONTENT_ITEM_TYPE}. The filter is applied
* to display names as well as email addresses. The filter argument should be passed
* as an additional path segment after this URI.
* </p>
*
* <p class="caution"><b>Caution: </b>As of January 7, 2019, this field no longer sorts
* results based on contacts frequency. For more information, see the
* <a href="/guide/topics/providers/contacts-provider#ObsoleteData">Contacts Provider</a>
* page.</p>
*
* <p>The query in the following example will return "Robert Parr (bob@incredibles.com)"
* as well as "Bob Parr (incredible@android.com)".
* <pre>
@@ -6313,9 +6378,14 @@ public final class ContactsContract {
"filter");
/**
* It supports the similar semantics as {@link #CONTENT_FILTER_URI} and returns the same
* columns. This URI requires {@link ContactsContract#DIRECTORY_PARAM_KEY} in
* <p>It supports the similar semantics as {@link #CONTENT_FILTER_URI} and returns the
* same columns. This URI requires {@link ContactsContract#DIRECTORY_PARAM_KEY} in
* parameters, otherwise it will throw IllegalArgumentException.
*
* <p class="caution"><b>Caution: </b>As of January 7, 2019, this field no longer
* sorts results based on contacts frequency. For more information, see the
* <a href="/guide/topics/providers/contacts-provider#ObsoleteData">Contacts Provider</a>
* page.
*/
public static final Uri ENTERPRISE_CONTENT_FILTER_URI = Uri.withAppendedPath(
CONTENT_URI, "filter_enterprise");
@@ -7528,16 +7598,26 @@ public final class ContactsContract {
public static final Uri CONTENT_URI = Uri.withAppendedPath(Data.CONTENT_URI,
"callables");
/**
* Similar to {@link Phone#CONTENT_FILTER_URI}, but allows users to filter callable
* <p>Similar to {@link Phone#CONTENT_FILTER_URI}, but allows users to filter callable
* data.
*
* <p class="caution"><b>Caution: </b>As of January 7, 2019, this field no longer
* sorts results based on contacts frequency. For more information, see the
* <a href="/guide/topics/providers/contacts-provider#ObsoleteData">Contacts Provider</a>
* page.
*/
public static final Uri CONTENT_FILTER_URI = Uri.withAppendedPath(CONTENT_URI,
"filter");
/**
* Similar to {@link Phone#ENTERPRISE_CONTENT_FILTER_URI}, but allows users to filter
* <p>Similar to {@link Phone#ENTERPRISE_CONTENT_FILTER_URI}, but allows users to filter
* callable data. This URI requires {@link ContactsContract#DIRECTORY_PARAM_KEY} in
* parameters, otherwise it will throw IllegalArgumentException.
*
* <p class="caution"><b>Caution: </b>As of January 7, 2019, this field no longer
* sorts results based on contacts frequency. For more information, see the
* <a href="/guide/topics/providers/contacts-provider#ObsoleteData">Contacts Provider</a>
* page.</p>
*/
public static final Uri ENTERPRISE_CONTENT_FILTER_URI = Uri.withAppendedPath(
CONTENT_URI, "filter_enterprise");
@@ -7562,8 +7642,13 @@ public final class ContactsContract {
"contactables");
/**
* The content:// style URI for these data items, which allows for a query parameter to
* be appended onto the end to filter for data items matching the query.
* <p>The content:// style URI for these data items, which allows for a query parameter
* to be appended onto the end to filter for data items matching the query.
*
* <p class="caution"><b>Caution: </b>As of January 7, 2019, this field no longer
* sorts results based on contacts frequency. For more information, see the
* <a href="/guide/topics/providers/contacts-provider#ObsoleteData">Contacts Provider</a>
* page.
*/
public static final Uri CONTENT_FILTER_URI = Uri.withAppendedPath(
Contactables.CONTENT_URI, "filter");
@@ -8212,6 +8297,11 @@ public final class ContactsContract {
}
/**
* <p class="caution"><b>Caution: </b>As of January 7, 2019, this class is obsolete. For
* more information, see the
* <a href="/guide/topics/providers/contacts-provider#ObsoleteData">Contacts Provider</a>
* page.
* </p>
* <p>
* API allowing applications to send usage information for each {@link Data} row to the
* Contacts Provider. Applications can also clear all usage information.