Type Definitions
ConfigurationOptions
Type:
- object
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
locationType |
GoIndoor.LocationAlgorithm |
<optional> |
Positioning type |
locationUpdate |
number |
<optional> |
Update rate in msec |
debug |
boolean |
<optional> |
Debug mode |
updatePolicy |
GoIndoor.UpdatePolicy |
<optional> |
Update policy |
updateTime |
number |
<optional> |
Database update time in msec |
- Source:
GetPlacesOptions
Options to get places. Possible combinations are:
- id
- ids
- location, radius, tags^, filter^
- id, tags^, filter^
- latitude, longitude, radius, floorNumber, building, tags^, filter^
Type:
- object
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
id |
string |
<optional> |
Building or floor ID whose places need to be retrieved |
ids |
Array.<string> |
<optional> |
Building or floor IDs whose places need to be retrieved |
location |
LocationResult |
<optional> |
Location whose places needs to be retrieved |
radius |
number |
<optional> |
Radius from the location. If 0 it will returns the closest one. Must be >=0 |
latitude |
number |
<optional> |
WGS84 Latitude whose places needs to be retrieved |
longitude |
number |
<optional> |
WGS84 Longitude whose places needs to be retrieved |
floorNumber |
number |
<optional> |
Floor number whose places needs to be retrieved |
building |
string |
<optional> |
Building ID whose places needs to be retrieved |
tags |
Array.<string> |
<optional> |
List of POI tags that should match in the search |
filter |
Object.<string, string> |
<optional> |
Map of POI properties that should match in the search |
- Source:
LocationResult
Type:
- object
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
latitude |
number | WGS84 Latitude | |
longitude |
number | WGS84 Longitude | |
used |
number | Number of Beacons used | |
accuracy |
number | Position accuracy (meters) | |
found |
Array.<number> | List including the longitude, latitude and accuracy of each Beacon in sight | |
floor |
string |
<nullable> |
Floor ID |
floorNumber |
number | Floor number | |
type |
number | Positioning type | |
buildingName |
string |
<nullable> |
Building name |
building |
string |
<nullable> |
Building ID |
geofences |
number | Number of geofences |
- Source:
Notification
Type:
- object
Properties:
| Name | Type | Description |
|---|---|---|
id |
string | Notification unique identifier |
building |
string | Parent building unique identifier |
floor |
string | Parent floor unique identifier |
floorNumber |
number | Parent floor number |
place |
string | ID of the poi that will trigger the event |
properties |
Object.<string, string> | Keys/values that define the content of the notification |
action |
string | Action that will trigger this notification ("ENTER", "STAY", "LEAVE" or "NEARBY") |
delay |
number | Delay before triggerring the notification |
range |
number | Extended area where the notification will trigger |
repeat |
number | Number of seconds when this notification can be repeated again |
targets |
Object.<string, Targets> | Keys/values that defines the notification target |
- Source:
NotificationResult
Type:
- object
Properties:
| Name | Type | Description |
|---|---|---|
notification |
Notification | Notification triggered |
place |
Place | POI related to the Notification |
- Source:
Place
Type:
- object
Properties:
| Name | Type | Description |
|---|---|---|
id |
string | Automatically generated usedProximityUuid |
name |
string | Place name |
building |
string | Building ID |
floor |
string | Floor ID |
floorNumber |
number | Floor number |
geometry |
Geometry | Place geometry |
latitude |
number | WGS84 Latitude |
longitude |
number | WGS84 Longitude |
tags |
Array.<string> | Tag list |
properties |
Object.<string, string> | Properties |
- Source: