Windows.Devices.Geolocation.Geofencing Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A geofence is a virtual area around a geographical point. The geofencing APIs enable applications to provide geographically contextual experiences in a timely manner without the need for the app to be continuously running and consuming device resources. Geofencing enables scenarios like popping up a reminder for a user when they are leaving work or home or displaying coupons when the user gets within range of a store.
Apps define areas of interest (geofences) and corresponding trigger conditions, such as triggering when the user enters or exits the geofence. Finally, the app registers to be notified when the trigger conditions are met. Windows and Windows Phone support hundreds of geofences per app. The operating system efficiently manages geofence tracking for all apps. When the trigger conditions for one or more geofences are met, the associated app is alerted even when it is not actively running. This high capacity, power-aware, adaptive geofence tracking system allows you to quickly and easily add location-triggered functionality to your app.
For a complete guide on using geofencing, see Geofencing, start to finish.
The geofencing APIs enable your app to do the following:
- Create one or more geofences, or areas of interest.
- Request to be notified when the device enters a geofence.
- Request to be notified when the device leaves a geofence.
- Specify a time window during which the geofence is active.
- Specify a dwell time for each geofence - the amount of time that the device should be in or out of the geofence before the notification is triggered.
- Dynamically add and remove a geofences from your app's collection of monitored geofences.
- Receive geofence events while the app is active.
- Register with the system to have a background task launch when the state of one of your app's geofences changes. Apps must call RequestAccessAsync before any background tasks will run.
- Use simulator to simulate device movement and test your app's geofencing features.
If you want your app to be launched in the background when the trigger condition for one of its geofences is met, you need to use a background task and set up a LocationTrigger to launch it.
Important
Starting in Windows 10, call the Geolocator object's RequestAccessAsync method before accessing the user’s location. At that time, your app must be in the foreground and RequestAccessAsync must be called from the UI thread. Until the user grants your app permission to access their location, your app can't access location data.
Classes
Geofence |
Contains the functionality to define a geofence (a geographical area of interest) to monitor. |
GeofenceMonitor |
Contains the information about the monitored Geofence objects. |
GeofenceStateChangeReport |
Contains the information about the state changes for a Geofence. |
Enums
GeofenceMonitorStatus |
Indicates the current state of a GeofenceMonitor. |
GeofenceRemovalReason |
Indicates the reason a Geofence was removed. |
GeofenceState |
Indicates the current state of a Geofence. |
MonitoredGeofenceStates |
Indicates the state or states of the Geofences that are currently being monitored by the system. |
Remarks
Location services must be running in order for geofencing to work. If this service is disabled, geofencing calls will fail and throw an exception.
Your app must declare the location capability in the app manifest in order to use geofencing.