Class VirtualPerimeter

Definition

Namespace:: Tizen.Location.Geofence

Assembly:: Tizen.Location.Geofence.dll

API Level:: 3

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.


                C#
                
                    Copy
                    
                
            
public class VirtualPerimeter

Inheritance: System.Object

VirtualPerimeter

Constructors

View Source

VirtualPerimeter(GeofenceManager)

Creates a VirtualPerimeter which can be used to create a virtual fence.

Declaration


                C#
                
                    Copy
                    
                
            
public VirtualPerimeter(GeofenceManager manager)

Parameters

Type	Name	Description
GeofenceManager	manager	The GeofenceManager instance.

Exceptions

Type	Condition
System.ArgumentException	In case of an invalid parameter.

API Level: 3

Methods

View Source

AddGeofence(Fence)

Adds the geofence for a given Geofence manager.

Declaration


                C#
                
                    Copy
                    
                
            
public int AddGeofence(Fence fence)

Parameters

Type	Name	Description
Fence	fence	The geofence instance to be added.

Returns

Type	Description
Int32	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.
UnauthorizedAccessException	In case privileges are not defined.
System.NotSupportedException	In case the geofence is not supported.

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/location

View Source

AddPlaceName(String)

Creates a new place for the geofencing service.

Declaration


                C#
                
                    Copy
                    
                
            
public int AddPlaceName(string name)

Parameters

Type	Name	Description
System.String	name	A place name to be created.

Returns

Type	Description
Int32	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.
UnauthorizedAccessException	In case privileges are not defined.
System.NotSupportedException	In case the geofence is not supported.

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/location

View Source

GetFenceDataList()

Retrieves a list of fences registered in the specified Geofence manager.

Declaration


                C#
                
                    Copy
                    
                
            
public IEnumerable<FenceData> GetFenceDataList()

Returns

Type	Description
System.Collections.Generic.IEnumerable<FenceData>	List of FenceData instances registered for each geofence.

Exceptions

Type	Condition
System.InvalidOperationException	In case of any system error.
UnauthorizedAccessException	In case privileges are not defined.
System.NotSupportedException	In case geofence is not supported.

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/location

View Source

GetGeofenceDataListByPlaceId(Int32)

Retrieves a list of fences registered in the specified place.

Declaration


                C#
                
                    Copy
                    
                
            
public IEnumerable<FenceData> GetGeofenceDataListByPlaceId(int placeId)

Parameters

Type	Name	Description
Int32	placeId	The place ID.

Returns

Type	Description
System.Collections.Generic.IEnumerable<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.
UnauthorizedAccessException	In case privileges are not defined.
System.NotSupportedException	In case the geofence is not supported.

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/location

View Source

GetPlaceDataList()

Retrieves a list of places registered in the specified Geofence manager.

Declaration


                C#
                
                    Copy
                    
                
            
public IEnumerable<PlaceData> GetPlaceDataList()

Returns

Type	Description
System.Collections.Generic.IEnumerable<PlaceData>	List of places registered as the PlaceData instance list.

Exceptions

Type	Condition
System.InvalidOperationException	In case of any system error.
UnauthorizedAccessException	In case privileges are not defined.
System.NotSupportedException	In case the geofence is not supported.

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/location

View Source

GetPlaceName(Int32)

Gets the name of place.

Declaration


                C#
                
                    Copy
                    
                
            
public string GetPlaceName(int placeId)

Parameters

Type	Name	Description
Int32	placeId	The place ID.

Returns

Type	Description
System.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.
UnauthorizedAccessException	In case privileges are not defined.
System.NotSupportedException	In case the geofence is not supported.

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/location

View Source

RemoveGeofence(Int32)

Removes the geofence with a given geofence ID.

Declaration


                C#
                
                    Copy
                    
                
            
public void RemoveGeofence(int fenceId)

Parameters

Type	Name	Description
Int32	fenceId	The specified geofence ID.

Exceptions

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

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/location

View Source

RemovePlace(Int32)

Removes the specific place for the geofencing service.

Declaration


                C#
                
                    Copy
                    
                
            
public void RemovePlace(int placeId)

Parameters

Type	Name	Description
Int32	placeId	The specified place ID.

Exceptions

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

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/location

View Source

UpdatePlace(Int32, String)

Updates the place name of a given place ID.

Declaration


                C#
                
                    Copy
                    
                
            
public void UpdatePlace(int placeId, string name)

Parameters

Type	Name	Description
Int32	placeId	The specified place ID.
System.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.
UnauthorizedAccessException	In case privileges are not defined.
System.NotSupportedException	In case the geofence is not supported.