Class VirtualPerimeter
Definition
- Assembly:
- Tizen.Location.Geofence.dll
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.
public class VirtualPerimeter
- Inheritance
-
objectVirtualPerimeter
Constructors
View SourceVirtualPerimeter(GeofenceManager)
Creates a VirtualPerimeter which can be used to create a virtual fence.
Declaration
public VirtualPerimeter(GeofenceManager manager)
Parameters
Type | Name | Description |
---|---|---|
GeofenceManager | manager | The GeofenceManager instance. |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | In case of an invalid parameter. |
Methods
View SourceAddGeofence(Fence)
Adds the geofence for a given Geofence manager.
Declaration
public int AddGeofence(Fence fence)
Parameters
Type | Name | Description |
---|---|---|
Fence | fence | The geofence instance to be added. |
Returns
Type | Description |
---|---|
int | The geofence ID to be newly created on success. |
Remarks
The return value will always be a number greater than zero.
Exceptions
Type | Condition |
---|---|
System.ArgumentException | In case of an invalid parameter. |
System.InvalidOperationException | In case of any system error. |
System.UnauthorizedAccessException | In case privileges are not defined. |
System.NotSupportedException | In case the geofence is not supported. |
AddPlaceName(string)
Creates a new place for the geofencing service.
Declaration
public int AddPlaceName(string name)
Parameters
Type | Name | Description |
---|---|---|
string | name | A place name to be created. |
Returns
Type | Description |
---|---|
int | The place ID to be newly created on success. |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | In case of an invalid parameter. |
System.InvalidOperationException | In case of any system error. |
System.UnauthorizedAccessException | In case privileges are not defined. |
System.NotSupportedException | In case the geofence is not supported. |
GetFenceDataList()
Retrieves a list of fences registered in the specified Geofence manager.
Declaration
public IEnumerable<FenceData> GetFenceDataList()
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<T><FenceData> | List of FenceData instances registered for each geofence. |
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | In case of any system error. |
System.UnauthorizedAccessException | In case privileges are not defined. |
System.NotSupportedException | In case geofence is not supported. |
GetGeofenceDataListByPlaceId(int)
Retrieves a list of fences registered in the specified place.
Declaration
public IEnumerable<FenceData> GetGeofenceDataListByPlaceId(int placeId)
Parameters
Type | Name | Description |
---|---|---|
int | placeId | The place ID. |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<T><FenceData> | The list of FenceData instances registered for each geofence for the specified place. |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | In case of an invalid parameter. |
System.InvalidOperationException | In case of any system error. |
System.UnauthorizedAccessException | In case privileges are not defined. |
System.NotSupportedException | In case the geofence is not supported. |
GetPlaceDataList()
Retrieves a list of places registered in the specified Geofence manager.
Declaration
public IEnumerable<PlaceData> GetPlaceDataList()
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<T><PlaceData> | List of places registered as the PlaceData instance list. |
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | In case of any system error. |
System.UnauthorizedAccessException | In case privileges are not defined. |
System.NotSupportedException | In case the geofence is not supported. |
GetPlaceName(int)
Gets the name of place.
Declaration
public string GetPlaceName(int placeId)
Parameters
Type | Name | Description |
---|---|---|
int | placeId | The place ID. |
Returns
Type | Description |
---|---|
string | The name of the place. |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | In case of an invalid parameter. |
System.InvalidOperationException | In case of any system error. |
System.UnauthorizedAccessException | In case privileges are not defined. |
System.NotSupportedException | In case the geofence is not supported. |
RemoveGeofence(int)
Removes the geofence with a given geofence ID.
Declaration
public void RemoveGeofence(int fenceId)
Parameters
Type | Name | Description |
---|---|---|
int | fenceId | The specified geofence ID. |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | In case of an invalid parameter. |
System.InvalidOperationException | In case of any system error. |
System.UnauthorizedAccessException | In case privileges are not defined. |
System.NotSupportedException | In case the geofence is not supported. |
RemovePlace(int)
Removes the specific place for the geofencing service.
Declaration
public void RemovePlace(int placeId)
Parameters
Type | Name | Description |
---|---|---|
int | placeId | The specified place ID. |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | Incase of an invalid parameter. |
System.InvalidOperationException | In case of any system error. |
System.UnauthorizedAccessException | In case privileges are not defined. |
System.NotSupportedException | In case the geofence is not supported. |
UpdatePlace(int, string)
Updates the place name of a given place ID.
Declaration
public void UpdatePlace(int placeId, string name)
Parameters
Type | Name | Description |
---|---|---|
int | placeId | The specified place ID. |
string | name | A new place name of the place ID. |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | In case of an invalid parameter. |
System.InvalidOperationException | In case of any System error. |
System.UnauthorizedAccessException | In case privileges are not defined. |
System.NotSupportedException | In case the geofence is not supported. |