Geofence Interface Reference
Interface that represents a geofence. More...
Inheritance diagram for Geofence:
Public Member Functions | |
SetOfGeofences | getSog () |
int | getId () |
String | getName () |
Boolean | enable () throws GeofencingNotAvailableException, GeofencingLowLevelException |
Boolean | disable () throws GeofencingNotAvailableException, GeofencingLowLevelException |
Boolean | getEnabled () |
Boolean | getActive () |
void | remove () throws GeofencingNotAvailableException, GeofencingLowLevelException |
Public Member Functions inherited from Subject< T extends Observer< U, U extends Event > | |
void | subscribe (T observer) throws CannotSubscribeException |
void | unSubscribe (T observer) throws ObserverNotSubscribedException |
Detailed Description
Interface that represents a geofence
Member Function Documentation
Boolean disable | ( | ) | throws GeofencingNotAvailableException, GeofencingLowLevelException |
Disable the geofence
- Parameters
-
enabled true for enable, false for disable
- Returns
- true if change is performed, false if no effect (value was previously set).
Boolean enable | ( | ) | throws GeofencingNotAvailableException, GeofencingLowLevelException |
Enable the geofence
- Returns
- true if change is performed, false if no effect (value was previously set).
Boolean getActive | ( | ) |
Returns true if the geofence is active
- Returns
- true if the geofence is active
Boolean getEnabled | ( | ) |
Returns true if the geofence is enabled
- Returns
- true if the geofence is enabled
int getId | ( | ) |
Gets id of the geofence
- Returns
- id of the geofence
String getName | ( | ) |
Gets name of the geofence
- Returns
- name of the geofence
SetOfGeofences getSog | ( | ) |
Gets "Set Of Geofences" where the geofence is contained
- Returns
- "Set Of Geofences" where the geofence is contained
void remove | ( | ) | throws GeofencingNotAvailableException, GeofencingLowLevelException |
Removes the geofence