README.md
1
2Android BasicContactables Sample
3===================================
4
5This sample shows how to search for contacts, displaying a SearchView in the Action Bar for user input and implementing a query Cursor with CommonDataKinds.Contactables.
6
7Introduction
8------------
9
10This sample displays a [SearchView][1] in the Action Bar when the search icon is clicked. It then implements the [LoaderManager.LoaderCallbacks][2] interface to query the contacts table, using a [CursorLoader][3].
11
12For details on how to implement the [SearchView][1], refer to the training guide [Setting up the search interface][4].
13
14For details on how to implement the [LoaderManager.LoaderCallbacks][2] interface, refer to the [Using the LoaderManager Callbacks][5] guide.
15
16For details on how to query the contacts provider, refer to the [Contacts Provider Access][6] guide.
17
18[1]: http://developer.android.com/reference/android/widget/SearchView.html
19[2]: http://developer.android.com/reference/android/app/LoaderManager.LoaderCallbacks.html
20[3]: http://developer.android.com/reference/android/content/CursorLoader.html
21[4]: http://developer.android.com/training/search/setup.html
22[5]: http://developer.android.com/guide/components/loaders.html#callback
23[6]: http://developer.android.com/guide/topics/providers/contacts-provider.html#Access
24
25Pre-requisites
26--------------
27
28- Android SDK 28
29- Android Build Tools v28.0.3
30- Android Support Repository
31
32Screenshots
33-------------
34
35<img src="screenshots/1-main.png" height="400" alt="Screenshot"/> <img src="screenshots/2-search.png" height="400" alt="Screenshot"/> <img src="screenshots/3-results.png" height="400" alt="Screenshot"/>
36
37Getting Started
38---------------
39
40This sample uses the Gradle build system. To build this project, use the
41"gradlew build" command or use "Import Project" in Android Studio.
42
43Support
44-------
45
46- Google+ Community: https://plus.google.com/communities/105153134372062985968
47- Stack Overflow: http://stackoverflow.com/questions/tagged/android
48
49If you've found an error in this sample, please file an issue:
50https://github.com/googlesamples/android-BasicContactables
51
52Patches are encouraged, and may be submitted by forking this project and
53submitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
54
55License
56-------
57
58Copyright 2019 The Android Open Source Project, Inc.
59
60Licensed to the Apache Software Foundation (ASF) under one or more contributor
61license agreements. See the NOTICE file distributed with this work for
62additional information regarding copyright ownership. The ASF licenses this
63file to you under the Apache License, Version 2.0 (the "License"); you may not
64use this file except in compliance with the License. You may obtain a copy of
65the License at
66
67http://www.apache.org/licenses/LICENSE-2.0
68
69Unless required by applicable law or agreed to in writing, software
70distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
71WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
72License for the specific language governing permissions and limitations under
73the License.
74
