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