Namespace Tizen.Location.Geofence

Description

The Tizen.Location.Geofence namespace provides classes for virtual perimeter.

Overview

This API provides functions to set the gofence with a geopoint, MAC address of Wi-Fi, and Bluetooth address. Also, notifications on events like changing in service status are provided.

There are two kinds of places and fences:

  • Public places and fences that are created by the MyPlace application can be used by all applications.
  • Private places and fences that are created by the specified application can be used by the same application.

Notifications can be received about the following events:

  • Zone in when a device enters a specific area.
  • Zone out when a device exits a specific area.
  • Results and errors for each event requested to geofence module.

The Geofence manager has the following properties:

  • The geofence type.
  • The status.
  • 'Service state change' callback

To guarantee that the geofence application runs on a device with the geofence profile feature, declare the following feature requirements in the config file:

Classes

Fence

Geofence defines a virtual perimeter for a real-world geographic area. If you create a geofence, you can trigger some activities when a device enters (or exits) the geofences defined by you. You can create a geofence with the information of the Geopoint, Wi-Fi, or BT.

  • Geopoint: Geofence is specified by the coordinates (Latitude and Longitude) and radius.
  • WIFI: Geofence is specified by the BSSID of the Wi-Fi access point.
  • BT: Geofence is specified by the Bluetooth address.
The Basic service set identifier (BSSID) is the MAC address of the wireless access point (WAP) generated by combining the 24-bit Organization Unique Identifier (the manufacturer's identity) and the manufacturer's assigned 24-bit identifier for the radio chipset in the WAP.

FenceData

Represents the geofence list item data.

FenceStatus

The geofence status describes the current state and duration of a geofence.

  • State: The state is specified by the current state of the fence.
  • Duration: Geofence is specified by the duration of the current state.

GeofenceManager

The Geofence Manager API provides service related to geofence (geo-fence). Geofence is a virtual perimeter for a real-world geographic area. This API provides functions to set geofence with a geopoint, MAC address of Wi-Fi, and Bluetooth address. Also, notifications on events like changing in service status are provided. There are two kinds of places and fences:

  • Public places and fences are created by the MyPlace application that can be used by all applications.
  • Private places and fences are created by the specified application that can be used by the same application.
Notifications can be received about the following events:
  • Zone in when a device enters a specific area.
  • Zone out when a device exits a specific area.
  • Results and errors for each event requested to the geofence module.

GeofenceResponseEventArgs

Event arguments are passed when an event occurs in geofence and the place, such as add, update, etc..

GeofenceStateEventArgs

Event arguments are passed when an event is triggered to notify the geofence state change.

PlaceData

Represents the place list item data.

ProximityStateEventArgs

Event arguments are passed when an event is triggered to notify the proximity state change.

VirtualPerimeter

Allows to create a virtual fence as geofence using the GeofenceManager instance. A user can manage all the geofence or place related data and events.

Enums

FenceType

Enumeration for the geofence types.

GeofenceError

Enumeration for the types of error occured, if any.

GeofenceEventType

Enumeration for the geofence management events.

GeofenceState

Enumeration for the state of geofence.

ProximityProvider

Enumeration for the provider of proximity.

ProximityState

Enumeration for the state of proximity.