xref: /aosp_15_r20/developers/build/prebuilts/gradle/ContentProviderPaging/README.md (revision d353a188ca6ec4b5eba25b5fbd7bcb8ce61322fb)
1*d353a188SXin Li
2*d353a188SXin LiAndroid ContentProviderPaging Sample
3*d353a188SXin Li===================================
4*d353a188SXin Li
5*d353a188SXin LiThis sample demonstrates how to use the ContentProvider with paging support introduced
6*d353a188SXin Liin Android O. The ContentProvider now accepts additional arguments for the offset and
7*d353a188SXin Lithe limit in the query method to support paging instead of fetching all the data in
8*d353a188SXin Lia single query method call.
9*d353a188SXin Li
10*d353a188SXin LiIntroduction
11*d353a188SXin Li------------
12*d353a188SXin Li
13*d353a188SXin Li[ContentProvider][1] and [DocumentsProvider][2] now supports paging instead of fetching the all
14*d353a188SXin Lidata at once.
15*d353a188SXin Li
16*d353a188SXin LiStarting from Android O, ContentProvider#query(Uri, String[], Bundle, CancellationSignal) and
17*d353a188SXin LiDocumentsProvider#query(Uri, String[], Bundle, CancellationSignal) methods are introduced.
18*d353a188SXin LiThe Bundle accepts the keys for ContentResolver.QUERY_ARG_OFFSET as an starting offset and
19*d353a188SXin LiContentResolver.QUERY_ARG_LIMIT as the number of items included in the returned Cursor object.
20*d353a188SXin Li
21*d353a188SXin LiSimilarly, the returned Cursor object now has a Bundle object obtained by Cursor#getExtras().
22*d353a188SXin LiThe Bundle is able to include data such as the  total size of the underlying data set.
23*d353a188SXin Li
24*d353a188SXin Li[1]: https://developer.android.com/reference/android/content/ContentProvider.html
25*d353a188SXin Li[2]: https://developer.android.com/reference/android/provider/DocumentsProvider.html
26*d353a188SXin Li
27*d353a188SXin LiPre-requisites
28*d353a188SXin Li--------------
29*d353a188SXin Li
30*d353a188SXin Li- Android SDK 27
31*d353a188SXin Li- Android Build Tools v27.0.2
32*d353a188SXin Li- Android Support Repository
33*d353a188SXin Li
34*d353a188SXin LiScreenshots
35*d353a188SXin Li-------------
36*d353a188SXin Li
37*d353a188SXin Li<img src="screenshots/screenshot-1.png" height="400" alt="Screenshot"/>
38*d353a188SXin Li
39*d353a188SXin LiGetting Started
40*d353a188SXin Li---------------
41*d353a188SXin Li
42*d353a188SXin LiThis sample uses the Gradle build system. To build this project, use the
43*d353a188SXin Li"gradlew build" command or use "Import Project" in Android Studio.
44*d353a188SXin Li
45*d353a188SXin LiSupport
46*d353a188SXin Li-------
47*d353a188SXin Li
48*d353a188SXin Li- Google+ Community: https://plus.google.com/communities/105153134372062985968
49*d353a188SXin Li- Stack Overflow: http://stackoverflow.com/questions/tagged/android
50*d353a188SXin Li
51*d353a188SXin LiIf you've found an error in this sample, please file an issue:
52*d353a188SXin Lihttps://github.com/googlesamples/android-ContentProviderPaging
53*d353a188SXin Li
54*d353a188SXin LiPatches are encouraged, and may be submitted by forking this project and
55*d353a188SXin Lisubmitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
56*d353a188SXin Li
57*d353a188SXin LiLicense
58*d353a188SXin Li-------
59*d353a188SXin Li
60*d353a188SXin LiCopyright 2017 The Android Open Source Project, Inc.
61*d353a188SXin Li
62*d353a188SXin LiLicensed to the Apache Software Foundation (ASF) under one or more contributor
63*d353a188SXin Lilicense agreements.  See the NOTICE file distributed with this work for
64*d353a188SXin Liadditional information regarding copyright ownership.  The ASF licenses this
65*d353a188SXin Lifile to you under the Apache License, Version 2.0 (the "License"); you may not
66*d353a188SXin Liuse this file except in compliance with the License.  You may obtain a copy of
67*d353a188SXin Lithe License at
68*d353a188SXin Li
69*d353a188SXin Lihttp://www.apache.org/licenses/LICENSE-2.0
70*d353a188SXin Li
71*d353a188SXin LiUnless required by applicable law or agreed to in writing, software
72*d353a188SXin Lidistributed under the License is distributed on an "AS IS" BASIS, WITHOUT
73*d353a188SXin LiWARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
74*d353a188SXin LiLicense for the specific language governing permissions and limitations under
75*d353a188SXin Lithe License.
76