All Classes and Interfaces

Class
Description
Representation of an angle.
Enables asset tracking by scanning BLE beacons within the user's environment.
 
Represents a BLE filter.
Builder for Beacon objects
Represents a rectangle bounds in a greographic 2D space Instances are immutable.
A building.
Builder to create a Building instance
A building and its dependencies: floors, POIs and events
Builder to create an instance of BuildingInfo
A building resource with building identifier
A calibration area.
 
Scans for a calibration.
A structure that contains cartesian coordinate.
A circle with center and radius
Represents the collision between two geometric objects.
 
The errors received in Handler.onFailure(Error) that could be produced in all the managers
 
Defines the configuration for CommunicationManager requests.
 
The Communication manager allows you to make asynchronous requests to the server, mostly to fetch data.
The error codes received in Handler.onFailure(Error) on the CommunicationManager
 
Deprecated.
Set the configuration of the the Situm SDK: user credentials, dashboard url, cache expiration, etc.
A structure that contains geographical coordinate.
Utility class to convert between cartesian coordinates and geographical coordinates.
Configuration options related to remote diagnostic and telemetry.
 
Define 2D dimensions of a rectangular area.
Allows route calculation between two points, usually from current user's location.
The error codes received in Handler.onFailure(Error) on the DirectionsManager
 
It represents a modification applied to a graph in order to compute a @{link Route} The basic modifier is considered to be an Action represented by a @{link Actions} options and elements represented by a list of @{link TagModifier} instances where this action would be applied.
Actions to be processed when computing a route
Helper class to create well formed instances of DirectionsModifier class.
Additional options to keep compatibility with previous versions.
Include additional parameters that determine how a route is computed, which links should be considered (either avoided or prioritized) when finding a route between two points.
Helper class that creates well formed DirectionsOptions instances.
Parameters to request a route with DirectionsManager.
The accessibility mode used to calculate a route
DirectionsRequest builder static inner class.
Error object with information
The possible domains where the error can be produced
Possible actions for EventOccurrences
An event occurrence
Encapsulates Augmented Reality information computed by this SDK.
 
 
 
 
 
Deprecated.
Use a for with an if to filter the collection
Deprecated.
Use a for with an if to filter the collection
Deprecated.
Use a for with an if to filter the collection
Field to filter
Deprecated.
Use a for with an if to filter the collection
Floor of a building.
Builder to create a Floor instance
A floor resource with building identifier and floor identifier
 
Builder constructor that allows to configure all the ForegroundServiceNotificationOptions parameters.
Predefined actions performed when tapping the Situm Foreground Service Notification.
Represents a geographic region in a building.
 
Implement this class to get notified about entering/exiting geofences.
A Grid formed by cells.
Interface to receive result of an async request
The supported HTTP methods used in the custom requests
The supported HTTP options use in HttpRequest
Custom HTTP request to use with HttpRequestExecutor.
 
Class intended just for internal SDK use to make custom HTTP requests to the Dashboard
A string with a different value depending of the language.
Allows creating a I18nString in a handier way.
Represents the instruction that a user should follow when on a RouteStep to continue the route
Defines the main action of the indication
 
Defines the change in orientation associated the the indication
A cell of a Grid with the position (x,y) and an integer value
Class to represent a calibration
A location.
 
The quality of the location/bearing.
Used for received locations and statuses from the LocationManager.
This class provides Situm Indoor and / or Outdoor positioning.
The error codes that the LocationManager can generate (all errors will be communicated through the LocationListener.onError(Error) callback).
 
 
 
 
A data object that allows you to configure the positioning parameters of the LocationManager (e.g.
Builder constructor that allows to configure all the LocationRequest parameters.
Deprecated.
This Enum is no longer used, the SDK always computes the geolocations in the same way (in the device without continuosly accessing the internet, behaving like the old INPHONE mode).
Allows to indicate how the user that carries the smartphone moves: by foot (default), by car, etc.
Enum that allows to specify whether the geolocations computed should be sent to Situm Platform, and if so with which periodicity (time interval).
Location status values passed via the LocationListener.onStatusChanged(LocationStatus) callback.
A mapper to transform objects from Sdk into Maps.
NavigationListener Interface to receive updates from NavigationManager object.
Central point to update the progress of a user when follows a route
Provide information of the progress of a user while following a route.
NavigationProgress builder static inner class.
Holds NavigationManager request parameters
NavigationState builder static inner class.
This interface defines options relative to network operations.
Supported SDK Cache Strategies.
This class implements NetworkOptions.
 
The organization name, UUID, colors and logo
 
When you build the LocationRequest, this data object configures the Global Mode (see LocationRequest for details) options: Outdoor positioning, Building Detector and Open Sky Detector parameters.
Builder for the OutdoorLocationOptions class.
Allows to configure how Situm SDK will detect the building where the user is (building detector strategy).
Point of Interest, associated to a building, regardless of whether it's place inside or outside the building.
Builder to create a Poi instances
Category of Point of Interest.
Builder to construct a PoiCategory
Associate geographical coordinate (Location) with Building and Floor (Cartography) and cartesian coordinate relative to that building.
 
Represents the device positions
Builder to create a RealTimeData instance
Listener in which the device positions are received
RealTimeManager provides the ability to obtain real-time data from device positions.
Represents the configuration for getting realtime devices positions in
Builder to create a RealTimeRequest instance By default the poll time will be setted to 10 seconds.
A remote calibration stored in the cloud.
 
 
This class encapsulates all the objects that can be configured remotely using the dashboard, at this moment: LocationRequest
Abstract base class with common properties across Resources
Represents a constraint that could not be satisfied when computing a Route object with DirectionsManager.requestDirections(DirectionsRequest, Handler).
 
Route between two points.
Helper class to create well formed instances of @{link es.situm.
 
 
A continuous segment of a route that contains points of the same floor
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.
RouteStep builder static inner class.
Scans data of the calibration.
 
Deprecated.
Use Circle
An event: POI with radius, conversion area and asociated statistics.
Main entry point for the Situm SDK.
 
Builder to create an instance of Tile
Specifies a properties (tag) based on which Directions API will modify its graph.
Helper class to create well formed instances of TagModifier class
Theme colors
Abstraction of URL.