java.lang.Object
- es.situm.sdk.model.Resource
- - es.situm.sdk.model.cartography.Geofence

All Implemented Interfaces:

android.os.Parcelable, MapperInterface, Filterable
```
public class Geofence
extends Resource
implements android.os.Parcelable, MapperInterface
```
Represents a geographic region in a building. Can be monitored to check if an user enter or exits the polygon and to get analytics.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Geofence.Builder
- Nested classes/interfaces inherited from interface android.os.Parcelable
  android.os.Parcelable.ClassLoaderCreator<T extends java.lang.Object>, android.os.Parcelable.Creator<T extends java.lang.Object>

Field Summary

Fields
Modifier and Type Field Description

static android.os.Parcelable.Creator<Geofence> CREATOR
- Fields inherited from class es.situm.sdk.model.Resource
  EMPTY_IDENTIFIER, EMPTY_IDENTIFIER_BACKWARDS
- Fields inherited from interface es.situm.sdk.model.MapperInterface
  ACCESSIBILITY_MODE, ACCURACY, ADDRESS, ALTITUDE, BEARING, BEARING_FROM, BEARING_QUALITY, BOUNDS, BOUNDS_ROTATED, BUILDING, BUILDING_IDENTIFIER, BUILDING_NAME, CARTESIAN_BEARING, CARTESIAN_COORDINATE, CENTER, CLOSEST_LOCATION_IN_ROUTE, CODE, CONVERSION, COORDINATE, CREATED_AT, CURRENT_INDICATION, CURRENT_STEP_INDEX, CUSTOM_FIELDS, dateFormat, DEGREES, DEGREES_CLOCKWISE, DEVICE_ID, DIMENSIONS, DISTANCE, DISTANCE_TO_CHANGE_FLOOR_THRESHOLD, DISTANCE_TO_CHANGE_INDICATION_THRESHOLD, DISTANCE_TO_CLOSEST_POINT_IN_ROUTE, DISTANCE_TO_END_STEP, DISTANCE_TO_GOAL, DISTANCE_TO_GOAL_THRESHOLD, DISTANCE_TO_IGNORE_FIRST_INDICATION, DISTANCE_TO_NEXT_LEVEL, EDGES, EVENTS, EXCLUDED_TAGS, FIRST_STEP, FLOOR, FLOOR_IDENTIFIER, FLOORS, FOREGROUND_SERVICE_NOTIFICATION_MESSAGE, FOREGROUND_SERVICE_NOTIFICATION_SHOW_STOP_ACTION, FOREGROUND_SERVICE_NOTIFICATION_STOP_ACTION_TEXT, FOREGROUND_SERVICE_NOTIFICATION_TITLE, FROM, GEOFENCES, HAS_BEARING, HAS_CARTESIAN_BEARING, HEIGHT, HUMAN_READABLE_MESSAGE, ID, IDENTIFIER, IGNORE_LOW_QUALITY_LOCATIONS, INCLUDED_TAGS, INDICATION_TYPE, INDICATIONS, INDICATIONS_INTERVAL, INDOOR_POIS, INFO_HTML, IS_FIRST, IS_INDOOR, IS_LAST, IS_OUTDOOR, IS_PUBLIC, LAST_STEP, LATITUDE, LONGITUDE, MAP_URL, MINIMIZE_FLOOR_CHANGES, NAME, NEEDED_LEVEL_CHANGE, NEXT_INDICATION, NEXT_LEVEL, NODES, NORTH_EAST, NORTH_WEST, ORIENTATION, ORIENTATION_TYPE, OUTDOOR_BUILDING_DETECTOR_BLE, OUTDOOR_POIS, OUTSIDE_ROUTE_THRESHOLD, PICTURE_THUMB_URL, PICTURE_URL, POI_CATEGORIES, POI_CATEGORY, POI_CATEGORY_CODE, POI_CATEGORY_ICON_SELECTED, POI_CATEGORY_ICON_UNSELECTED, POI_CATEGORY_IDENTIFIER, POI_CATEGORY_IDENTIFIERS, POI_CATEGORY_iNAME, POI_CATEGORY_NAME, POI_NAME, POI_TO, POI_TO_IDENTIFIER, POINTS, POLYGON_POINTS, POSITION, PROVIDER, QUALITY, RADIANS, RADIANS_MINUS_PI_PI, RADIUS, ROTATION, ROUND_INDICATIONS_STEP, ROUTE, ROUTE_STEP, SCALE, SEGMENTS, SOUTH_EAST, SOUTH_WEST, STATUS_NAME, STATUS_ORDINAL, STEP_IDX_DESTINATION, STEP_IDX_ORIGIN, STEPS, TIME_TO_END_STEP, TIME_TO_FIRST_INDICATION, TIME_TO_GOAL, TIME_TO_IGNORE_UNEXPECTED_FLOOR_CHANGES, TIMESTAMP, TO, TO_LEGACY, TRIGGER, UPDATED_AT, USER_IDENTIFIER, WIDTH, X, Y
