xref: /aosp_15_r20/developers/build/prebuilts/gradle/BasicSyncAdapter/README.md (revision d353a188ca6ec4b5eba25b5fbd7bcb8ce61322fb)
1*d353a188SXin Li
2*d353a188SXin LiAndroid BasicSyncAdapter Sample
3*d353a188SXin Li===================================
4*d353a188SXin Li
5*d353a188SXin LiThis sample demonstrates using SyncAdapter to fetch background
6*d353a188SXin Lidata for an app. It covers the creation of the required Service
7*d353a188SXin Lithat the OS uses to initiate the background data sync as well as
8*d353a188SXin Lischeduling syncs with background data.
9*d353a188SXin Li
10*d353a188SXin LiIntroduction
11*d353a188SXin Li------------
12*d353a188SXin Li
13*d353a188SXin LiThis sample demonstrates using SyncAdapter to fetch background data
14*d353a188SXin Lifor an app. SyncAdapters can be used to execute your data transfer
15*d353a188SXin Licode at configurable intervals, while efficiently using battery and
16*d353a188SXin Liother system resources.
17*d353a188SXin Li
18*d353a188SXin LiThis sample implements all the required elements of a sync adapter.
19*d353a188SXin Li- Creates a sync adapter class.
20*d353a188SXin Li- Creates a bound Service which the OS uses to initiate a sync.
21*d353a188SXin Li- Defines the sync adapter properties in an XML resource file.
22*d353a188SXin Li- Declares the bound Service in the app manifest.
23*d353a188SXin Li
24*d353a188SXin LiFor more on SyncAdapters refer to [Transferring Data Using Sync Adapters][1]
25*d353a188SXin Li
26*d353a188SXin Li[1]: http://developer.android.com/training/sync-adapters/index.html
27*d353a188SXin Li
28*d353a188SXin LiPre-requisites
29*d353a188SXin Li--------------
30*d353a188SXin Li
31*d353a188SXin Li- Android SDK 27
32*d353a188SXin Li- Android Build Tools v27.0.2
33*d353a188SXin Li- Android Support Repository
34*d353a188SXin Li
35*d353a188SXin LiScreenshots
36*d353a188SXin Li-------------
37*d353a188SXin Li
38*d353a188SXin Li<img src="screenshots/main.png" height="400" alt="Screenshot"/>
39*d353a188SXin Li
40*d353a188SXin LiGetting Started
41*d353a188SXin Li---------------
42*d353a188SXin Li
43*d353a188SXin LiThis sample uses the Gradle build system. To build this project, use the
44*d353a188SXin Li"gradlew build" command or use "Import Project" in Android Studio.
45*d353a188SXin Li
46*d353a188SXin LiSupport
47*d353a188SXin Li-------
48*d353a188SXin Li
49*d353a188SXin Li- Google+ Community: https://plus.google.com/communities/105153134372062985968
50*d353a188SXin Li- Stack Overflow: http://stackoverflow.com/questions/tagged/android
51*d353a188SXin Li
52*d353a188SXin LiIf you've found an error in this sample, please file an issue:
53*d353a188SXin Lihttps://github.com/googlesamples/android-BasicSyncAdapter
54*d353a188SXin Li
55*d353a188SXin LiPatches are encouraged, and may be submitted by forking this project and
56*d353a188SXin Lisubmitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
57*d353a188SXin Li
58*d353a188SXin LiLicense
59*d353a188SXin Li-------
60*d353a188SXin Li
61*d353a188SXin LiCopyright 2017 The Android Open Source Project, Inc.
62*d353a188SXin Li
63*d353a188SXin LiLicensed to the Apache Software Foundation (ASF) under one or more contributor
64*d353a188SXin Lilicense agreements.  See the NOTICE file distributed with this work for
65*d353a188SXin Liadditional information regarding copyright ownership.  The ASF licenses this
66*d353a188SXin Lifile to you under the Apache License, Version 2.0 (the "License"); you may not
67*d353a188SXin Liuse this file except in compliance with the License.  You may obtain a copy of
68*d353a188SXin Lithe License at
69*d353a188SXin Li
70*d353a188SXin Lihttp://www.apache.org/licenses/LICENSE-2.0
71*d353a188SXin Li
72*d353a188SXin LiUnless required by applicable law or agreed to in writing, software
73*d353a188SXin Lidistributed under the License is distributed on an "AS IS" BASIS, WITHOUT
74*d353a188SXin LiWARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
75*d353a188SXin LiLicense for the specific language governing permissions and limitations under
76*d353a188SXin Lithe License.
77