Class Fence

Definition

Namespace:: Tizen.Location.Geofence

Assembly:: Tizen.Location.Geofence.dll

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.


                C#
                
                    Copy
                    
                
            
public class Fence : IDisposable

Inheritance: object

Fence

Implements: System.IDisposable

Properties

View Source

Address

Gets the address of geofence.

Declaration


                C#
                
                    Copy
                    
                
            
public string Address { get; }

Property Value

Type	Description
string

View Source

Bssid

Gets the BSSID of geofence.

Declaration


                C#
                
                    Copy
                    
                
            
public string Bssid { get; }

Property Value

Type	Description
string

View Source

Latitude

Gets the latitude of geofence.

Declaration


                C#
                
                    Copy
                    
                
            
public double Latitude { get; }

Property Value

Type	Description
double

View Source

Longitude

Gets the longitude of geofence.

Declaration


                C#
                
                    Copy
                    
                
            
public double Longitude { get; }

Property Value

Type	Description
double

View Source

PlaceId

Gets the ID of the place.

Declaration


                C#
                
                    Copy
                    
                
            
public int PlaceId { get; }

Property Value

Type	Description
int

View Source

Radius

Gets the radius of geofence.

Declaration


                C#
                
                    Copy
                    
                
            
public int Radius { get; }

Property Value

Type	Description
int

View Source

Ssid

Gets the SSID of geofence.

Declaration


                C#
                
                    Copy
                    
                
            
public string Ssid { get; }

Property Value

Type	Description
string

View Source

Type

Gets the type of geofence.

Declaration


                C#
                
                    Copy
                    
                
            
public FenceType Type { get; }

Property Value

Type	Description
FenceType

Methods

View Source

CreateBTFence(int, string, string)

Creates a Bluetooth type of the new geofence.

Declaration


                C#
                
                    Copy
                    
                
            
public static Fence CreateBTFence(int placeId, string bssid, string ssid)

Parameters

Type	Name	Description
int	placeId	The current place ID.
string	bssid	Specifies the value of BSSID of BT MAC address.
string	ssid	Specifies the value of SSID of BT Device.

Returns

Type	Description
Fence	The newly created geofence instance.

Exceptions

Type	Condition
System.ArgumentException	In case of an invalid parameter.
System.InvalidOperationException	In case of any system error.
System.NotSupportedException	In case the geofence is not supported.

View Source

CreateGPSFence(int, double, double, int, string)

Creates a geopoint type of the new geofence.

Declaration


                C#
                
                    Copy
                    
                
            
public static Fence CreateGPSFence(int placeId, double latitude, double longitude, int radius, string address)

Parameters

Type	Name	Description
int	placeId	The current place ID.
double	latitude	Specifies the value of latitude of the geofence [-90.0 ~ 90.0] (degrees).
double	longitude	Specifies the value of longitude of the geofence [-180.0 ~ 180.0] (degrees).
int	radius	Specifies the value of radius of the geofence [100 ~ 500] (meter).
string	address	Specifies the value of the address.

Returns

Type	Description
Fence	The newly created geofence instance.

Exceptions

Type	Condition
System.ArgumentException	In case of an invalid parameter.
System.InvalidOperationException	In case of any system error.
System.NotSupportedException	In case the geofence is not supported.

View Source

CreateWifiFence(int, string, string)

Creates a Wi-Fi type of the new geofence.

Declaration


                C#
                
                    Copy
                    
                
            
public static Fence CreateWifiFence(int placeId, string bssid, string ssid)

Parameters

Type	Name	Description
int	placeId	The current place ID.
string	bssid	Specifies the value of BSSID of the Wi-Fi MAC address.
string	ssid	Specifies the value of SSID of the Wi-Fi device.

Returns

Type	Description
Fence	The newly created geofence instance.

Exceptions

Type	Condition
System.ArgumentException	In case of an invalid parameter.
System.InvalidOperationException	In case of any system error.
System.NotSupportedException	In case the geofence is not supported.

View Source

Dispose()

The overloaded Dispose API for destroying the fence handle.

Declaration


                C#
                
                    Copy
                    
                
            
public void Dispose()

View Source

Dispose(bool)

Dispose.

Declaration


                C#
                
                    Copy
                    
                
            
protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

View Source

~Fence()

The destructor of the Fence class.

Declaration


                C#
                
                    Copy
                    
                
            
protected ~Fence()

Implements

System.IDisposable