xref: /aosp_15_r20/developers/build/prebuilts/gradle/Geofencing/README.md (revision d353a188ca6ec4b5eba25b5fbd7bcb8ce61322fb)
1*d353a188SXin Li
2*d353a188SXin LiAndroid Geofencing Sample
3*d353a188SXin Li===================================
4*d353a188SXin Li
5*d353a188SXin LiWhen the user enters the vicinity of the Android building (B44) or the Yerba Buena
6*d353a188SXin LiGardens near the Moscone center in San Francisco, a notification silently appears on their
7*d353a188SXin Liwearable with an option to check in. This notification automatically disappears when they leave
8*d353a188SXin Lithe area, and reappears the next time they are at one of these locations.
9*d353a188SXin Li
10*d353a188SXin LiIntroduction
11*d353a188SXin Li------------
12*d353a188SXin Li
13*d353a188SXin LiGeofencing combines awareness of the user's current location with awareness of
14*d353a188SXin Linearby features, defined as the user's proximity to locations that may be of
15*d353a188SXin Liinterest. To mark a location of interest, you specify its latitude and longitude.
16*d353a188SXin LiTo adjust the proximity for the location, you add a radius. The latitude,
17*d353a188SXin Lilongitude, and radius define a geofence. You can have multiple active
18*d353a188SXin Ligeofences at one time.
19*d353a188SXin Li
20*d353a188SXin LiTo use geofencing, start by defining the geofences you want to monitor.
21*d353a188SXin LiAlthough you usually store geofence data in a local database or download
22*d353a188SXin Liit from the network, you need to send a geofence to Location Services as
23*d353a188SXin Lian instance of [Geofence][2], which you create with `Geofence.Builder`. Each
24*d353a188SXin LiGeofence object contains the following information:
25*d353a188SXin Li
26*d353a188SXin Li1. Latitude, longitude, and radius
27*d353a188SXin Li2. Expiration time
28*d353a188SXin Li3. Transition type
29*d353a188SXin Li4. Geofence ID
30*d353a188SXin Li
31*d353a188SXin LiRead more about geofences in [Creating and Monitoring Geofences][1].
32*d353a188SXin Li
33*d353a188SXin Li[1]:http://developer.android.com/training/location/geofencing.html
34*d353a188SXin Li[2]:http://developer.android.com/reference/com/google/android/gms/location/Geofence.html
35*d353a188SXin Li
36*d353a188SXin LiPre-requisites
37*d353a188SXin Li--------------
38*d353a188SXin Li
39*d353a188SXin Li- Android SDK 27
40*d353a188SXin Li- Android Build Tools v27.0.2
41*d353a188SXin Li- Android Support Repository
42*d353a188SXin Li
43*d353a188SXin LiScreenshots
44*d353a188SXin Li-------------
45*d353a188SXin Li
46*d353a188SXin Li<img src="screenshots/android_building_check_in.png" height="400" alt="Screenshot"/>
47*d353a188SXin Li
48*d353a188SXin LiGetting Started
49*d353a188SXin Li---------------
50*d353a188SXin Li
51*d353a188SXin LiThis sample uses the Gradle build system. To build this project, use the
52*d353a188SXin Li"gradlew build" command or use "Import Project" in Android Studio.
53*d353a188SXin Li
54*d353a188SXin LiSupport
55*d353a188SXin Li-------
56*d353a188SXin Li
57*d353a188SXin Li- Google+ Community: https://plus.google.com/communities/105153134372062985968
58*d353a188SXin Li- Stack Overflow: http://stackoverflow.com/questions/tagged/android
59*d353a188SXin Li
60*d353a188SXin LiIf you've found an error in this sample, please file an issue:
61*d353a188SXin Lihttps://github.com/googlesamples/android-Geofencing
62*d353a188SXin Li
63*d353a188SXin LiPatches are encouraged, and may be submitted by forking this project and
64*d353a188SXin Lisubmitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
65*d353a188SXin Li
66*d353a188SXin LiLicense
67*d353a188SXin Li-------
68*d353a188SXin Li
69*d353a188SXin LiCopyright 2017 The Android Open Source Project, Inc.
70*d353a188SXin Li
71*d353a188SXin LiLicensed to the Apache Software Foundation (ASF) under one or more contributor
72*d353a188SXin Lilicense agreements.  See the NOTICE file distributed with this work for
73*d353a188SXin Liadditional information regarding copyright ownership.  The ASF licenses this
74*d353a188SXin Lifile to you under the Apache License, Version 2.0 (the "License"); you may not
75*d353a188SXin Liuse this file except in compliance with the License.  You may obtain a copy of
76*d353a188SXin Lithe License at
77*d353a188SXin Li
78*d353a188SXin Lihttp://www.apache.org/licenses/LICENSE-2.0
79*d353a188SXin Li
80*d353a188SXin LiUnless required by applicable law or agreed to in writing, software
81*d353a188SXin Lidistributed under the License is distributed on an "AS IS" BASIS, WITHOUT
82*d353a188SXin LiWARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
83*d353a188SXin LiLicense for the specific language governing permissions and limitations under
84*d353a188SXin Lithe License.
85