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