- Fields inherited from interface android.os.Parcelable
  CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`int`	`describeContents()`
`boolean`	`equals(java.lang.Object o)`
`java.lang.String`	`getBuildingIdentifier()`	Returns the building identifier to which the geofence belongs
`java.lang.String`	`getCode()`	Returns the code of the geofence
`java.lang.String`	`getDescription()`	Deprecated. this method is replaced by @link #getInfoHtml()
`java.lang.String`	`getFloorIdentifier()`	Returns the floor identifier of the floor where it is placed
`java.lang.String`	`getInfoHtml()`	Returns the information of the geofence
`java.lang.String`	`getName()`	Returns the name of the geofence
`java.util.List<Point>`	`getPolygonPoints()`	Returns a list of points of the closed polygon that represents the geofence
`int`	`hashCode()`
`java.util.Map<java.lang.String,java.lang.Object>`	`toMap()`	Method to transform object into Map
`java.lang.String`	`toString()`
`void`	`writeToParcel(android.os.Parcel dest, int flags)`

Methods inherited from class es.situm.sdk.model.Resource
getCreatedAt, getCustomFields, getIdentifier, getUpdatedAt

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - CREATOR
```
public static final android.os.Parcelable.Creator<Geofence> CREATOR
```
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Returns the name of the geofence
  - getCode
```
public java.lang.String getCode()
```
    Returns the code of the geofence
  - getDescription
```
@Deprecated
public java.lang.String getDescription()
```
    Deprecated.
    this method is replaced by @link #getInfoHtml()
    
    Returns the description of the geofence
  - getInfoHtml
```
public java.lang.String getInfoHtml()
```
    Returns the information of the geofence
    
    Returns:
    
    string containing additional information of the geofence in html format
  - getFloorIdentifier
```
public java.lang.String getFloorIdentifier()
```
    Returns the floor identifier of the floor where it is placed
  - getBuildingIdentifier
```
public java.lang.String getBuildingIdentifier()
```
    Returns the building identifier to which the geofence belongs
  - getPolygonPoints
```
public java.util.List<Point> getPolygonPoints()
```
    Returns a list of points of the closed polygon that represents the geofence
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class Resource
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Resource
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class Resource
  - describeContents
```
public int describeContents()
```
    Specified by:
    
    describeContents in interface android.os.Parcelable
  - writeToParcel
```
public void writeToParcel(android.os.Parcel dest,
                          int flags)
```
    Specified by:
    
    writeToParcel in interface android.os.Parcelable
  - toMap
```
public java.util.Map<java.lang.String,java.lang.Object> toMap()
```
    Description copied from interface: MapperInterface
    
    Method to transform object into Map
    
    Specified by:
    
    toMap in interface MapperInterface
    
    Returns:
    
    Map with the information of the object mapped

Class Geofence

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Field Summary

Fields inherited from class es.situm.sdk.model.Resource

Fields inherited from interface es.situm.sdk.model.MapperInterface

Fields inherited from interface android.os.Parcelable

Method Summary

Methods inherited from class es.situm.sdk.model.Resource

Methods inherited from class java.lang.Object

Field Detail

CREATOR

Method Detail

getName

getCode

getDescription

getInfoHtml

getFloorIdentifier

getBuildingIdentifier

getPolygonPoints

equals

hashCode

toString

describeContents

writeToParcel

toMap