summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author Tyler Gunn <tgunn@google.com> 2021-10-12 12:00:31 -0700
committer Tyler Gunn <tgunn@google.com> 2021-10-12 12:00:31 -0700
commit86d27b262be1e67775b871e3f481c60dca1e543b (patch)
treeae7920310cae68904e31e93472387ee02da1e329
parenta9c6fbdff73a616af720f60ee3c8dd8c53446e4a (diff)
Update call log provider docs to clarify how to use LIMIT.
Clarifying that you CANNOT use LIMIT in the where clause and provide instructions on the right way to limit results. Test: Docs only change Bug: 175599057 Change-Id: Ib4e828fc33ae9b75e7a240e9f456907049fcc35e
-rw-r--r--core/java/android/provider/CallLog.java19
1 files changed, 19 insertions, 0 deletions
diff --git a/core/java/android/provider/CallLog.java b/core/java/android/provider/CallLog.java
index 65132f033968..3663fa390daa 100644
--- a/core/java/android/provider/CallLog.java
+++ b/core/java/android/provider/CallLog.java
@@ -76,6 +76,25 @@ public class CallLog {
/**
* Contains the recent calls.
+ * <p>
+ * Note: If you want to query the call log and limit the results to a single value, you should
+ * append the {@link #LIMIT_PARAM_KEY} parameter to the content URI. For example:
+ * <pre>
+ * {@code
+ * getContentResolver().query(
+ * Calls.CONTENT_URI.buildUpon().appendQueryParameter(LIMIT_PARAM_KEY, "1")
+ * .build(),
+ * null, null, null, null);
+ * }
+ * </pre>
+ * <p>
+ * The call log provider enforces strict SQL grammar, so you CANNOT append "LIMIT" to the SQL
+ * query as below:
+ * <pre>
+ * {@code
+ * getContentResolver().query(Calls.CONTENT_URI, null, "LIMIT 1", null, null);
+ * }
+ * </pre>
*/
public static class Calls implements BaseColumns {
/**