IGeofencingManager Interface Reference

Geofencing Manager allows to manage the geofences in devices running deepsy More...

Inheritance diagram for IGeofencingManager:

Public Member Functions

IEnumerable< string > GetSOGs ()
 Get every set of geofences in the database More...
 
IEnumerable< IGeofenceGetGeofences (string sogId)
 Get every set of geofences in the database More...
 
IGeofence AddPolygonGeofence (string sogId, int id, string name, bool enabled, IList< IPosition > positions)
 Creates a geofence in the database defined as a list of points More...
 
IGeofence AddCircleGeofence (string sogId, int id, string name, bool enabled, IPosition position, int radius)
 Creates a geofence in the database defined as a point and a radius More...
 
IGeofence AddBufferedLineGeofence (string sogId, int id, string name, bool enabled, IList< IPosition > positions, int radius)
 Creates a geofence in the database defined as a list of points and a radius More...
 
void DeleteGeofence (IGeofence geofence)
 Deletes a geofence in the database More...
 
void EnableGeofence (IGeofence geofence)
 Enables a geofence in the database More...
 
void DisableGeofence (IGeofence geofence)
 Disables a geofence in the database More...
 
void EnableSOG (string sogId)
 Enables all geofences from a set of geofences in the database More...
 
void DisableSOG (string sogId)
 Disables all geofences from a set of geofences in the database More...
 
void DeleteSOG (string sogId)
 Deletes all geofences from a set of geofences in the database More...
 

Additional Inherited Members

- Events inherited from IGeofencingNotifier
EventHandler< ISogListEventSogListEvent
 Event raised by changes in sog list More...
 
EventHandler< IGeofenceListEventGeofenceListEvent
 Event raised by changes in geofence list More...
 

Detailed Description

Member Function Documentation

IGeofence AddBufferedLineGeofence ( string  sogId,
int  id,
string  name,
bool  enabled,
IList< IPosition positions,
int  radius 
)
Parameters
sogIdSet of geofences identifier
idID of the geofence
nameName of the geofence
enabledTrue if the geofence is enabled
positionsList of positions of the geofence
radiusRadius of the geofence
Returns
Geofence created
Exceptions
NotAvailableException (NOT_AVAILABLE)Thrown when service is not available
NotAvailableException (DPY_TIMEOUT)Thrown when service don't respond in time

Implemented in GeofencingManager.

IGeofence AddCircleGeofence ( string  sogId,
int  id,
string  name,
bool  enabled,
IPosition  position,
int  radius 
)
Parameters
sogIdSet of geofences identifier
idID of the geofence
nameName of the geofence
enabledTrue if the geofence is enabled
positionCenter point of the geofence
radiusRadius of the geofence
Returns
Geofence created
Exceptions
NotAvailableException (NOT_AVAILABLE)Thrown when service is not available
NotAvailableException (DPY_TIMEOUT)Thrown when service don't respond in time

Implemented in GeofencingManager.

IGeofence AddPolygonGeofence ( string  sogId,
int  id,
string  name,
bool  enabled,
IList< IPosition positions 
)
Parameters
sogIdSet of geofences identifier
idID of the geofence
nameName of the geofence
enabledTrue if the geofence is enabled
positionsList of positions of the geofence
Returns
Geofence created
Exceptions
NotAvailableException (NOT_AVAILABLE)Thrown when service is not available
NotAvailableException (DPY_TIMEOUT)Thrown when service don't respond in time

Implemented in GeofencingManager.

void DeleteGeofence ( IGeofence  geofence)
Parameters
geofenceGeofence to be deleted
Exceptions
NotAvailableException (NOT_AVAILABLE)Thrown when service is not available
NotAvailableException (DPY_TIMEOUT)Thrown when service don't respond in time

Implemented in GeofencingManager.

void DeleteSOG ( string  sogId)
Parameters
sogIdSet of geofences identifier
Exceptions
NotAvailableException (NOT_AVAILABLE)Thrown when service is not available
NotAvailableException (DPY_TIMEOUT)Thrown when service don't respond in time

Implemented in GeofencingManager.

void DisableGeofence ( IGeofence  geofence)
Parameters
geofenceGeofence to be disabled
Exceptions
NotAvailableException (NOT_AVAILABLE)Thrown when service is not available
NotAvailableException (DPY_TIMEOUT)Thrown when service don't respond in time

Implemented in GeofencingManager.

void DisableSOG ( string  sogId)
Parameters
sogIdSet of geofences identifier
Exceptions
NotAvailableException (NOT_AVAILABLE)Thrown when service is not available
NotAvailableException (DPY_TIMEOUT)Thrown when service don't respond in time

Implemented in GeofencingManager.

void EnableGeofence ( IGeofence  geofence)
Parameters
geofenceGeofence to be enabled
Exceptions
NotAvailableException (NOT_AVAILABLE)Thrown when service is not available
NotAvailableException (DPY_TIMEOUT)Thrown when service don't respond in time

Implemented in GeofencingManager.

void EnableSOG ( string  sogId)
Parameters
sogIdSet of geofences identifier
Exceptions
NotAvailableException (NOT_AVAILABLE)Thrown when service is not available
NotAvailableException (DPY_TIMEOUT)Thrown when service don't respond in time

Implemented in GeofencingManager.

IEnumerable<IGeofence> GetGeofences ( string  sogId)
Returns
List of set of geofences
Exceptions
NotAvailableException (NOT_AVAILABLE)Thrown when service is not available
NotAvailableException (DPY_TIMEOUT)Thrown when service don't respond in time

Implemented in GeofencingManager.

IEnumerable<string> GetSOGs ( )
Returns
List of set of geofences
Exceptions
NotAvailableException (NOT_AVAILABLE)Thrown when service is not available
NotAvailableException (DPY_TIMEOUT)Thrown when service don't respond in time

Implemented in GeofencingManager.