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