Members
Angle
Representation of an angle.
Properties:
Name | Type | Description |
---|---|---|
degrees |
number | Angle in degrees, increasing in counter-clockwise |
degreesClockwise |
number | Angle in radians, increasing in clockwise |
radians |
number | Angle in radians, increasing in counter-clockwise |
radiansMinusPiPi |
number | Angle in radians in range (-pi,pi) |
- Source:
BeaconFilter
Represents a BLE filter. Now the only field is the BLE proximity UUID
Properties:
Name | Type | Description |
---|---|---|
uuid |
string |
- Source:
Bounds
Represents a rectangle bounds in a greographic 2D space.
Properties:
Name | Type | Description |
---|---|---|
northEast |
Coordinate | The coordinate of the north-east corner of the bound. |
northWest |
Coordinate | The coordinate of the north-west corner of the bound. |
southEast |
Coordinate | The coordinate of the south-east corner of the bound. |
southWest |
Coordinate | The coordinate of the south-east corner of the bound. |
- Source:
Building
A Building object definition
Properties:
Name | Type | Description |
---|---|---|
buildingIdentifier |
string | The unique identifier of the resource |
name |
string | The building name that is appropriate for display to the user. |
address |
string | Te building address. |
bounds |
Bounds | Compute corners of this building, without rotation, in earth coordinates. |
boundsRotated |
Bounds | Compute corners of this building, with rotation, in earth coordinates. |
center |
Coordinate | Center of the building's base, as geographical coordinate. |
Dimensions |
Dimensions | Dimensions of building's base (height and width) in meters. |
infoHtml |
string | Additional information about building, formatted with HTML |
pictureThumbUrl |
string | The URL of building thumbnail image |
pictureUrl |
string | The URL of building image |
rotation |
number | Rotation angle of the building's base, relative to the west-east axis, increasing in counter-clockwise, being 0 the west-east axis. |
userIdentifier |
string | Unique identifier of the owner user of the building |
customFields |
object | Map of custom fields, indexed by their name. |
- Source:
Cartesian Coordinate
A structure that contains cartesian coordinate.
Properties:
Name | Type | Description |
---|---|---|
x |
number | Value of coordinate at x-axis |
y |
number | Value of coordinate at y-axis |
- Source:
Coordinate
A structure that contains geographical coordinate.
Properties:
Name | Type | Description |
---|---|---|
latitude |
number | Latitude in degrees |
longitude |
number | Longitude in degrees |
- Source:
Dimensions
Define 2D dimensions of a rectangular area.
Properties:
Name | Type | Description |
---|---|---|
width |
number | Width of rectangle in meters |
height |
number | Height of rectangle in meters. |
- Source:
Floor
Floor of a building.
Properties:
Name | Type | Description |
---|---|---|
altitude |
number | Altitude of the floor above ground level, in meters. |
buildingIdentifier |
string | The identifier of building which this floor belongs. |
level |
number | The number of the floor. |
mapUrl |
string | The floor map image url |
scale |
number | The scale of the floor image, in px/meters |
floorIdentifier |
string | The unique identifier of the resource |
- Source:
Indication
Represents the instruction that a user should follow when on a RouteStep to continue the route.
Properties:
Name | Type | Description |
---|---|---|
distance |
number | The distance between the origin and destination |
distanceToNextLevel |
number | The number of levels between the origin and destination |
indicationType |
string | The Indication.Action of the instruction as String |
orientation |
number | The angle a user should change his direction in order to go from the origin to the destination. |
orientationType |
string | The Indication.Orientation of the instruction as String |
stepIdxDestination |
number | The index of the indication's step of destination. |
stepIdxOrigin |
number | The index of the indication's step of origin |
neededLevelChange |
boolean | If the user should change the level in order to arrive to destination |
- Source:
Location
A location. It can be indoor or outdoor, check isIndoor and isOutdoor. A valid indoor location has floorIdentifier and cartesianCoordinate.
Properties:
Name | Type | Description |
---|---|---|
accuracy |
number | The accuracy radius (in meters) |
bearing |
Angle | The bearing (in degrees) with respect to the Earth North. |
bearingQuality |
string | The quality of the cartesian bearing. |
buildingIdentifier |
string | Only used in indoor. |
cartesianBearing |
Angle | Only used in indoor. In Angle object. |
cartesianCoordinate |
CartesianCoordinate | Only used in indoor. In CartesianCoordinate object. |
coordinate |
Coordinate | The Coordinate of the location |
floorIdentifier |
string | Only used in indoor. |
position |
Point | The position of the location as Point. |
provider |
string | The device identifier that has generated the location |
quality |
string | Only used in indoor. |
hasBearing |
boolean | True if the location has bearing and the bearing quality is Location.Quality.HIGH, false otherwise. |
timestamp |
number | The timestamp of the location. |
hasCartesianBearing |
boolean | Only used in indoor. |
isIndoor |
boolean | True if the location is indoor |
isOutdoor |
boolean | True if the location is outdoor |
deviceId |
string |
- Source:
LocationRequest
A data object that contains parameters for the location service, LocationManager.
Properties:
Name | Type | Description |
---|---|---|
buildingIdentifier |
number | |
interval |
number | Default interval (in milliseconds) to notify location updates |
indoorProvider |
string | Default indoor provider |
useBle |
boolean | |
useWifi |
boolean | |
motionMode |
string | Default motion mode |
useForegroundService |
boolean | |
useDeadReckoning |
boolean | |
outdoorLocationOptions |
OutdoorLocationOptions | |
beaconFilters |
Array.<BeaconFilter> | |
smallestDisplacement |
number | Default smallest displacement to nofiy location updates |
readtimeUpdateInterval |
number | Default interval (in milliseconds) to send locations to the Realtime |
- Source:
OutdoorLocationOptions
Outdoor location options used only in indoor-outdoor mode
Properties:
Name | Type | Description |
---|---|---|
userDefinedThreshold |
boolean | |
computeInterval |
number | |
averageSnrThreshold |
number |
- Source:
POI
Point of Interest, associated to a building, regardless of whether it's place inside or outside the building.
Properties:
Name | Type | Description |
---|---|---|
identifier |
string | The unique identifier of the resource |
buildingIdentifier |
string | Identifier of building to which the POI belongs. |
cartesianCoordinate |
CartesianCoordinate | Cartesian coordinate of this position, relative to building Bounds. |
coordinate |
Coordinate | Geographical coordinate of this position |
floorIdentifier |
string | If this POI is outside the building (isOutdoor == true), this field has no meaning. |
poiName |
string | A name for the POI, appropriate for display to the user. |
position |
Point | |
isIndoor |
boolean | Whether the POI is placed outside the building or not. |
isOutdoor |
boolean | Whether the POI is placed outside the building or not. |
category |
PoiCategory | Category of the POI |
infoHtml |
string | Additional information about POI, in HTML |
customFields |
object | Map of custom fields, indexed by their name. |
- Source:
PoiCategory
Category of Point of Interest.
Properties:
Name | Type | Description |
---|---|---|
poiCategoryCode |
string | Unique code of the category |
poiCategoryName |
string | The category name appropriate for display to the user |
icon_selected |
string | The selected icon url |
icon_unselected |
string | The unselected icon url |
public |
boolean | Whether the category is public or not |
- Source:
Point
Associate geographical coordinate (Location) with Building and Floor (Cartography) and cartesian coordinate relative to that building.
Properties:
Name | Type | Description |
---|---|---|
buildingIdentifier |
string | Unique identifier for the building to which this point belongs |
cartesianCoordinate |
CartesianCoordinate | Cartesian coordinate (in meters) relative to the Bounds of building's base. |
coordinate |
Coordinate | Geographic coordinate (latitude, longitude) of the point, regardless of whether it's placed inside or outside the building. |
floorIdentifier |
string | Floor identifier (inside the building) where this point is placed. |
isIndoor |
boolean | If the POI is inside the building. |
idOutdoor |
boolean | If the POI is outside the building. |
- Source:
Route
Route between two points.
Properties:
Name | Type | Description |
---|---|---|
edges |
Array.<RouteStep> | Ordered list of steps to go to the goal point |
firstStep |
RouteStep | First step |
from |
Point | Point where the route starts. |
indications |
Indication | Ordered list of instructions to go to the destination |
lastStep |
RouteStep | Last step |
nodes |
Array.<Point> | A collection of points of the route (not ordered) |
points |
Array.<Point> | List of ordered points of the route |
to |
Point | Last point and goal of the route. |
steps |
Array.<RouteStep> | Ordered list of steps to go to the goal point |
- Source:
RouteStep
A fragment of a route, described by the initial point from and the last point to of the fragment, and some information about the step within the route.
Properties:
Name | Type | Description |
---|---|---|
distance |
number | Distance between from and to in meters. |
distanceToGoal |
number | Distance in meters between the start point of this step (from) and the last point in the route ('to' of the last step). |
from |
Point | Start point of this step. |
id |
number | Position of this RouteStep in the list of steps (Route.steps) of the route to which it belongs. |
to: |
Point | End point of this step. |
isFirst |
boolean | Returns true if this is the first step in the route. |
isLast |
boolean | Returns true if this is the last step in the route. |
- Source:
SitumConversionArea
A rectangular area of a floor defining the conversion area of an event
Properties:
Name | Type | Description |
---|---|---|
floorIdentifier |
number | |
topLeft |
object | |
topRight |
object | |
bottomLeft |
object | |
bottomRight |
object |
- Source:
SitumEvent
An event: POI with radius, conversion area and asociated statistics. It is intended for usage in marketing apps.
Properties:
Name | Type | Description |
---|---|---|
buildingIdentifier |
number | |
identifier |
number | |
floorIdentifier |
number | |
infoHtml |
string | |
conversionArea |
SitumConversionArea | |
customFields |
object | |
radius |
number | |
name |
string |
- Source: