A B C D E F G H I K L M N O P Q R S T U V W 
All Classes All Packages

A

accessibilityMode(DirectionsRequest.AccessibilityMode) - Method in class es.situm.sdk.directions.DirectionsRequest.Builder
Deprecated.
ACCESSIBLE - es.situm.sdk.directions.DirectionsModifier.LEGACY_OPTIONS
The route should always use accessible nodes
action(DirectionsModifier.Actions) - Method in class es.situm.sdk.directions.DirectionsModifier.Builder
Set the action to perform.
addBeaconFilter(BeaconFilter) - Method in class es.situm.sdk.location.LocationRequest.Builder
Through a BeaconFilter object, adds a beacon UUID whose signals will be taken into account when using BLE for positioning.
addBeaconFilters(List<BeaconFilter>) - Method in class es.situm.sdk.location.LocationRequest.Builder
Through a list of BeaconFilter objects, adds a list of beacon UUIDs whose signals will be taken into account when using BLE for positioning.
addExternalLocation(ExternalLocation) - Method in interface es.situm.sdk.location.LocationManager
Adds an external Location for the SDK to process and return as a Location object through the LocationListener in LocationManager.requestLocationUpdates(LocationRequest, LocationListener)
address(String) - Method in class es.situm.sdk.model.cartography.Building.Builder
 
addRoutePoints(List<Point>) - Method in class es.situm.sdk.location.LocationParametersUpdate.Builder
Ordered list of points the location engine will use to compute locations.
addRoutePoints(List<Point>) - Method in class es.situm.sdk.location.LocationRequest.Builder
 
allowInvalidSSLCertificate(boolean) - Method in class es.situm.sdk.Configuration
Tell the system to trust the SSL certificate of the server (even though the Authority is not valid).
altitude(double) - Method in class es.situm.sdk.model.cartography.Floor.Builder
 
AND - es.situm.sdk.utils.filter.Filter.FilterMode
Deprecated.
 
Angle - Class in es.situm.sdk.model.location
Representation of an angle.
ANY_LANGUAGE - Static variable in class es.situm.sdk.model.I18nString
Special code, non ISO 693-2, to denote value to use by default.
anyLanguage(String) - Method in class es.situm.sdk.model.I18nString.Builder
Add string to use as a default value, when there is no translation to some language
asStringURL() - Method in class es.situm.sdk.model.URL
Returns value if URL.isAbsolute(), or SERVER_URL + value if URL.isRelative().
asURL() - Method in class es.situm.sdk.model.URL
Returns current URL as a URL.
AUTHENTICATE_HTTP_BASIC - Static variable in annotation type es.situm.sdk.communication.HttpOption
Apply http basic auth.
AUTHENTICATE_JWT - Static variable in annotation type es.situm.sdk.communication.HttpOption
Apply standard authentication.
AUTO_ENABLE_BLE_FORBIDDEN - es.situm.sdk.location.LocationStatus
autoEnableBleDuringPositioning() - Method in class es.situm.sdk.location.LocationRequest
Returns true if Situm SDK is configured to re-enable Bluetooth when the user disables it from system's tray.
autoEnableBleDuringPositioning(Boolean) - Method in class es.situm.sdk.location.LocationRequest.Builder
If true, Situm will re-enable Bluetooth even if user disables it from system's tray.
averageSnrThreshold(float) - Method in class es.situm.sdk.location.OutdoorLocationOptions.Builder
Deprecated.
This feaure is not supported from Android 12 onward, and will be removed in future SDK versions.
AVOID - es.situm.sdk.directions.DirectionsModifier.Actions
Gives less importance to links
avoidModifier(DirectionsModifier) - Method in class es.situm.sdk.directions.DirectionsOptions.Builder
Apply DirectionsModifier that will be avoided.

B

BACKWARD - es.situm.sdk.model.directions.Indication.Orientation
 
BATTERY_SAVER - es.situm.sdk.location.LocationRequest.RealtimeUpdateInterval
Computed geolocations will be sent to Situm Platform every 30 minutes.
BeaconFilter - Class in es.situm.sdk.model.location
Represents a BLE filter.
BeaconFilter.Builder - Class in es.situm.sdk.model.location
Builder for Beacon objects
bearing(Angle) - Method in class es.situm.sdk.model.location.Location.Builder
Used in outdoor locations.
BLE - es.situm.sdk.location.OutdoorLocationOptions.BuildingDetector
The user will be geolocated inside the building whose BLE calibration signals match better with those perceived by the user smartphone.
BLE - es.situm.sdk.model.calibration.ScansType
 
BLE_NOT_AVAILABLE - es.situm.sdk.location.LocationStatus
Bluetooth sensor is not available or the app is running on Android SDK API < 18 (BLE scanning is not supported before API 18).
BLE_SENSOR_DISABLED_BY_USER - es.situm.sdk.location.LocationStatus
The BLE sensor has been disabled by the user (e.g.
body(String, String) - Method in class es.situm.sdk.communication.HttpRequest.Builder
Set a custom body with the specified content type
bodyJson(String) - Method in class es.situm.sdk.communication.HttpRequest.Builder
Set the JSON body of the request
BOTH - es.situm.sdk.utils.filter.Filter.KeyValueFilter.FilterBy
Deprecated.
 
Bounds - Class in es.situm.sdk.model.location
Represents a rectangle bounds in a greographic 2D space Instances are immutable.
Bounds(Coordinate[]) - Constructor for class es.situm.sdk.model.location.Bounds
Creates a rectangular Bound given the the geographic coordinate of the 4 corners.
Bounds(Coordinate, Coordinate, Coordinate, Coordinate) - Constructor for class es.situm.sdk.model.location.Bounds
Creates a rectangular Bound given the the geographic coordinate of the 4 corners.
build() - Method in class es.situm.sdk.communication.HttpRequest.Builder
 
build() - Method in class es.situm.sdk.configuration.network.NetworkOptionsImpl.Builder
 
build() - Method in class es.situm.sdk.directions.DirectionsModifier.Builder
Returns a new instance of DirectionsModifier
build() - Method in class es.situm.sdk.directions.DirectionsOptions.Builder
Returns a DirectionsOptions instance built from the parameters previously set.
build() - Method in class es.situm.sdk.directions.DirectionsRequest.Builder
Returns a DirectionsRequest built from the parameters previously set.
build() - Method in class es.situm.sdk.directions.TagModifier.Builder
Returns an instance of the TagModifier class
build() - Method in class es.situm.sdk.location.ExternalLocation.Builder
Builds the ExternalLocation.
build() - Method in class es.situm.sdk.location.LocationParametersUpdate.Builder
 
build() - Method in class es.situm.sdk.location.LocationRequest.Builder
Builds the LocationRequest
build() - Method in class es.situm.sdk.location.OutdoorLocationOptions.Builder
build() - Method in class es.situm.sdk.model.calibration.RemoteCalibration.Builder
 
build() - Method in class es.situm.sdk.model.cartography.Building.Builder
 
build() - Method in class es.situm.sdk.model.cartography.BuildingInfo.Builder
 
build() - Method in class es.situm.sdk.model.cartography.CalibrationArea.Builder
 
build() - Method in class es.situm.sdk.model.cartography.Floor.Builder
 
build() - Method in class es.situm.sdk.model.cartography.Geofence.Builder
 
build() - Method in class es.situm.sdk.model.cartography.Poi.Builder
 
build() - Method in class es.situm.sdk.model.cartography.PoiCategory.Builder
 
build() - Method in class es.situm.sdk.model.directions.Indication.Builder
 
build() - Method in class es.situm.sdk.model.directions.Restriction.Builder
 
build() - Method in class es.situm.sdk.model.directions.Route.Builder
 
build() - Method in class es.situm.sdk.model.directions.RouteStep.Builder
 
build() - Method in class es.situm.sdk.model.I18nString.Builder
 
build() - Method in class es.situm.sdk.model.location.BeaconFilter.Builder
Builds the Beacon
build() - Method in class es.situm.sdk.model.location.Location.Builder
 
build() - Method in class es.situm.sdk.model.navigation.NavigationProgress.Builder
Returns a NavigationProgress built from the parameters previously set.
build() - Method in class es.situm.sdk.model.organization.OrganizationTheme.Builder
 
build() - Method in class es.situm.sdk.model.realtime.RealTimeData.Builder
 
build() - Method in class es.situm.sdk.navigation.NavigationRequest.Builder
Returns a NavigationState with the previously set parameters.
build() - Method in class es.situm.sdk.realtime.RealTimeRequest.Builder
 
Builder() - Constructor for class es.situm.sdk.communication.HttpRequest.Builder
 
Builder() - Constructor for class es.situm.sdk.configuration.network.NetworkOptionsImpl.Builder
 
Builder() - Constructor for class es.situm.sdk.directions.DirectionsModifier.Builder
 
Builder() - Constructor for class es.situm.sdk.directions.DirectionsOptions.Builder
 
Builder() - Constructor for class es.situm.sdk.directions.DirectionsRequest.Builder
 
Builder() - Constructor for class es.situm.sdk.directions.TagModifier.Builder
 
Builder() - Constructor for class es.situm.sdk.location.LocationParametersUpdate.Builder
 
Builder() - Constructor for class es.situm.sdk.location.LocationRequest.Builder
 
Builder() - Constructor for class es.situm.sdk.location.OutdoorLocationOptions.Builder
Constructor.
Builder() - Constructor for class es.situm.sdk.model.calibration.RemoteCalibration.Builder
 
Builder() - Constructor for class es.situm.sdk.model.cartography.Building.Builder
 
Builder() - Constructor for class es.situm.sdk.model.cartography.BuildingInfo.Builder
 
Builder() - Constructor for class es.situm.sdk.model.cartography.Floor.Builder
 
Builder() - Constructor for class es.situm.sdk.model.cartography.Geofence.Builder
 
Builder() - Constructor for class es.situm.sdk.model.cartography.PoiCategory.Builder
 
Builder() - Constructor for class es.situm.sdk.model.directions.Indication.Builder
 
Builder() - Constructor for class es.situm.sdk.model.directions.Restriction.Builder
 
Builder() - Constructor for class es.situm.sdk.model.directions.Route.Builder
 
Builder() - Constructor for class es.situm.sdk.model.directions.RouteStep.Builder
 
Builder() - Constructor for class es.situm.sdk.model.I18nString.Builder
 
Builder() - Constructor for class es.situm.sdk.model.location.BeaconFilter.Builder
 
Builder() - Constructor for class es.situm.sdk.model.navigation.NavigationProgress.Builder
 
Builder() - Constructor for class es.situm.sdk.model.organization.OrganizationTheme.Builder
 
Builder() - Constructor for class es.situm.sdk.model.realtime.RealTimeData.Builder
 
Builder() - Constructor for class es.situm.sdk.navigation.NavigationRequest.Builder
 
Builder() - Constructor for class es.situm.sdk.realtime.RealTimeRequest.Builder
 
Builder(long, String, Point, float) - Constructor for class es.situm.sdk.model.location.Location.Builder
 
Builder(HttpRequest) - Constructor for class es.situm.sdk.communication.HttpRequest.Builder
 
Builder(NetworkOptions) - Constructor for class es.situm.sdk.configuration.network.NetworkOptionsImpl.Builder
 
Builder(DirectionsRequest) - Constructor for class es.situm.sdk.directions.DirectionsRequest.Builder
 
Builder(LocationParametersUpdate) - Constructor for class es.situm.sdk.location.LocationParametersUpdate.Builder
 
Builder(LocationRequest) - Constructor for class es.situm.sdk.location.LocationRequest.Builder
 
Builder(OutdoorLocationOptions) - Constructor for class es.situm.sdk.location.OutdoorLocationOptions.Builder
Copy constructor.
Builder(RemoteCalibration) - Constructor for class es.situm.sdk.model.calibration.RemoteCalibration.Builder
 
Builder(Building) - Constructor for class es.situm.sdk.model.cartography.Building.Builder
 
Builder(BuildingInfo) - Constructor for class es.situm.sdk.model.cartography.BuildingInfo.Builder
 
Builder(CalibrationArea) - Constructor for class es.situm.sdk.model.cartography.CalibrationArea.Builder
 
Builder(Floor) - Constructor for class es.situm.sdk.model.cartography.Floor.Builder
 
Builder(Geofence) - Constructor for class es.situm.sdk.model.cartography.Geofence.Builder
 
Builder(Poi) - Constructor for class es.situm.sdk.model.cartography.Poi.Builder
 
Builder(PoiCategory) - Constructor for class es.situm.sdk.model.cartography.PoiCategory.Builder
 
Builder(Point) - Constructor for class es.situm.sdk.model.cartography.Poi.Builder
 
Builder(RouteStep) - Constructor for class es.situm.sdk.model.directions.RouteStep.Builder
 
Builder(I18nString) - Constructor for class es.situm.sdk.model.I18nString.Builder
 
Builder(BeaconFilter) - Constructor for class es.situm.sdk.model.location.BeaconFilter.Builder
Copy builder
Builder(Location) - Constructor for class es.situm.sdk.model.location.Location.Builder
 
Builder(NavigationProgress) - Constructor for class es.situm.sdk.model.navigation.NavigationProgress.Builder
 
Builder(OrganizationTheme) - Constructor for class es.situm.sdk.model.organization.OrganizationTheme.Builder
 
Builder(RealTimeData) - Constructor for class es.situm.sdk.model.realtime.RealTimeData.Builder
 
Builder(NavigationRequest) - Constructor for class es.situm.sdk.navigation.NavigationRequest.Builder
 
Builder(RealTimeRequest) - Constructor for class es.situm.sdk.realtime.RealTimeRequest.Builder
 
Builder(String) - Constructor for class es.situm.sdk.model.I18nString.Builder
 
Builder(String, Coordinate) - Constructor for class es.situm.sdk.model.cartography.Poi.Builder
Creates a Builder for outdoor POI
Builder(String, String, double, double) - Constructor for class es.situm.sdk.location.ExternalLocation.Builder
 
Builder(String, String, Coordinate, CartesianCoordinate) - Constructor for class es.situm.sdk.model.cartography.Poi.Builder
Creates a Builder for indoor POI.
Builder(String, String, String, String) - Constructor for class es.situm.sdk.model.cartography.CalibrationArea.Builder
 
building(Building) - Method in class es.situm.sdk.model.cartography.BuildingInfo.Builder
 
building(Building) - Method in class es.situm.sdk.model.directions.Route.Builder
 
building(Building) - Method in class es.situm.sdk.realtime.RealTimeRequest.Builder
 
Building - Class in es.situm.sdk.model.cartography
A building.
BUILDING_MODEL_DOWNLOAD_ERROR - Static variable in interface es.situm.sdk.location.LocationManager.Code
(Building Mode only) Could not download the positioning model of the building where you wanted to perform positioning.
BUILDING_MODEL_PROCESSING_ERROR - Static variable in interface es.situm.sdk.location.LocationManager.Code
An error occurred while processing the positioning model of a building where you are attempting to perform positioning.
BUILDING_NOT_CALIBRATED - Static variable in interface es.situm.sdk.location.LocationManager.Code
(Building Mode only) The building where you are trying to perform positioning is not calibrated.
BUILDING_NOT_FOUND - Static variable in interface es.situm.sdk.location.LocationManager.Code
(Building Mode only) The building where you are trying to perform positioning does not exist or you don't have permissions to see it.
BUILDING_REQUEST_FAILED - Static variable in interface es.situm.sdk.directions.DirectionsManager.Code
Error downloading the building data needed to calculate a route
Building.Builder - Class in es.situm.sdk.model.cartography
Builder to create a Building instance
buildingDetector(OutdoorLocationOptions.BuildingDetector) - Method in class es.situm.sdk.location.OutdoorLocationOptions.Builder
(Global Mode only) Sets the OutdoorLocationOptions.BuildingDetector used to detect the building where the user is.
buildingFloors(Collection<Floor>) - Method in class es.situm.sdk.model.directions.Route.Builder
 
buildingIdentifier(String) - Method in class es.situm.sdk.location.LocationParametersUpdate.Builder
Identifier of the building.
buildingIdentifier(String) - Method in class es.situm.sdk.location.LocationRequest.Builder
(Building Mode only) Sets the identifier of the building where you want to compute the positioning.
buildingIdentifier(String) - Method in class es.situm.sdk.model.calibration.RemoteCalibration.Builder
 
buildingIdentifier(String) - Method in class es.situm.sdk.model.cartography.Floor.Builder
 
buildingIdentifier(String) - Method in class es.situm.sdk.model.cartography.Geofence.Builder
 
BuildingInfo - Class in es.situm.sdk.model.cartography
A building and its dependencies: floors, POIs and events
BuildingInfo.Builder - Class in es.situm.sdk.model.cartography
Builder to create an instance of BuildingInfo
BuildingResource - Interface in es.situm.sdk.model
A building resource with building identifier
BY_CAR - es.situm.sdk.location.LocationRequest.MotionMode
User moves in a car, Situm estimates the displacement using inertial sensors (accelerometer, gyroscope, magnetometer).
BY_FOOT - es.situm.sdk.location.LocationRequest.MotionMode
(DEFAULT) User moves on foot (walking), Situm estimates the displacement using inertial sensors (accelerometer, gyroscope, magnetometer).
BY_FOOT_VISUAL_ODOMETRY - es.situm.sdk.location.LocationRequest.MotionMode
(EXPERIMENTAL) User moves on foot (walking), Situm estimates the movement by computing the visual odometry on the back camera feed.

C

CACHE_FIRST - es.situm.sdk.configuration.network.NetworkOptions.CacheStrategy
Force to use cache even if it's too old.
CACHE_FIRST - Static variable in annotation type es.situm.sdk.communication.CommunicationOptions
Deprecated.
Force to use cache even if it's too old.
CALCULATING - es.situm.sdk.location.LocationStatus
Situm SDK is computing the location of the user.
CALCULATING - es.situm.sdk.model.directions.Indication.Action
 
CALCULATING - Static variable in class es.situm.sdk.model.directions.Indication
 
CALIBRATION - es.situm.sdk.error.Error.Domain
 
CalibrationArea - Class in es.situm.sdk.model.cartography
A calibration area.
CalibrationArea.Builder - Class in es.situm.sdk.model.cartography
 
calibrationManager() - Static method in class es.situm.sdk.SitumSdk
Returns the CalibrationManager which can be used to calibrate Buildings.
CalibrationScans - Class in es.situm.sdk.model.calibration
Scans for a calibration.
CalibrationScans(String, List<CartesianCoordinate>, List<CartesianCoordinate>, List<CartesianCoordinate>) - Constructor for class es.situm.sdk.model.calibration.CalibrationScans
 
callback(Handler<? super InputStream>) - Method in class es.situm.sdk.communication.HttpRequest.Builder
Set the callback where you will be notified when the requests completes successfully or with an error.
cartesianBearing(Angle, Angle) - Method in class es.situm.sdk.model.location.Location.Builder
Used in indoor locations.
cartesianBearing(Angle, Angle, Location.Quality) - Method in class es.situm.sdk.model.location.Location.Builder
 
CartesianCoordinate - Class in es.situm.sdk.model.location
A structure that contains cartesian coordinate.
CartesianCoordinate(double, double) - Constructor for class es.situm.sdk.model.location.CartesianCoordinate
 
CartesianCoordinate(CartesianCoordinate) - Constructor for class es.situm.sdk.model.location.CartesianCoordinate
 
category(PoiCategory) - Method in class es.situm.sdk.model.cartography.Poi.Builder
 
center(Coordinate) - Method in class es.situm.sdk.model.cartography.Building.Builder
 
centerPositionInBuildingDuringTransition() - Method in class es.situm.sdk.location.OutdoorLocationOptions
centerPositionInBuildingDuringTransition(boolean) - Method in class es.situm.sdk.location.OutdoorLocationOptions.Builder
(Only applies if BuildingDetector has not been set to GPS_PROXIMITY) Sets whether Indoor Positions should be returned immediately after the BuildingDetector detects that the smartphone is in a certain building, even if these positions are not accurate yet.
CHANGE_FLOOR - es.situm.sdk.model.directions.Indication.Action
 
CHOOSE_SHORTEST - es.situm.sdk.directions.DirectionsRequest.AccessibilityMode
Deprecated.
The route should choose the best route, without taking into account if it is accessible or not.
chunk(Indication) - Method in class es.situm.sdk.model.directions.Indication
Constructs a new Indication form the current one and the provided indication2.
Circle - Class in es.situm.sdk.model.cartography
A circle with center and radius
Circle(Point, float) - Constructor for class es.situm.sdk.model.cartography.Circle
 
clickedNow() - Method in class es.situm.sdk.model.geofencing.EventOccurrence
Alias for this.setWhenClicked(new Date());
closestLocationInRoute(Location) - Method in class es.situm.sdk.model.navigation.NavigationProgress.Builder
Sets the closestLocationInRoute and closestRoutePoint and returns a reference to this Builder so that the methods can be chained together.
closestRoutePoint(Point) - Method in class es.situm.sdk.model.navigation.NavigationProgress.Builder
CLOUD - es.situm.sdk.location.LocationRequest.IndoorProvider
Deprecated.
INPHONE mode will be used instead
code(String) - Method in class es.situm.sdk.model.cartography.Geofence.Builder
 
code(String) - Method in class es.situm.sdk.model.cartography.PoiCategory.Builder
 
collidesWith(Edge<? extends Point>) - Method in class es.situm.sdk.model.cartography.Circle
 
Collision - Class in es.situm.sdk.model.directions
Represents the collision between two geometric objects.
Collision() - Constructor for class es.situm.sdk.model.directions.Collision
 
CommonErrorConstant - Interface in es.situm.sdk.error
 
CommonErrorConstant.Code - Interface in es.situm.sdk.error
The errors received in Handler.onFailure(Error) that could be produced in all the managers
CommonErrorConstant.PropertyKey - Interface in es.situm.sdk.error
 
COMMUNICATION - es.situm.sdk.error.Error.Domain
 
CommunicationConfig - Interface in es.situm.sdk.communication
Defines the configuration for CommunicationManager requests.
CommunicationConfigImpl - Class in es.situm.sdk.communication
 
CommunicationConfigImpl() - Constructor for class es.situm.sdk.communication.CommunicationConfigImpl
 
CommunicationConfigImpl(NetworkOptions) - Constructor for class es.situm.sdk.communication.CommunicationConfigImpl
 
communicationManager() - Static method in class es.situm.sdk.SitumSdk
Returns the communication manager.
CommunicationManager - Interface in es.situm.sdk.communication
The Communication manager allows you to make asynchronous requests to the server, mostly to fetch data.
CommunicationManager.Code - Interface in es.situm.sdk.communication
The error codes received in Handler.onFailure(Error) on the CommunicationManager
CommunicationManager.PropertyKey - Interface in es.situm.sdk.communication
 
CommunicationOptions - Annotation Type in es.situm.sdk.communication
Deprecated.
COMPASS_CALIBRATION_NEEDED - es.situm.sdk.location.LocationStatus
Warning: the compass is uncalibrated and needs to be calibrated.
COMPASS_CALIBRATION_NOT_NEEDED - es.situm.sdk.location.LocationStatus
General Info: the compass is properly calibrated and its data will be used without any issue.
computeInterval(int) - Method in class es.situm.sdk.location.OutdoorLocationOptions.Builder
Interval (in milliseconds) between consecutive GPS readings performed by Situm SDK, and therefore between consecutive generated Outdoor Locations (it also affects how fast the Open Sky Detector and the BuildingDetector.GPS_PROXIMITY work, if they have been enabled).
configuration() - Static method in class es.situm.sdk.SitumSdk
Returns the public configuration holder.
Configuration - Class in es.situm.sdk
Set the configuration of the the Situm SDK: user credentials, dashboard url, cache expiration, etc.
CONFIGURATION_ERROR - Static variable in interface es.situm.sdk.location.LocationManager.Code
The configuration specified using the LocationRequest is illegal.
contains(double, double) - Method in class es.situm.sdk.model.location.Dimensions
Check if the cartesian coordinates of a point are inside the dimension.
contains(DirectionsModifier.Actions) - Method in class es.situm.sdk.directions.DirectionsOptions
Checks if modifiers include a modifier for a specific action.
contains(Point) - Method in class es.situm.sdk.model.cartography.Circle
 
containsLegacyOptions() - Method in class es.situm.sdk.directions.DirectionsOptions
Checks if modifiers contains any DirectionsModifier.LEGACY_OPTIONS option
containsPoint(Point) - Method in class es.situm.sdk.model.cartography.BuildingInfo
 
containsValidModifiers() - Method in class es.situm.sdk.directions.DirectionsRequest
Check if there are valid modifiers (which action is different that UNKNOWN)
convertedNow() - Method in class es.situm.sdk.model.geofencing.EventOccurrence
Alias for this.setWhenConverted(new Date());
Coordinate - Class in es.situm.sdk.model.location
A structure that contains geographical coordinate.
Coordinate(double, double) - Constructor for class es.situm.sdk.model.location.Coordinate
 
Coordinate(Coordinate) - Constructor for class es.situm.sdk.model.location.Coordinate
 
CoordinateConverter - Class in es.situm.sdk.location.util
Utility class to convert between cartesian coordinates and geographical coordinates.
CoordinateConverter(Dimensions, Coordinate) - Constructor for class es.situm.sdk.location.util.CoordinateConverter
Define how cartesian area is placed in geographical space, aligned with east-west and north-south axis.
CoordinateConverter(Dimensions, Coordinate, Angle) - Constructor for class es.situm.sdk.location.util.CoordinateConverter
Define how the cartesian area is placed in geographical space, with a rotation with respect to east-west axis.
create(String, List<Point>) - Static method in class es.situm.sdk.model.directions.RouteSegment
 
createFile(File) - Method in class es.situm.sdk.model.calibration.LocalCalibration
Creates the file to add the calibration
createOccurrenceForEvent(SitumEvent, Handler<EventOccurrence>) - Method in interface es.situm.sdk.communication.CommunicationManager
Create an occurrence for an event.
CREATOR - Static variable in class es.situm.sdk.directions.DirectionsRequest
 
CREATOR - Static variable in class es.situm.sdk.location.ExternalLocation
 
CREATOR - Static variable in class es.situm.sdk.location.LocationRequest
 
CREATOR - Static variable in class es.situm.sdk.location.OutdoorLocationOptions
 
CREATOR - Static variable in class es.situm.sdk.location.util.CoordinateConverter
 
CREATOR - Static variable in class es.situm.sdk.model.calibration.RemoteCalibration
 
CREATOR - Static variable in class es.situm.sdk.model.cartography.Building
 
CREATOR - Static variable in class es.situm.sdk.model.cartography.BuildingInfo
 
CREATOR - Static variable in class es.situm.sdk.model.cartography.CalibrationArea
 
CREATOR - Static variable in class es.situm.sdk.model.cartography.Circle
 
CREATOR - Static variable in class es.situm.sdk.model.cartography.Floor
 
CREATOR - Static variable in class es.situm.sdk.model.cartography.Geofence
 
CREATOR - Static variable in class es.situm.sdk.model.cartography.Poi
 
CREATOR - Static variable in class es.situm.sdk.model.cartography.PoiCategory
 
CREATOR - Static variable in class es.situm.sdk.model.cartography.Point
 
CREATOR - Static variable in class es.situm.sdk.model.directions.Indication
 
CREATOR - Static variable in class es.situm.sdk.model.directions.Route
 
CREATOR - Static variable in class es.situm.sdk.model.directions.RouteStep
 
CREATOR - Static variable in class es.situm.sdk.model.geofencing.EventOccurrence
 
CREATOR - Static variable in class es.situm.sdk.model.I18nString
 
CREATOR - Static variable in class es.situm.sdk.model.location.Angle
 
CREATOR - Static variable in class es.situm.sdk.model.location.BeaconFilter
 
CREATOR - Static variable in class es.situm.sdk.model.location.Bounds
 
CREATOR - Static variable in class es.situm.sdk.model.location.CartesianCoordinate
 
CREATOR - Static variable in class es.situm.sdk.model.location.Coordinate
 
CREATOR - Static variable in class es.situm.sdk.model.location.Dimensions
 
CREATOR - Static variable in class es.situm.sdk.model.location.Location
 
CREATOR - Static variable in class es.situm.sdk.model.navigation.NavigationProgress
 
CREATOR - Static variable in class es.situm.sdk.model.realtime.RealTimeData
 
CREATOR - Static variable in class es.situm.sdk.model.URL
 
CREATOR - Static variable in class es.situm.sdk.realtime.RealTimeRequest
 
CREATOR - Static variable in class es.situm.sdk.v1.SitumConversionArea
Deprecated.
 
CREATOR - Static variable in class es.situm.sdk.v1.SitumEvent
 
currentEmailAccount() - Method in class es.situm.sdk.Configuration
Return user email of credentials previously provided with Configuration.setApiKey(String, String), Configuration.setUserPass(String, String) or declared in the Android Manifest
customFields(Map<String, String>) - Method in class es.situm.sdk.model.location.Location.Builder
 
customHeaders(Map<String, String>) - Method in class es.situm.sdk.communication.HttpRequest.Builder
Set custom headers of the request

D

DEFAULT - Static variable in annotation type es.situm.sdk.communication.CommunicationOptions
Deprecated.
If there is no cache or if the cache is too old it will download from server.
DEFAULT - Static variable in class es.situm.sdk.model.cartography.PoiCategory
 
DEFAULT_ACCESSIBILITY_MODE - Static variable in class es.situm.sdk.directions.DirectionsRequest
 
DEFAULT_DISTANCE_CHANGE_FLOOR - Static variable in class es.situm.sdk.navigation.NavigationRequest
 
DEFAULT_DISTANCE_THRESHOLD - Static variable in class es.situm.sdk.navigation.NavigationRequest
 
DEFAULT_DISTANCE_TO_CHANGE_INDICATION - Static variable in class es.situm.sdk.navigation.NavigationRequest
 
DEFAULT_DISTANCE_TO_IGNORE_FIRST_INDICATION - Static variable in class es.situm.sdk.navigation.NavigationRequest
 
DEFAULT_IGNORE_LOW_QUALITY_LOCATIONS - Static variable in class es.situm.sdk.navigation.NavigationRequest
 
DEFAULT_INDICATIONS_INTERVAL - Static variable in class es.situm.sdk.navigation.NavigationRequest
 
DEFAULT_INDOOR_PROVIDER - Static variable in class es.situm.sdk.location.LocationRequest
Default indoor provider (INPHONE by default)
DEFAULT_INTERVAL - Static variable in class es.situm.sdk.location.LocationRequest
Default interval (in milliseconds) to notify location updates via the LocationListener.onLocationChanged() callback (1000 millisecond by default)
DEFAULT_MOTION_MODE - Static variable in class es.situm.sdk.location.LocationRequest
Default motion mode (BY_FOOT by default)
DEFAULT_REALTIME_UPDATE_INTERVAL - Static variable in class es.situm.sdk.location.LocationRequest
Default interval (in milliseconds) between consecutive locations sent to Situm Platform (1000 milliseconds by default)
DEFAULT_ROUND_INDICATION_STEP - Static variable in class es.situm.sdk.navigation.NavigationRequest
 
DEFAULT_SMALLEST_DISPLACEMENT - Static variable in class es.situm.sdk.location.LocationRequest
Default smallest displacement to notify location updates via the LocationListener.onLocationChanged() callback (0.0 meters by default)
DEFAULT_SNR - Static variable in class es.situm.sdk.location.OutdoorLocationOptions
(Open Sky Detector only) Default GPS SNR (Signal-To-Noise Ratio) average value (in dBm) of method OutdoorLocationOptions.Builder.averageSnrThreshold.
DEFAULT_TIME_TO_FIRST_INDICATION - Static variable in class es.situm.sdk.navigation.NavigationRequest
 
DEFAULT_TIME_TO_IGNORE_UNEXPECTED_FLOOR_CHANGES - Static variable in class es.situm.sdk.navigation.NavigationRequest
 
defaultValue() - Method in class es.situm.sdk.model.I18nString
 
degrees() - Method in class es.situm.sdk.model.location.Angle
 
degreesClockwise() - Method in class es.situm.sdk.model.location.Angle
 
describeContents() - Method in class es.situm.sdk.directions.DirectionsRequest
 
describeContents() - Method in class es.situm.sdk.location.ExternalLocation
 
describeContents() - Method in class es.situm.sdk.location.LocationRequest
 
describeContents() - Method in class es.situm.sdk.location.OutdoorLocationOptions
 
describeContents() - Method in class es.situm.sdk.location.util.CoordinateConverter
 
describeContents() - Method in class es.situm.sdk.model.calibration.RemoteCalibration
 
describeContents() - Method in class es.situm.sdk.model.cartography.Building
 
describeContents() - Method in class es.situm.sdk.model.cartography.BuildingInfo
 
describeContents() - Method in class es.situm.sdk.model.cartography.CalibrationArea
 
describeContents() - Method in class es.situm.sdk.model.cartography.Circle
 
describeContents() - Method in class es.situm.sdk.model.cartography.Floor
 
describeContents() - Method in class es.situm.sdk.model.cartography.Geofence
 
describeContents() - Method in class es.situm.sdk.model.cartography.Poi
 
describeContents() - Method in class es.situm.sdk.model.cartography.PoiCategory
 
describeContents() - Method in class es.situm.sdk.model.cartography.Point
 
describeContents() - Method in class es.situm.sdk.model.directions.Indication
 
describeContents() - Method in class es.situm.sdk.model.directions.Route
 
describeContents() - Method in class es.situm.sdk.model.directions.RouteStep
 
describeContents() - Method in class es.situm.sdk.model.geofencing.EventOccurrence
 
describeContents() - Method in class es.situm.sdk.model.I18nString
 
describeContents() - Method in class es.situm.sdk.model.location.Angle
 
describeContents() - Method in class es.situm.sdk.model.location.BeaconFilter
 
describeContents() - Method in class es.situm.sdk.model.location.Bounds
 
describeContents() - Method in class es.situm.sdk.model.location.CartesianCoordinate
 
describeContents() - Method in class es.situm.sdk.model.location.Coordinate
 
describeContents() - Method in class es.situm.sdk.model.location.Dimensions
 
describeContents() - Method in class es.situm.sdk.model.location.Location
 
describeContents() - Method in class es.situm.sdk.model.navigation.NavigationProgress
 
describeContents() - Method in class es.situm.sdk.model.realtime.RealTimeData
 
describeContents() - Method in class es.situm.sdk.model.URL
 
describeContents() - Method in class es.situm.sdk.realtime.RealTimeRequest
 
describeContents() - Method in class es.situm.sdk.v1.SitumConversionArea
Deprecated.
 
describeContents() - Method in class es.situm.sdk.v1.SitumEvent
 
description(String) - Method in class es.situm.sdk.model.cartography.Geofence.Builder
Deprecated.
DETAILED_MESSAGE - Static variable in interface es.situm.sdk.error.CommonErrorConstant.PropertyKey
 
deviceId(String) - Method in class es.situm.sdk.model.location.Location.Builder
Identifier of the device that has generated the location (Retrieve the identifier of the device by using SitumSDK#getDeviceID()
devicesToFollow(List<String>) - Method in class es.situm.sdk.location.LocationParametersUpdate.Builder
List of identifiers of the device that needs to be followed.
dimensions(Dimensions) - Method in class es.situm.sdk.model.cartography.Building.Builder
 
Dimensions - Class in es.situm.sdk.model.location
Define 2D dimensions of a rectangular area.
Dimensions(double, double) - Constructor for class es.situm.sdk.model.location.Dimensions
 
directionsManager() - Static method in class es.situm.sdk.SitumSdk
Returns the route manager.
DirectionsManager - Interface in es.situm.sdk.directions
Allows route calculation between two points, usually from current user's location.
DirectionsManager.Code - Interface in es.situm.sdk.directions
The error codes received in Handler.onFailure(Error) on the DirectionsManager
DirectionsManager.PropertyKey - Interface in es.situm.sdk.directions
 
DirectionsModifier - Class in es.situm.sdk.directions
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.
DirectionsModifier.Actions - Enum in es.situm.sdk.directions
Actions to be processed when computing a route
DirectionsModifier.Builder - Class in es.situm.sdk.directions
Helper class to create well formed instances of DirectionsModifier class.
DirectionsModifier.LEGACY_OPTIONS - Enum in es.situm.sdk.directions
Additional options to keep compatibility with previous versions.
DirectionsOptions - Class in es.situm.sdk.directions
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.
DirectionsOptions.Builder - Class in es.situm.sdk.directions
Helper class that creates well formed DirectionsOptions instances.
DirectionsRequest - Class in es.situm.sdk.directions
Parameters to request a route with DirectionsManager.
DirectionsRequest.AccessibilityMode - Enum in es.situm.sdk.directions
Deprecated.
DirectionsRequest.Builder - Class in es.situm.sdk.directions
DirectionsRequest builder static inner class.
distance(double) - Method in class es.situm.sdk.model.directions.RouteStep.Builder
 
distanceTo(CartesianCoordinate) - Method in class es.situm.sdk.model.location.CartesianCoordinate
Calculates the distance (in meters) between this cartesian coordinate and another
distanceTo(Coordinate) - Method in class es.situm.sdk.model.location.Coordinate
Calculates the distance (in meters) between this coordinate and another
distanceToChangeFloorThreshold(double) - Method in class es.situm.sdk.navigation.NavigationRequest.Builder
Sets the distance threshold from when a floor change is considered reached.
distanceToChangeIndicationThreshold(double) - Method in class es.situm.sdk.navigation.NavigationRequest.Builder
Sets the distance threshold from when the next indication is considered reached.
distanceToClosestRoutePoint(double) - Method in class es.situm.sdk.model.navigation.NavigationProgress.Builder
Sets the distanceToClosestPointInRoute and returns a reference to this Builder so that the methods can be chained together.
distanceToEnd(double) - Method in class es.situm.sdk.model.directions.RouteStep.Builder
 
distanceToEndStep(double) - Method in class es.situm.sdk.model.navigation.NavigationProgress.Builder
Sets the distanceToEndStep and returns a reference to this Builder so that the methods can be chained together.
distanceToFloorChange(Double) - Method in class es.situm.sdk.model.directions.RouteStep.Builder
 
distanceToGoal(double) - Method in class es.situm.sdk.model.navigation.NavigationProgress.Builder
Sets the distanceToGoal and returns a reference to this Builder so that the methods can be chained together.
distanceToGoalThreshold(double) - Method in class es.situm.sdk.navigation.NavigationRequest.Builder
Sets the distance threshold from when the goal is considered reached.
distanceToIgnoreFirstIndication(double) - Method in class es.situm.sdk.navigation.NavigationRequest.Builder
Sets the maximum distance to ignore the first indication when navigating a route.

E

EMPTY - Static variable in class es.situm.sdk.model.cartography.calibration.Scans
 
EMPTY - Static variable in class es.situm.sdk.model.directions.Indication
 
EMPTY - Static variable in class es.situm.sdk.model.directions.RouteStep
 
EMPTY - Static variable in class es.situm.sdk.model.I18nString
 
EMPTY - Static variable in class es.situm.sdk.model.location.Angle
 
EMPTY - Static variable in class es.situm.sdk.model.location.CartesianCoordinate
 
EMPTY - Static variable in class es.situm.sdk.model.location.Coordinate
 
EMPTY - Static variable in class es.situm.sdk.model.location.Dimensions
 
EMPTY - Static variable in class es.situm.sdk.model.URL
 
EMPTY_HANDLER - Static variable in interface es.situm.sdk.utils.Handler
 
EMPTY_ID - Static variable in class es.situm.sdk.model.directions.RouteStep
 
EMPTY_IDENTIFIER - Static variable in class es.situm.sdk.model.Resource
 
EMPTY_IDENTIFIER_BACKWARDS - Static variable in class es.situm.sdk.model.Resource
 
EMPTY_INDOOR - Static variable in class es.situm.sdk.model.cartography.Point
 
EMPTY_OUTDOOR - Static variable in class es.situm.sdk.model.cartography.Point
 
enableOpenSkyDetector() - Method in class es.situm.sdk.location.OutdoorLocationOptions
Deprecated.
This feaure is not supported from Android 12 onward, and will be removed in future SDK versions.
enableOpenSkyDetector(boolean) - Method in class es.situm.sdk.location.OutdoorLocationOptions.Builder
Deprecated.
This feaure is not supported from Android 12 onward, and will be removed in future SDK versions.
enableOutdoorPositions(boolean) - Method in class es.situm.sdk.location.OutdoorLocationOptions.Builder
If true, Situm SDK will be able to use GPS signals to compute Outdoor Positions (also, these GPS signals may be used by the Open Sky Detector and the BuildingDetector.GPS_PROXIMITY, if these modules are enabled).
END - es.situm.sdk.model.directions.Indication.Action
 
END - Static variable in class es.situm.sdk.model.directions.Indication
 
equals(Object) - Method in class es.situm.sdk.directions.DirectionsRequest
 
equals(Object) - Method in class es.situm.sdk.location.ExternalLocation
 
equals(Object) - Method in class es.situm.sdk.location.LocationRequest
 
equals(Object) - Method in class es.situm.sdk.location.OutdoorLocationOptions
 
equals(Object) - Method in class es.situm.sdk.location.util.CoordinateConverter
 
equals(Object) - Method in class es.situm.sdk.model.calibration.LocalCalibration
 
equals(Object) - Method in class es.situm.sdk.model.calibration.RemoteCalibration
 
equals(Object) - Method in class es.situm.sdk.model.cartography.Building
 
equals(Object) - Method in class es.situm.sdk.model.cartography.CalibrationArea
 
equals(Object) - Method in class es.situm.sdk.model.cartography.Circle
 
equals(Object) - Method in class es.situm.sdk.model.cartography.Floor
 
equals(Object) - Method in class es.situm.sdk.model.cartography.Geofence
 
equals(Object) - Method in class es.situm.sdk.model.cartography.Poi
 
equals(Object) - Method in class es.situm.sdk.model.cartography.PoiCategory
 
equals(Object) - Method in class es.situm.sdk.model.cartography.Point
 
equals(Object) - Method in class es.situm.sdk.model.directions.Indication
 
equals(Object) - Method in class es.situm.sdk.model.directions.Route
 
equals(Object) - Method in class es.situm.sdk.model.directions.RouteStep
 
equals(Object) - Method in class es.situm.sdk.model.I18nString
 
equals(Object) - Method in class es.situm.sdk.model.location.Angle
 
equals(Object) - Method in class es.situm.sdk.model.location.BeaconFilter
 
equals(Object) - Method in class es.situm.sdk.model.location.Bounds
 
equals(Object) - Method in class es.situm.sdk.model.location.CartesianCoordinate
 
equals(Object) - Method in class es.situm.sdk.model.location.Coordinate
 
equals(Object) - Method in class es.situm.sdk.model.location.Dimensions
 
equals(Object) - Method in class es.situm.sdk.model.location.Location
 
equals(Object) - Method in class es.situm.sdk.model.navigation.NavigationProgress
 
equals(Object) - Method in class es.situm.sdk.model.organization.OrganizationTheme
 
equals(Object) - Method in class es.situm.sdk.model.organization.ThemeColors
 
equals(Object) - Method in class es.situm.sdk.model.realtime.RealTimeData
 
equals(Object) - Method in class es.situm.sdk.model.Resource
 
equals(Object) - Method in class es.situm.sdk.model.URL
 
equals(Object) - Method in class es.situm.sdk.navigation.NavigationRequest
 
equals(Object) - Method in class es.situm.sdk.realtime.RealTimeRequest
 
Error - Interface in es.situm.sdk.error
Error object with information
Error.Domain - Enum in es.situm.sdk.error
The possible domains where the error can be produced
es.situm.sdk - package es.situm.sdk
 
es.situm.sdk.communication - package es.situm.sdk.communication
 
es.situm.sdk.configuration.network - package es.situm.sdk.configuration.network
 
es.situm.sdk.directions - package es.situm.sdk.directions
 
es.situm.sdk.error - package es.situm.sdk.error
 
es.situm.sdk.location - package es.situm.sdk.location
 
es.situm.sdk.location.util - package es.situm.sdk.location.util
 
es.situm.sdk.model - package es.situm.sdk.model
 
es.situm.sdk.model.calibration - package es.situm.sdk.model.calibration
 
es.situm.sdk.model.cartography - package es.situm.sdk.model.cartography
 
es.situm.sdk.model.cartography.calibration - package es.situm.sdk.model.cartography.calibration
 
es.situm.sdk.model.configuration - package es.situm.sdk.model.configuration
 
es.situm.sdk.model.directions - package es.situm.sdk.model.directions
 
es.situm.sdk.model.geofencing - package es.situm.sdk.model.geofencing
 
es.situm.sdk.model.location - package es.situm.sdk.model.location
 
es.situm.sdk.model.navigation - package es.situm.sdk.model.navigation
 
es.situm.sdk.model.organization - package es.situm.sdk.model.organization
 
es.situm.sdk.model.realtime - package es.situm.sdk.model.realtime
 
es.situm.sdk.navigation - package es.situm.sdk.navigation
 
es.situm.sdk.realtime - package es.situm.sdk.realtime
 
es.situm.sdk.utils - package es.situm.sdk.utils
 
es.situm.sdk.utils.filter - package es.situm.sdk.utils.filter
 
es.situm.sdk.v1 - package es.situm.sdk.v1
 
EVENT_CLICKED - es.situm.sdk.model.geofencing.EventAction
Notifies that the user has clicked a previously seen event.
EVENT_CONVERTED - es.situm.sdk.model.geofencing.EventAction
Notifies that a previously seen and clicked event has been converted.
EventAction - Enum in es.situm.sdk.model.geofencing
Possible actions for EventOccurrences
eventClicked(EventOccurrence, Handler<EventOccurrence>) - Method in interface es.situm.sdk.communication.CommunicationManager
eventClicked(EventOccurrence, Map<String, Object>, Handler<EventOccurrence>) - Method in interface es.situm.sdk.communication.CommunicationManager
eventConverted(EventOccurrence, Handler<EventOccurrence>) - Method in interface es.situm.sdk.communication.CommunicationManager
eventConverted(EventOccurrence, Map<String, Object>, Handler<EventOccurrence>) - Method in interface es.situm.sdk.communication.CommunicationManager
EventOccurrence - Class in es.situm.sdk.model.geofencing
An event occurrence
EventOccurrence() - Constructor for class es.situm.sdk.model.geofencing.EventOccurrence
 
EventOccurrence(int, int, long) - Constructor for class es.situm.sdk.model.geofencing.EventOccurrence
 
EventOccurrence(int, long) - Constructor for class es.situm.sdk.model.geofencing.EventOccurrence
 
events(Collection<SitumEvent>) - Method in class es.situm.sdk.model.cartography.BuildingInfo.Builder
 
eventSeen(SitumEvent, Handler<EventOccurrence>) - Method in interface es.situm.sdk.communication.CommunicationManager
eventSeen(SitumEvent, Map<String, Object>, Handler<EventOccurrence>) - Method in interface es.situm.sdk.communication.CommunicationManager
excluding(Circle) - Method in class es.situm.sdk.directions.DirectionsRequest.Builder
Add an area that will be excluded from the calculated route.
execute(Context, HttpRequest) - Method in class es.situm.sdk.communication.HttpRequestExecutor
 
ExternalLocation - Class in es.situm.sdk.location
 
ExternalLocation.Builder - Class in es.situm.sdk.location
 
EXTRA_NETWORK_ERROR - Static variable in interface es.situm.sdk.location.LocationManager.PropertyKey
 

F

FAILED - es.situm.sdk.model.calibration.RemoteCalibration.State
 
FAST - es.situm.sdk.location.LocationRequest.RealtimeUpdateInterval
Computed geolocations will be accumulated and sent to Situm Platform every 5 seconds.
fetchAllPOIsFromUser(CommunicationConfig, Handler<Collection<Poi>>) - Method in interface es.situm.sdk.communication.CommunicationManager
Download the POIs from all the buildings of the user
fetchAllPOIsFromUser(Handler<Collection<Poi>>) - Method in interface es.situm.sdk.communication.CommunicationManager
Download the POIs from all the buildings of the user
fetchBuildingInfo(Building, Handler<BuildingInfo>) - Method in interface es.situm.sdk.communication.CommunicationManager
fetchBuildingInfo(Building, Map<String, Object>, Handler<BuildingInfo>) - Method in interface es.situm.sdk.communication.CommunicationManager
fetchBuildingInfo(String, CommunicationConfig, Handler<BuildingInfo>) - Method in interface es.situm.sdk.communication.CommunicationManager
Download all the building data from the selected building.
fetchBuildingInfo(String, Handler<BuildingInfo>) - Method in interface es.situm.sdk.communication.CommunicationManager
Download all the building data for the selected building.
fetchBuildings(CommunicationConfig, Handler<Collection<Building>>) - Method in interface es.situm.sdk.communication.CommunicationManager
Download all the buildings for the current user
fetchBuildings(Handler<Collection<Building>>) - Method in interface es.situm.sdk.communication.CommunicationManager
Download all the buildings for the current user
fetchBuildings(Map<String, Object>, Handler<Collection<Building>>) - Method in interface es.situm.sdk.communication.CommunicationManager
fetchCalibratedArea(Building, Floor, Handler<Collection<CalibrationArea>>) - Method in interface es.situm.sdk.communication.CommunicationManager
Deprecated.
Use CalibrationManager.fetchActiveGtScans(Floor, Handler)
fetchCalibrationBleScans(Building, Floor, Handler<Scans>) - Method in interface es.situm.sdk.communication.CommunicationManager
Deprecated.
Use CalibrationManager.fetchActiveBleScans(Floor, Handler)
fetchCalibrationWifiScans(Building, Floor, Handler<Scans>) - Method in interface es.situm.sdk.communication.CommunicationManager
Deprecated.
Use CalibrationManager.fetchActiveWifiScans(Floor, Handler)
fetchEventsFromBuilding(Building, Handler<Collection<SitumEvent>>) - Method in interface es.situm.sdk.communication.CommunicationManager
fetchEventsFromBuilding(Building, Map<String, Object>, Handler<Collection<SitumEvent>>) - Method in interface es.situm.sdk.communication.CommunicationManager
fetchEventsFromBuilding(String, CommunicationConfig, Handler<Collection<SitumEvent>>) - Method in interface es.situm.sdk.communication.CommunicationManager
Download the events of a building
fetchEventsFromBuilding(String, Handler<Collection<SitumEvent>>) - Method in interface es.situm.sdk.communication.CommunicationManager
Download the events of a building
fetchFloorsFromBuilding(Building, Handler<Collection<Floor>>) - Method in interface es.situm.sdk.communication.CommunicationManager
fetchFloorsFromBuilding(Building, Map<String, Object>, Handler<Collection<Floor>>) - Method in interface es.situm.sdk.communication.CommunicationManager
fetchFloorsFromBuilding(String, CommunicationConfig, Handler<Collection<Floor>>) - Method in interface es.situm.sdk.communication.CommunicationManager
Download all the floors of a building
fetchFloorsFromBuilding(String, Handler<Collection<Floor>>) - Method in interface es.situm.sdk.communication.CommunicationManager
Download all the floors of a building
fetchGeofencesFromBuilding(Building, CommunicationConfig, Handler<List<Geofence>>) - Method in interface es.situm.sdk.communication.CommunicationManager
Get the geofences of a building
fetchGeofencesFromBuilding(Building, Handler<List<Geofence>>) - Method in interface es.situm.sdk.communication.CommunicationManager
Get the geofences of a building
fetchGeofencesFromBuilding(Building, Map<String, Object>, Handler<List<Geofence>>) - Method in interface es.situm.sdk.communication.CommunicationManager
fetchIndoorPOIsFromBuilding(Building, Handler<Collection<Poi>>) - Method in interface es.situm.sdk.communication.CommunicationManager
fetchIndoorPOIsFromBuilding(Building, Map<String, Object>, Handler<Collection<Poi>>) - Method in interface es.situm.sdk.communication.CommunicationManager
fetchIndoorPOIsFromBuilding(String, CommunicationConfig, Handler<Collection<Poi>>) - Method in interface es.situm.sdk.communication.CommunicationManager
Download the indoor POIs of a building
fetchIndoorPOIsFromBuilding(String, Handler<Collection<Poi>>) - Method in interface es.situm.sdk.communication.CommunicationManager
Download the indoor POIs of a building
fetchMapFromFloor(Floor, CommunicationConfig, Handler<Bitmap>) - Method in interface es.situm.sdk.communication.CommunicationManager
Download the map image of a floor
fetchMapFromFloor(Floor, Handler<Bitmap>) - Method in interface es.situm.sdk.communication.CommunicationManager
Download the map image of a floor
fetchMapFromFloor(Floor, Map<String, Object>, Handler<Bitmap>) - Method in interface es.situm.sdk.communication.CommunicationManager
fetchOrganizationTheme(Handler<OrganizationTheme>) - Method in interface es.situm.sdk.communication.CommunicationManager
Get organization theme: company name, logo and colors
fetchOutdoorPOIsFromBuilding(Building, Handler<Collection<Poi>>) - Method in interface es.situm.sdk.communication.CommunicationManager
fetchOutdoorPOIsFromBuilding(Building, Map<String, Object>, Handler<Collection<Poi>>) - Method in interface es.situm.sdk.communication.CommunicationManager
fetchOutdoorPOIsFromBuilding(String, CommunicationConfig, Handler<Collection<Poi>>) - Method in interface es.situm.sdk.communication.CommunicationManager
Download the outdoor POIs of a building
fetchOutdoorPOIsFromBuilding(String, Handler<Collection<Poi>>) - Method in interface es.situm.sdk.communication.CommunicationManager
Download the outdoor POIs of a building
fetchPoiCategories(CommunicationConfig, Handler<Collection<PoiCategory>>) - Method in interface es.situm.sdk.communication.CommunicationManager
Get all POI categories, download and cache their icons asynchronously.
fetchPoiCategories(Handler<Collection<PoiCategory>>) - Method in interface es.situm.sdk.communication.CommunicationManager
Get all POI categories, download and cache their icons asynchronously
fetchPoiCategories(Map<String, Object>, Handler<Collection<PoiCategory>>) - Method in interface es.situm.sdk.communication.CommunicationManager
fetchPoiCategoryIcon(PoiCategory, boolean, CommunicationConfig, Handler<Bitmap>) - Method in interface es.situm.sdk.communication.CommunicationManager
Get the normal category icon for a category
fetchPoiCategoryIcon(PoiCategory, boolean, Handler<Bitmap>) - Method in interface es.situm.sdk.communication.CommunicationManager
Get the normal category icon for a category
fetchPoiCategoryIconNormal(PoiCategory, Handler<Bitmap>) - Method in interface es.situm.sdk.communication.CommunicationManager
fetchPoiCategoryIconNormal(PoiCategory, Map<String, Object>, Handler<Bitmap>) - Method in interface es.situm.sdk.communication.CommunicationManager
fetchPoiCategoryIconSelected(PoiCategory, Handler<Bitmap>) - Method in interface es.situm.sdk.communication.CommunicationManager
fetchPoiCategoryIconSelected(PoiCategory, Map<String, Object>, Handler<Bitmap>) - Method in interface es.situm.sdk.communication.CommunicationManager
fetchRailWidth(Building, Handler<Float>) - Method in interface es.situm.sdk.communication.CommunicationManager
fetchRailWidth(String, Handler<Float>) - Method in interface es.situm.sdk.communication.CommunicationManager
Get the calibrations rail width used in a building
fetchRemoteConfig(LocationRequest, Handler<RemoteConfig>) - Method in interface es.situm.sdk.communication.CommunicationManager
Get the RemoteConfig for the current user.
fetchRemoteConfig(Handler<RemoteConfig>) - Method in interface es.situm.sdk.communication.CommunicationManager
Get the RemoteConfig for the current user.
FILE_NOT_FOUND - Static variable in interface es.situm.sdk.communication.CommunicationManager.Code
File not found
FILE_NOT_SAVED - Static variable in interface es.situm.sdk.communication.CommunicationManager.Code
Server returned data correctly, but something went wrong while saving it on disk.
filter(Collection<T>) - Method in class es.situm.sdk.utils.filter.Filter
Deprecated.
Filter the passed list of items using the stored filters.
Filter - Class in es.situm.sdk.utils.filter
Deprecated.
Use a for with an if to filter the collection
Filter(Filter.FilterMode, Collection<Filter.KeyValueFilter>) - Constructor for class es.situm.sdk.utils.filter.Filter
Deprecated.
 
Filter.FilterMode - Enum in es.situm.sdk.utils.filter
Deprecated.
Use a for with an if to filter the collection
Filter.KeyValueFilter - Class in es.situm.sdk.utils.filter
Deprecated.
Use a for with an if to filter the collection
Filter.KeyValueFilter.FilterBy - Enum in es.situm.sdk.utils.filter
Deprecated.
Field to filter
Filterable - Interface in es.situm.sdk.utils.filter
Deprecated.
Use a for with an if to filter the collection
floor(int) - Method in class es.situm.sdk.model.cartography.Floor.Builder
 
Floor - Class in es.situm.sdk.model.cartography
Floor of a building.
Floor.Builder - Class in es.situm.sdk.model.cartography
Builder to create a Floor instance
floorIdentifier(String) - Method in class es.situm.sdk.model.calibration.RemoteCalibration.Builder
 
floorIdentifier(String) - Method in class es.situm.sdk.model.cartography.Geofence.Builder
 
FloorResource - Interface in es.situm.sdk.model
A floor resource with building identifier and floor identifier
floors(Collection<Floor>) - Method in class es.situm.sdk.model.cartography.BuildingInfo.Builder
 
FORCE_DOWNLOAD - Static variable in annotation type es.situm.sdk.communication.CommunicationOptions
Deprecated.
Force download from server, the cache won't be used.
foregroundServiceNotification(Notification) - Method in class es.situm.sdk.location.LocationRequest.Builder
Sets the Notification that will be shown in the system's tray when the app is running as a Foreground Service.
from(Point) - Method in class es.situm.sdk.model.directions.RouteStep.Builder
 
from(Point, Angle) - Method in class es.situm.sdk.directions.DirectionsRequest.Builder
Sets the starting point of the route, and the bearing of the user to generate the appropriate instructions.
from(Location) - Method in class es.situm.sdk.directions.DirectionsRequest.Builder
Sets the current user's position as the starting point of the route.
fromDegrees(double) - Static method in class es.situm.sdk.model.location.Angle
 
fromRadians(double) - Static method in class es.situm.sdk.model.location.Angle
 

G

Geofence - Class in es.situm.sdk.model.cartography
Represents a geographic region in a building.
Geofence.Builder - Class in es.situm.sdk.model.cartography
 
geofences(Collection<Geofence>) - Method in class es.situm.sdk.model.cartography.BuildingInfo.Builder
 
get(String) - Method in class es.situm.sdk.model.I18nString
Obtains the string in the provided language.
get(Locale) - Method in class es.situm.sdk.model.I18nString
Obtains the string in the provided Locale's language Wraps I18nString.get(String), using Locale.getISO3Language() to take language code.
GET - Static variable in annotation type es.situm.sdk.communication.HttpMethod
 
getAbsoluteUrl() - Method in class es.situm.sdk.communication.HttpRequest
 
getAccessibilityMode() - Method in class es.situm.sdk.directions.DirectionsRequest
Returns the DirectionsRequest.AccessibilityMode of the route
getAccessibilityMode() - Method in class es.situm.sdk.model.directions.Route
Returns the current route accessibility mode.
getAccuracy() - Method in class es.situm.sdk.model.location.Location
Return the accuracy radius (in meters)
getAction() - Method in class es.situm.sdk.directions.DirectionsModifier
Returns the action option that will be applied with this modifier.
getAddress() - Method in class es.situm.sdk.model.cartography.Building
Returns the building address.
getAltitude() - Method in class es.situm.sdk.model.cartography.Floor
Returns altitude of the floor above ground level, in meters
getAverageSnrThreshold() - Method in class es.situm.sdk.location.OutdoorLocationOptions
Deprecated.
This feaure is not supported from Android 12 onward, and will be removed in future SDK versions.
getBeaconFilters() - Method in class es.situm.sdk.location.LocationRequest
Gets the list of beacon UUIDs that will be taken into account when using BLE signals for positioning.
getBearing() - Method in class es.situm.sdk.model.location.Location
Return the bearing (in degrees) with respect to the Earth North.
getBearingFrom() - Method in class es.situm.sdk.directions.DirectionsRequest
Returns the user's bearing in the starting point.
getBearingQuality() - Method in class es.situm.sdk.model.location.Location
Return the quality of the cartesian bearing.
getBle() - Method in class es.situm.sdk.model.calibration.CalibrationScans
 
getBody() - Method in class es.situm.sdk.communication.HttpRequest
 
getBottomLeft() - Method in class es.situm.sdk.v1.SitumConversionArea
Deprecated.
 
getBottomRight() - Method in class es.situm.sdk.v1.SitumConversionArea
Deprecated.
 
getBounds() - Method in class es.situm.sdk.model.cartography.Building
Compute corners of this building, without rotation, in earth coordinates.
getBoundsRotated() - Method in class es.situm.sdk.model.cartography.Building
Compute corners of this building, with rotation, in earth coordinates.
getBuilding() - Method in class es.situm.sdk.model.cartography.BuildingInfo
Returns the building, without dependencies.
getBuilding() - Method in class es.situm.sdk.realtime.RealTimeRequest
 
getBuildingDetector() - Method in class es.situm.sdk.location.OutdoorLocationOptions
getBuildingId() - Method in class es.situm.sdk.location.ExternalLocation
 
getBuildingId() - Method in class es.situm.sdk.v1.SitumEvent
Deprecated.
getBuildingIdentifier() - Method in class es.situm.sdk.location.LocationParametersUpdate
 
getBuildingIdentifier() - Method in class es.situm.sdk.location.LocationRequest
(Building Mode) Gets the identifier of the building where Situm SDK should perform positioning .
getBuildingIdentifier() - Method in interface es.situm.sdk.model.BuildingResource
Return the building identifier of the resource
getBuildingIdentifier() - Method in class es.situm.sdk.model.calibration.LocalCalibration
 
getBuildingIdentifier() - Method in class es.situm.sdk.model.calibration.RemoteCalibration
 
getBuildingIdentifier() - Method in class es.situm.sdk.model.cartography.CalibrationArea
Returhn the calibration building identifier
getBuildingIdentifier() - Method in class es.situm.sdk.model.cartography.Floor
Returns the identifier of building which this floor belongs.
getBuildingIdentifier() - Method in class es.situm.sdk.model.cartography.Geofence
Returns the building identifier to which the geofence belongs
getBuildingIdentifier() - Method in class es.situm.sdk.model.cartography.Poi
Returns identifier of building to which the POI belongs.
getBuildingIdentifier() - Method in class es.situm.sdk.model.cartography.Point
Returns unique identifier for the building to which this point belongs
getBuildingIdentifier() - Method in class es.situm.sdk.model.location.Location
Only used in indoor.
getCacheMaxAge() - Method in class es.situm.sdk.Configuration
Get the maximum age of a cached response.
getCacheStrategy() - Method in interface es.situm.sdk.configuration.network.NetworkOptions
Defines which data source takes priority, server or cache.
getCacheStrategy() - Method in class es.situm.sdk.configuration.network.NetworkOptionsImpl
 
getCalibrationIdentifier() - Method in class es.situm.sdk.model.calibration.CalibrationScans
 
getCalibrationIdentifier() - Method in class es.situm.sdk.model.cartography.CalibrationArea
Return the calibration identifier
getCallback() - Method in class es.situm.sdk.communication.HttpRequest
 
getCartesianBearing() - Method in class es.situm.sdk.model.location.Location
Only used in indoor.
getCartesianCoordinate() - Method in class es.situm.sdk.model.cartography.Poi
Returns cartesian coordinate of this position, relative to building Bounds).
getCartesianCoordinate() - Method in class es.situm.sdk.model.cartography.Point
Returns cartesian coordinate (in meters) relative to the Bounds of building's base.
getCartesianCoordinate() - Method in class es.situm.sdk.model.location.Location
Only used in indoor.
getCategory() - Method in class es.situm.sdk.model.cartography.Poi
Returns category of the POI
getCells() - Method in class es.situm.sdk.model.cartography.calibration.Grid
Return all the cells
getCellSize() - Method in class es.situm.sdk.model.cartography.calibration.Grid
Return the cell size (in square meters)
getCenter() - Method in class es.situm.sdk.model.cartography.Building
Return center of the building's base, as geographical coordinate.
getCenter() - Method in class es.situm.sdk.model.cartography.Circle
The center of the circle
getClosestLocationInRoute() - Method in class es.situm.sdk.model.navigation.NavigationProgress
Returns the closest location in the route from the user location provided to NavigationManager.updateWithLocation(Location).
getClosestPointInRoute() - Method in class es.situm.sdk.model.navigation.NavigationProgress
getCode() - Method in interface es.situm.sdk.error.Error
Return the error code.
getCode() - Method in class es.situm.sdk.model.cartography.Geofence
Returns the code of the geofence
getCode() - Method in class es.situm.sdk.model.cartography.PoiCategory
Returns unique code of the category
getComputeInterval() - Method in class es.situm.sdk.location.OutdoorLocationOptions
Gets the interval (in milliseconds) set in OutdoorLocationOptions.Builder.computeInterval(int).
getContentType() - Method in class es.situm.sdk.communication.HttpRequest
 
getConversion() - Method in class es.situm.sdk.v1.SitumEvent
Returns the conversion area of the event.
getConversionArea() - Method in class es.situm.sdk.v1.SitumEvent
Deprecated.
getCoordinate() - Method in class es.situm.sdk.model.cartography.Poi
Return geographical coordinate of this position
getCoordinate() - Method in class es.situm.sdk.model.cartography.Point
Returns geographic coordinate (latitude, longitude) of the point, regardless of whether it's placed inside or outside the building You can obtain this value from CartesianCoordinate using CoordinateConverter.
getCoordinate() - Method in class es.situm.sdk.model.location.Location
Return the coordinate of the location
getCreatedAt() - Method in class es.situm.sdk.model.Resource
Returns a date containing the time when a resource was first created.
getCurrentIndication() - Method in class es.situm.sdk.model.navigation.NavigationProgress
Returns the current indication
getCustomFields() - Method in class es.situm.sdk.model.location.Location
Returns map of custom fields, indexed by their name.
getCustomFields() - Method in class es.situm.sdk.model.Resource
Returns map of custom fields, indexed by their name.
getCustomFields() - Method in interface es.situm.sdk.utils.filter.Filterable
Deprecated.
Obtain a map with the custom fields of this instance.
getCustomFields() - Method in class es.situm.sdk.v1.SitumEvent
Obtain a map with the custom fields for the current event.
getCustomHeaders() - Method in class es.situm.sdk.communication.HttpRequest
 
getDanger() - Method in class es.situm.sdk.model.organization.ThemeColors
 
getDashboardURL() - Method in class es.situm.sdk.Configuration
Obtains the currently Dashboard url used
getDefault() - Method in class es.situm.sdk.model.organization.ThemeColors
 
getDescription() - Method in class es.situm.sdk.model.cartography.Geofence
Deprecated.
this method is replaced by @link #getInfoHtml()
getDeviceId() - Method in class es.situm.sdk.model.location.Location
Returns the device identifier that has generated the location
getDeviceID() - Static method in class es.situm.sdk.SitumSdk
Return the device ID used internally in the SDK
getDevicesToFollow() - Method in class es.situm.sdk.location.LocationParametersUpdate
Retrieve the list of devices location engined should follow.
getDimensions() - Method in class es.situm.sdk.model.cartography.Building
Returns dimensions of building's base (height and width) in meters.
getDistance() - Method in class es.situm.sdk.model.directions.Indication
Retrieve the distance between the origin and destination
getDistance() - Method in class es.situm.sdk.model.directions.Route
Returns the route distance (in meters)
getDistance() - Method in class es.situm.sdk.model.directions.RouteStep
Returns distance between RouteStep.getFrom() and RouteStep.getTo() in meters.
getDistanceToChangeFloorThreshold() - Method in class es.situm.sdk.navigation.NavigationRequest
 
getDistanceToChangeIndicationThreshold() - Method in class es.situm.sdk.navigation.NavigationRequest
 
getDistanceToClosestPointInRoute() - Method in class es.situm.sdk.model.navigation.NavigationProgress
Returns the distance between the real user location (provided to NavigationManager.updateWithLocation(Location)) and the closest route location (NavigationProgress.getClosestLocationInRoute()).
getDistanceToEndStep() - Method in class es.situm.sdk.model.navigation.NavigationProgress
Returns the distance to the end this step
getDistanceToFloorChange() - Method in class es.situm.sdk.model.directions.RouteStep
Returns distance in meters between the start point of this step (RouteStep.getFrom()) and the first point in the route (RouteStep.getFrom()) of the next step which requires a floor change.
getDistanceToGoal() - Method in class es.situm.sdk.model.directions.RouteStep
Returns distance in meters between the start point of this step (RouteStep.getFrom()) and the last point in the route (RouteStep.getTo() of the last step).
getDistanceToGoal() - Method in class es.situm.sdk.model.navigation.NavigationProgress
Returns the distance from NavigationProgress.getClosestLocationInRoute() to route's goal point.
getDistanceToGoalThreshold() - Method in class es.situm.sdk.navigation.NavigationRequest
 
getDistanceToIgnoreFirstIndication() - Method in class es.situm.sdk.navigation.NavigationRequest
 
getDistanceToNextLevel() - Method in class es.situm.sdk.model.directions.Indication
Retrieve the number of levels between the origin and destination
getDomain() - Method in interface es.situm.sdk.error.Error
The error domain
getEdges() - Method in class es.situm.sdk.model.directions.Route
getEventId() - Method in class es.situm.sdk.model.geofencing.EventOccurrence
 
getEvents() - Method in class es.situm.sdk.model.cartography.BuildingInfo
Returns registered events in the building.
getExclusions() - Method in class es.situm.sdk.directions.DirectionsRequest
Returns the list of elements used to exclude areas from the route.
getExtras() - Method in interface es.situm.sdk.error.Error
Optional extras given more information about the error
getFile() - Method in class es.situm.sdk.model.calibration.LocalCalibration
 
getFilename() - Method in class es.situm.sdk.model.calibration.LocalCalibration
Get the filename where it's saved
getFilterMode() - Method in class es.situm.sdk.utils.filter.Filter
Deprecated.
 
getFirstStep() - Method in class es.situm.sdk.model.directions.Route
Returns first step
getFloor() - Method in class es.situm.sdk.model.cartography.Floor
Retrieves the number of the floor
getFloor_id() - Method in class es.situm.sdk.v1.SitumConversionArea
Deprecated.
 
getFloor_id() - Method in class es.situm.sdk.v1.SitumEvent
Deprecated.
getFloorId() - Method in class es.situm.sdk.location.ExternalLocation
 
getFloorId() - Method in class es.situm.sdk.model.calibration.LocalCalibration
 
getFloorIdentifier() - Method in class es.situm.sdk.model.calibration.RemoteCalibration
 
getFloorIdentifier() - Method in class es.situm.sdk.model.cartography.CalibrationArea
Return the calibration floor identifier
getFloorIdentifier() - Method in class es.situm.sdk.model.cartography.Geofence
Returns the floor identifier of the floor where it is placed
getFloorIdentifier() - Method in class es.situm.sdk.model.cartography.Poi
If this POI is outside the building (Poi.isOutdoor() == true), this field has no meaning.
getFloorIdentifier() - Method in class es.situm.sdk.model.cartography.Point
Returns floor identifier (inside the building) where this point is placed.
getFloorIdentifier() - Method in class es.situm.sdk.model.directions.RouteSegment
Return the floor of the segment
getFloorIdentifier() - Method in interface es.situm.sdk.model.FloorResource
Return the floor identifier of the resource
getFloorIdentifier() - Method in class es.situm.sdk.model.location.Location
Only used in indoor.
getFloors() - Method in class es.situm.sdk.model.cartography.BuildingInfo
Returns existent floors in the building.
getForegroundServiceNotification() - Method in class es.situm.sdk.location.LocationRequest
Returns the Notification that will be shown in the system's tray when the app is running as a Foreground Service.
getFrom() - Method in class es.situm.sdk.directions.DirectionsRequest
Returns the point where the route should start.
getFrom() - Method in class es.situm.sdk.model.directions.Route
Point where the route starts.
getFrom() - Method in class es.situm.sdk.model.directions.RouteStep
Start point of this step.
getGeofences() - Method in class es.situm.sdk.model.cartography.BuildingInfo
Returns the building's geofences
getGrid() - Method in class es.situm.sdk.model.cartography.calibration.Scans
 
getGt() - Method in class es.situm.sdk.model.calibration.CalibrationScans
 
getHeight() - Method in class es.situm.sdk.model.cartography.calibration.Grid
Return the height (in meters)
getHeight() - Method in class es.situm.sdk.model.location.Dimensions
Returns height of rectangle in meters.
getHtml() - Method in class es.situm.sdk.v1.SitumEvent
 
getHttpRequestExecutor() - Method in interface es.situm.sdk.communication.CommunicationManager
Return the HTTP Request Executor to make custom requests to the Dashboard
getId() - Method in class es.situm.sdk.model.directions.RouteStep
Position of this RouteStep in the list of steps (Route.getSteps()) of the route to which it belongs.
getId() - Method in class es.situm.sdk.model.geofencing.EventOccurrence
 
getId() - Method in class es.situm.sdk.v1.SitumEvent
 
getIdentifier() - Method in class es.situm.sdk.location.LocationParametersUpdate
 
getIdentifier() - Method in class es.situm.sdk.model.Resource
Returns the unique identifier of the resource
getIndications() - Method in class es.situm.sdk.model.directions.Route
Return ordered list of instructions to go to the destination
getIndicationsInterval() - Method in class es.situm.sdk.navigation.NavigationRequest
 
getIndicationType() - Method in class es.situm.sdk.model.directions.Indication
Retrieve the Indication.Action of the instruction
getIndoorPOIs() - Method in class es.situm.sdk.model.cartography.BuildingInfo
Returns points of interest inside the building.
getIndoorProvider() - Method in class es.situm.sdk.location.LocationRequest
Deprecated.
Indoor provider is LocationRequest.IndoorProvider.INPHONE by default and can not be changed.
getInfo() - Method in class es.situm.sdk.model.organization.ThemeColors
 
getInfoHtml() - Method in class es.situm.sdk.model.cartography.Building
Returns additional information about the building, formatted with HTML.
getInfoHtml() - Method in class es.situm.sdk.model.cartography.Geofence.Builder
 
getInfoHtml() - Method in class es.situm.sdk.model.cartography.Geofence
Returns the information of the geofence
getInfoHtml() - Method in class es.situm.sdk.model.cartography.Poi
Returns additional information about POI, in HTML.
getInterval() - Method in class es.situm.sdk.location.LocationRequest
Gets the minimum time interval (in milliseconds) allowed between consecutive Indoor Positions communicated via LocationListener.onLocationChanged(Location) callback.
getInterval() - Method in enum es.situm.sdk.location.LocationRequest.RealtimeUpdateInterval
Gets the time interval (in milliseconds) between consecutive indoor geolocations communicated via LocationListener.onLocationChanged(Location) callback.
getKeyValueFilters() - Method in class es.situm.sdk.utils.filter.Filter
Deprecated.
 
getLastStep() - Method in class es.situm.sdk.model.directions.Route
Returns last step
getLastTerm() - Method in class es.situm.sdk.model.URL
Returns las part of provided value, separated by '/'.
getLatitude() - Method in class es.situm.sdk.model.location.Coordinate
Returns latitude in degrees
getLatLng() - Method in class es.situm.sdk.location.ExternalLocation
 
getLevel() - Method in class es.situm.sdk.model.cartography.Floor
Deprecated.
use Floor.getFloor() instead
getLocationRequest() - Method in class es.situm.sdk.model.configuration.RemoteConfig
 
getLocations() - Method in class es.situm.sdk.model.realtime.RealTimeData
Returns the device locations
getLogo() - Method in class es.situm.sdk.model.organization.OrganizationTheme
 
getLongitude() - Method in class es.situm.sdk.model.location.Coordinate
Returns longitude in degrees
getMapUrl() - Method in class es.situm.sdk.model.cartography.Floor
Return the floor map image url
getMaxValue() - Method in class es.situm.sdk.model.cartography.calibration.Grid
Return the max value of the cells of the grid
getMessage() - Method in interface es.situm.sdk.error.Error
The detailed error message
getMethod() - Method in class es.situm.sdk.communication.HttpRequest
 
getMinimumOutdoorLocationAccuracy() - Method in class es.situm.sdk.location.OutdoorLocationOptions
getModifier() - Method in class es.situm.sdk.model.directions.Restriction
 
getModifiers() - Method in class es.situm.sdk.directions.DirectionsOptions
Returns the list of DirectionsModifier object included on the options
getMotionMode() - Method in class es.situm.sdk.location.LocationRequest
Gets the LocationRequest.MotionMode, which specifies how the user moves (e.g.
getName() - Method in class es.situm.sdk.model.calibration.RemoteCalibration
 
getName() - Method in class es.situm.sdk.model.cartography.Building
Returns the building name that is appropriate for display to the user.
getName() - Method in class es.situm.sdk.model.cartography.CalibrationArea
Return the calibration name
getName() - Method in class es.situm.sdk.model.cartography.Floor
Return the name of the floor limited to 5 characters.
getName() - Method in class es.situm.sdk.model.cartography.Geofence
Returns the name of the geofence
getName() - Method in class es.situm.sdk.model.cartography.Poi
Returns a name for the POI, appropriate for display to the user.
getName() - Method in class es.situm.sdk.model.cartography.PoiCategory
Returns the category name appropriate for display to the user
getName() - Method in class es.situm.sdk.v1.SitumEvent
 
getNameAsI18n() - Method in class es.situm.sdk.model.cartography.PoiCategory
Returns the category name appropriate for display to the user with different value depending on the language
getNetworkOptions() - Method in interface es.situm.sdk.communication.CommunicationConfig
 
getNetworkOptions() - Method in class es.situm.sdk.communication.CommunicationConfigImpl
 
getNextIndication() - Method in class es.situm.sdk.model.navigation.NavigationProgress
Returns the next indication.
getNextLevel() - Method in class es.situm.sdk.model.directions.Indication
Retrieves the next level
getNodes() - Method in class es.situm.sdk.model.directions.Route
Returns a collection of points of the route (not ordered)
getNorthEast() - Method in class es.situm.sdk.model.location.Bounds
Returns the coordinate of the north-east corner of the bound.
getNorthWest() - Method in class es.situm.sdk.model.location.Bounds
Returns the coordinate of the north-west corner of the bound.
getOptions() - Method in class es.situm.sdk.directions.DirectionsRequest
Returns object that contains different parameters related to how a route is computed.
getOrganizationName() - Method in class es.situm.sdk.model.organization.OrganizationTheme
 
getOrganizationUuid() - Method in class es.situm.sdk.model.organization.OrganizationTheme
 
getOrientation() - Method in class es.situm.sdk.model.directions.Indication
Retrieve the angle a user should change his direction in order to go from the origin to the destination.
getOrientationType() - Method in class es.situm.sdk.model.directions.Indication
Retrieve the Indication.Orientation of the instruction
getOutdoorLocationOptions() - Method in class es.situm.sdk.location.LocationRequest
Gets the OutdoorLocationOptions, which specify parameters related to the Global Mode (e.g.
getOutdoorPOIs() - Method in class es.situm.sdk.model.cartography.BuildingInfo
Returns points of interest outside the building
getOutsideRouteThreshold() - Method in class es.situm.sdk.navigation.NavigationRequest
 
getPhoneId() - Method in class es.situm.sdk.model.geofencing.EventOccurrence
 
getPictureThumbUrl() - Method in class es.situm.sdk.model.cartography.Building
Return the url of the thumbnail building image
getPictureUrl() - Method in class es.situm.sdk.model.cartography.Building
Return the url of the building image
getPitch() - Method in class es.situm.sdk.model.location.Location
Only used in indoor.
getPoints() - Method in class es.situm.sdk.model.cartography.calibration.Scans
 
getPoints() - Method in class es.situm.sdk.model.cartography.CalibrationArea
Return the calibration ground truth points
getPoints() - Method in class es.situm.sdk.model.directions.Route
Returns list of ordered points of the route.
getPoints() - Method in class es.situm.sdk.model.directions.RouteSegment
Return the points of the segment
getPoints() - Method in class es.situm.sdk.model.navigation.NavigationProgress
Returns remaining list of ordered points of the route.
getPollTime() - Method in class es.situm.sdk.realtime.RealTimeRequest
 
getPolygonPoints() - Method in class es.situm.sdk.model.cartography.Geofence
Returns a list of points of the closed polygon that represents the geofence
getPosition() - Method in class es.situm.sdk.model.cartography.Poi
 
getPosition() - Method in class es.situm.sdk.model.location.Location
Return the position of the location.
getPreloadImages() - Method in interface es.situm.sdk.configuration.network.NetworkOptions
Specifies whether images should be preloaded if possible.
getPreloadImages() - Method in class es.situm.sdk.configuration.network.NetworkOptionsImpl
 
getPrimary() - Method in class es.situm.sdk.model.organization.ThemeColors
 
getProvider() - Method in class es.situm.sdk.model.location.Location
 
getQuality() - Method in class es.situm.sdk.model.location.Location
Only used in indoor.
getRadius() - Method in class es.situm.sdk.model.cartography.Circle
The radius of the circle (in meters)
getRadius() - Method in class es.situm.sdk.v1.SitumEvent
Deprecated.
getRealtimeUpdateInterval() - Method in class es.situm.sdk.location.LocationRequest
Gets the LocationRequest.RealtimeUpdateInterval, which specifies the interval between consecutive geolocations uploaded to Situm Platform (or whether they should be uploaded at all).
getRequest() - Method in class es.situm.sdk.model.directions.Route
Returns the search criteria, provided to DirectionsManager, whose result is the current Route.
getRequestParams() - Method in class es.situm.sdk.communication.HttpRequest
 
getResponseDestinationFile() - Method in class es.situm.sdk.communication.HttpRequest
Deprecated.
getRestrictions() - Method in class es.situm.sdk.model.directions.Route
Returns a list of Restriction instances in case the route does not conform with one or many DirectionsModifier indicated on Directions API DirectionsManager.requestDirections(DirectionsRequest, Handler).
getRoll() - Method in class es.situm.sdk.model.location.Location
Only used in indoor.
getRotation() - Method in class es.situm.sdk.model.cartography.Building
Returns rotation angle of the building's base, relative to the west-east axis, increasing in clockwise, being 0 the west-east axis.
getRotationMatrix() - Method in class es.situm.sdk.model.location.Location
Return the rotation matrix.
getRoundIndicationsStep() - Method in class es.situm.sdk.navigation.NavigationRequest
 
getRoute() - Method in class es.situm.sdk.navigation.NavigationRequest
 
getRouteId() - Method in class es.situm.sdk.location.LocationParametersUpdate
 
getRouteId() - Method in class es.situm.sdk.location.LocationRequest
 
getRouteInfo() - Method in class es.situm.sdk.model.directions.Route
Just for internal SDK use.
getRoutePoints() - Method in class es.situm.sdk.location.LocationParametersUpdate
 
getRoutePoints() - Method in class es.situm.sdk.location.LocationRequest
 
getRouteStep() - Method in class es.situm.sdk.model.navigation.NavigationProgress
Returns the route step/edge/fragment closest to the user, where the NavigationProgress.getClosestLocationInRoute() is.
getRouteStepIndex() - Method in class es.situm.sdk.model.directions.Restriction
 
getScale() - Method in class es.situm.sdk.model.cartography.Floor
Returns the scale of the floor image, in px/meters
getSecondary() - Method in class es.situm.sdk.model.organization.ThemeColors
 
getSegments() - Method in class es.situm.sdk.model.directions.Route
Return list of ordered points split by floor, each list contains points from one floor, but can have multiple lists of the same floor.
getSegments() - Method in class es.situm.sdk.model.navigation.NavigationProgress
Return list of ordered points split by floor, each list contains points from one floor, but can have multiple lists of the same floor.
getSelectedIconUrl() - Method in class es.situm.sdk.model.cartography.PoiCategory
 
getSize() - Method in class es.situm.sdk.model.calibration.LocalCalibration
 
getSmallestDisplacement() - Method in class es.situm.sdk.location.LocationRequest
Gets the smallest smartphone displacement allowed between two consecutive Indoor Positions communicated via LocationListener.onLocationChanged(Location) callback.
getSouthEast() - Method in class es.situm.sdk.model.location.Bounds
Returns the coordinate of the south-east corner of the bound.
getSouthWest() - Method in class es.situm.sdk.model.location.Bounds
Returns the coordinate of the south-east corner of the bound.
getState() - Method in class es.situm.sdk.model.calibration.RemoteCalibration
 
getStep(int) - Method in class es.situm.sdk.model.directions.Route
Returns a route step by its RouteStep.getId()
getStepIdxDestination() - Method in class es.situm.sdk.model.directions.Indication
Retrieve the index of the indication's step of destination.
getStepIdxOrigin() - Method in class es.situm.sdk.model.directions.Indication
Retrieve the index of the indication's step of origin
getSteps() - Method in class es.situm.sdk.model.directions.Route
Returns ordered list of steps to go to the goal point
getSuccess() - Method in class es.situm.sdk.model.organization.ThemeColors
 
getTag() - Method in class es.situm.sdk.directions.TagModifier
Returns the string that describes the modifier
getTags() - Method in class es.situm.sdk.directions.DirectionsModifier
List of elements (tags) that identify the links taking into consideration when applying DirectionsModifier operations.
getTags() - Method in class es.situm.sdk.model.directions.RouteStep
 
getTagsString() - Method in class es.situm.sdk.directions.DirectionsModifier
List of tags as strings
getThemeColors() - Method in class es.situm.sdk.model.organization.OrganizationTheme
 
getTime() - Method in class es.situm.sdk.model.location.Location
Return the timestamp of the location.
getTimestamp() - Method in class es.situm.sdk.model.calibration.LocalCalibration
 
getTimeToEndStep() - Method in class es.situm.sdk.model.navigation.NavigationProgress
Returns the estimated time to go from NavigationProgress.getClosestLocationInRoute() to the end of NavigationProgress.getRouteStep(), considering a speed of 1 meter/second
getTimeToFirstIndication() - Method in class es.situm.sdk.navigation.NavigationRequest
 
getTimeToGoal() - Method in class es.situm.sdk.model.navigation.NavigationProgress
Returns the estimated time to go from NavigationProgress.getClosestLocationInRoute() to the goal/end of route, considering a speed of 1 meter/second
getTimeToIgnoreLocationInWrongFloorDuringFloorChange() - Method in class es.situm.sdk.navigation.NavigationRequest
 
getTo() - Method in class es.situm.sdk.directions.DirectionsRequest
Returns the point where the route should end.
getTo() - Method in class es.situm.sdk.model.directions.Route
Last point and goal of the route.
getTo() - Method in class es.situm.sdk.model.directions.RouteStep
End point of this step.
getTopLeft() - Method in class es.situm.sdk.v1.SitumConversionArea
Deprecated.
 
getTopRight() - Method in class es.situm.sdk.v1.SitumConversionArea
Deprecated.
 
getTrigger() - Method in class es.situm.sdk.v1.SitumEvent
Returns the trigger area of the event
getUnselectedIconUrl() - Method in class es.situm.sdk.model.cartography.PoiCategory
 
getUpdatedAt() - Method in class es.situm.sdk.model.Resource
Returns a date containing the time when a resource was last updated.
getUpdateDevicesToFollow() - Method in class es.situm.sdk.location.LocationParametersUpdate
Retrieve the property that indicates if this parameter should be taken into account (true) or not (false) when applying the update.
getUpdateInterval() - Method in class es.situm.sdk.location.OutdoorLocationOptions
Gets the interval (in milliseconds) set in OutdoorLocationOptions.Builder.updateInterval(int).
getUri() - Method in class es.situm.sdk.model.calibration.RemoteCalibration
 
getUrl() - Method in class es.situm.sdk.communication.HttpRequest
 
getUseExternalLocaltions() - Method in class es.situm.sdk.Configuration
 
getUserIdentifier() - Method in class es.situm.sdk.model.cartography.Building
Returns unique identifier of the owner user of the building
getUuid() - Method in class es.situm.sdk.model.location.BeaconFilter
Get the Beacon UUID
getValue() - Method in enum es.situm.sdk.directions.DirectionsModifier.LEGACY_OPTIONS
 
getValue() - Method in class es.situm.sdk.model.cartography.calibration.IntegerCell
 
getValue() - Method in class es.situm.sdk.model.URL
Original value provided to de constructor
getVersion() - Static method in class es.situm.sdk.SitumSdk
Returns the version of the Situm SDK
getWarning() - Method in class es.situm.sdk.model.organization.ThemeColors
 
getWeight() - Method in class es.situm.sdk.model.directions.RouteStep
 
getWhenClicked() - Method in class es.situm.sdk.model.geofencing.EventOccurrence
 
getWhenConverted() - Method in class es.situm.sdk.model.geofencing.EventOccurrence
 
getWidth() - Method in class es.situm.sdk.model.cartography.calibration.Grid
Return the width (in meters)
getWidth() - Method in class es.situm.sdk.model.location.Dimensions
Returns width of rectangle in meters
getWifi() - Method in class es.situm.sdk.model.calibration.CalibrationScans
 
getX() - Method in class es.situm.sdk.model.cartography.calibration.IntegerCell
 
getX() - Method in class es.situm.sdk.model.location.CartesianCoordinate
Returns value of coordinate at x-axis
getX() - Method in class es.situm.sdk.v1.SitumEvent
Deprecated.
getY() - Method in class es.situm.sdk.model.cartography.calibration.IntegerCell
 
getY() - Method in class es.situm.sdk.model.location.CartesianCoordinate
Returns value of coordinate at y-axis
getY() - Method in class es.situm.sdk.v1.SitumEvent
Deprecated.
GLOBAL_LOCATION_NOT_FOUND - es.situm.sdk.location.LocationStatus
(Global Mode only) Warning: Google Location provider (for example, GPS) has not been able to return locations in the first 30 seconds (Situm SDK will keep trying).
GO_AHEAD - es.situm.sdk.model.directions.Indication.Action
 
GPS_PROXIMITY - es.situm.sdk.location.OutdoorLocationOptions.BuildingDetector
The user will be geolocated in the nearest building (based on the GPS distance) from those within a certain maximum range of 100 meters to the borders of the building canvas (floorplan).
GRAPH_BETWEEN_TWO_POINTS_NOT_FOUND - Static variable in interface es.situm.sdk.directions.DirectionsManager.Code
There is not graph between two points in dashboard
GRAPH_NOT_FOUND - Static variable in interface es.situm.sdk.directions.DirectionsManager.Code
there is no graph in dashboard
Grid - Class in es.situm.sdk.model.cartography.calibration
A Grid formed by cells.
Grid(int, int, int, int, List<IntegerCell>) - Constructor for class es.situm.sdk.model.cartography.calibration.Grid
 
GT - es.situm.sdk.model.calibration.ScansType
 
gtPoints() - Method in class es.situm.sdk.model.calibration.LocalCalibration
 

H

Handler<T> - Interface in es.situm.sdk.utils
Interface to receive result of an async request
has(String) - Method in class es.situm.sdk.model.I18nString
Check if the language is supported by this I18nString
hasBearing() - Method in class es.situm.sdk.model.location.Location
Return true if the location has bearing and the bearing quality is Location.Quality.HIGH, false otherwise.
hasBle() - Method in class es.situm.sdk.model.calibration.CalibrationScans
 
hasCartesianBearing() - Method in class es.situm.sdk.model.location.Location
Only used in indoor.
hasFloorChange() - Method in class es.situm.sdk.model.directions.RouteStep
Returns true if the floor changes in this step.
hasGt() - Method in class es.situm.sdk.model.calibration.CalibrationScans
 
hashCode() - Method in class es.situm.sdk.directions.DirectionsRequest
 
hashCode() - Method in class es.situm.sdk.location.ExternalLocation
 
hashCode() - Method in class es.situm.sdk.location.LocationRequest
 
hashCode() - Method in class es.situm.sdk.location.OutdoorLocationOptions
 
hashCode() - Method in class es.situm.sdk.location.util.CoordinateConverter
 
hashCode() - Method in class es.situm.sdk.model.calibration.LocalCalibration
 
hashCode() - Method in class es.situm.sdk.model.calibration.RemoteCalibration
 
hashCode() - Method in class es.situm.sdk.model.cartography.Building
 
hashCode() - Method in class es.situm.sdk.model.cartography.CalibrationArea
 
hashCode() - Method in class es.situm.sdk.model.cartography.Circle
 
hashCode() - Method in class es.situm.sdk.model.cartography.Floor
 
hashCode() - Method in class es.situm.sdk.model.cartography.Geofence
 
hashCode() - Method in class es.situm.sdk.model.cartography.Poi
 
hashCode() - Method in class es.situm.sdk.model.cartography.PoiCategory
 
hashCode() - Method in class es.situm.sdk.model.cartography.Point
 
hashCode() - Method in class es.situm.sdk.model.directions.Indication
 
hashCode() - Method in class es.situm.sdk.model.directions.Route
 
hashCode() - Method in class es.situm.sdk.model.directions.RouteStep
 
hashCode() - Method in class es.situm.sdk.model.I18nString
 
hashCode() - Method in class es.situm.sdk.model.location.Angle
 
hashCode() - Method in class es.situm.sdk.model.location.BeaconFilter
 
hashCode() - Method in class es.situm.sdk.model.location.Bounds
 
hashCode() - Method in class es.situm.sdk.model.location.CartesianCoordinate
 
hashCode() - Method in class es.situm.sdk.model.location.Coordinate
 
hashCode() - Method in class es.situm.sdk.model.location.Dimensions
 
hashCode() - Method in class es.situm.sdk.model.location.Location
 
hashCode() - Method in class es.situm.sdk.model.navigation.NavigationProgress
 
hashCode() - Method in class es.situm.sdk.model.organization.OrganizationTheme
 
hashCode() - Method in class es.situm.sdk.model.organization.ThemeColors
 
hashCode() - Method in class es.situm.sdk.model.realtime.RealTimeData
 
hashCode() - Method in class es.situm.sdk.model.Resource
 
hashCode() - Method in class es.situm.sdk.model.URL
 
hashCode() - Method in class es.situm.sdk.navigation.NavigationRequest
 
hashCode() - Method in class es.situm.sdk.realtime.RealTimeRequest
 
hasId() - Method in class es.situm.sdk.model.geofencing.EventOccurrence
 
hasPitch() - Method in class es.situm.sdk.model.location.Location
Only used in indoor.
hasRoll() - Method in class es.situm.sdk.model.location.Location
Only used in indoor.
hasRotationMatrix() - Method in class es.situm.sdk.model.location.Location
Return true if the location has a valid rotation matrix, false otherwise.
hasRotationMatrix(Boolean) - Method in class es.situm.sdk.model.location.Location.Builder
 
hasWifi() - Method in class es.situm.sdk.model.calibration.CalibrationScans
 
HIGH - es.situm.sdk.model.location.Location.Quality
The quality of the location/bearing is high
host() - Method in class es.situm.sdk.model.URL
Wrap of URL.asURL() and method URL.getHost()
HTTP_BAD_REQUEST - Static variable in interface es.situm.sdk.communication.CommunicationManager.Code
The request was unacceptable, often due to missing a required parameter.
HTTP_NOT_FOUND - Static variable in interface es.situm.sdk.communication.CommunicationManager.Code
The request resource doesn't exist.
HTTP_REQUEST_FAILED - Static variable in interface es.situm.sdk.communication.CommunicationManager.Code
The parameters were valid but the request failed.
HTTP_SERVER_ERROR - Static variable in interface es.situm.sdk.communication.CommunicationManager.Code
Something went wrong on Situm's end.
HTTP_UNAUTHORIZED - Static variable in interface es.situm.sdk.communication.CommunicationManager.Code
Provided credentials are not valid.
HttpMethod - Annotation Type in es.situm.sdk.communication
The supported HTTP methods used in the custom requests
HttpOption - Annotation Type in es.situm.sdk.communication
The supported HTTP options use in HttpRequest
HttpRequest - Class in es.situm.sdk.communication
Custom HTTP request to use with HttpRequestExecutor.
HttpRequest.Builder - Class in es.situm.sdk.communication
 
HttpRequestExecutor - Class in es.situm.sdk.communication
Class intended just for internal SDK use to make custom HTTP requests to the Dashboard
HttpRequestExecutor(HttpClient) - Constructor for class es.situm.sdk.communication.HttpRequestExecutor
 
HYBRID - es.situm.sdk.location.LocationRequest.IndoorProvider
Deprecated.
INPHONE mode will be used instead

I

I18nString - Class in es.situm.sdk.model
A string with a different value depending of the language.
I18nString(Map<String, String>) - Constructor for class es.situm.sdk.model.I18nString
 
I18nString.Builder - Class in es.situm.sdk.model
Allows creating a I18nString in a handier way.
id(int) - Method in class es.situm.sdk.model.directions.RouteStep.Builder
 
IGNORE_CACHE - es.situm.sdk.configuration.network.NetworkOptions.CacheStrategy
Force download from server, the cache won't be used.
ignoreLowQualityLocations() - Method in class es.situm.sdk.navigation.NavigationRequest
 
ignoreLowQualityLocations(boolean) - Method in class es.situm.sdk.navigation.NavigationRequest.Builder
Set if low quality locations should be ignored.
ignoreWifiThrottling(boolean) - Method in class es.situm.sdk.location.LocationRequest.Builder
(Android 10 only) Sets if you want to ignore (not use) the WiFi Throttling protections implemented by Situm SDK, therefore scanning WiFi as fast as possible.
indication(Indication) - Method in class es.situm.sdk.model.navigation.NavigationProgress.Builder
Sets the currentIndication and returns a reference to this Builder so that the methods can be chained together.
Indication - Class in es.situm.sdk.model.directions
Represents the instruction that a user should follow when on a RouteStep to continue the route
Indication() - Constructor for class es.situm.sdk.model.directions.Indication
 
Indication(int, double, double, int) - Constructor for class es.situm.sdk.model.directions.Indication
Constructs Indication calculating its GuidanceActionType and GuidanceOrientationType
Indication(int, double, double, int, Integer) - Constructor for class es.situm.sdk.model.directions.Indication
Constructs Indication calculating its GuidanceActionType and GuidanceOrientationType
Indication.Action - Enum in es.situm.sdk.model.directions
Defines the main action of the indication
Indication.Builder - Class in es.situm.sdk.model.directions
 
Indication.Orientation - Enum in es.situm.sdk.model.directions
Defines the change in orientation associated the the indication
indicationForNextStep(int) - Method in class es.situm.sdk.model.directions.Route
Returns the next indication to a given step.
indications(List<Indication>) - Method in class es.situm.sdk.model.directions.Route.Builder
 
indicationsInterval(long) - Method in class es.situm.sdk.navigation.NavigationRequest.Builder
Sets the time to wait between indications.
indoorPOIs(Collection<Poi>) - Method in class es.situm.sdk.model.cartography.BuildingInfo.Builder
 
indoorProvider(LocationRequest.IndoorProvider) - Method in class es.situm.sdk.location.LocationRequest.Builder
Deprecated.
Do not use. The indoor provider is LocationRequest.IndoorProvider.INPHONE by default and can not be changed.
infoHtml(String) - Method in class es.situm.sdk.model.cartography.Building.Builder
 
infoHtml(String) - Method in class es.situm.sdk.model.cartography.Geofence.Builder
 
infoHtml(String) - Method in class es.situm.sdk.model.cartography.Poi.Builder
 
init(Context) - Static method in class es.situm.sdk.SitumSdk
Initialize SDK.
INPHONE - es.situm.sdk.location.LocationRequest.IndoorProvider
Deprecated.
Default.
IntegerCell - Class in es.situm.sdk.model.cartography.calibration
A cell of a Grid with the position (x,y) and an integer value
IntegerCell(int, int, int) - Constructor for class es.situm.sdk.model.cartography.calibration.IntegerCell
 
INTERNAL - es.situm.sdk.error.Error.Domain
 
INTERNAL_ERROR - Static variable in interface es.situm.sdk.error.CommonErrorConstant.Code
 
INTERNAL_ERROR - Static variable in interface es.situm.sdk.error.CommonErrorConstant.PropertyKey
 
INTERNET_NOT_AVAILABLE - Static variable in interface es.situm.sdk.error.CommonErrorConstant.Code
No internet connection from the device.
interval(int) - Method in class es.situm.sdk.location.LocationRequest.Builder
Sets the desired interval (in milliseconds) between consecutive Indoor Positions communicated via LocationListener.onLocationChanged(Location) callback.
INVALID_ACTION - es.situm.sdk.model.directions.Indication.Action
 
INVALID_ORIENTATION - es.situm.sdk.model.directions.Indication.Orientation
 
INVALID_REQUEST - Static variable in interface es.situm.sdk.directions.DirectionsManager.Code
Invalid request parameters
INVALID_REQUEST_PARAMETERS - Static variable in interface es.situm.sdk.communication.CommunicationManager.Code
Error while creating request payload.
invalidateCache() - Method in interface es.situm.sdk.communication.CommunicationManager
Invalidate all the resources in the cache
isAbsolute() - Method in class es.situm.sdk.model.URL
Return true if the value used to construct the URL doesn't start by '/', meaning it has a specific host.
isAccessible() - Method in class es.situm.sdk.directions.DirectionsRequest
Deprecated.
isAccessible() - Method in class es.situm.sdk.model.directions.Route
Deprecated.
isAccessible() - Method in class es.situm.sdk.model.directions.RouteStep
 
isAccessible(boolean) - Method in class es.situm.sdk.directions.DirectionsRequest.Builder
Deprecated.
isAllowInvalidSSLCertificate() - Method in class es.situm.sdk.Configuration
Returns true if all SSL certificates are trusted
isChunckableWith(Indication) - Method in class es.situm.sdk.model.directions.Indication
Checks if this Indication can be combined with another one
isClicked() - Method in class es.situm.sdk.model.geofencing.EventOccurrence
 
isColliding() - Method in class es.situm.sdk.model.directions.Collision
 
isConverted() - Method in class es.situm.sdk.model.geofencing.EventOccurrence
 
isFirst() - Method in class es.situm.sdk.model.directions.RouteStep
Returns true if this is the first step in the route.
isIgnoreWifiThrottling() - Method in class es.situm.sdk.location.LocationRequest
Returns true if the WiFi Throttling protections should be ignored (or, in other words, if WiFi should be scanned as fast as possible).
isIndoor() - Method in class es.situm.sdk.model.cartography.Poi
Returns whether the POI is placed outside the building or not.
isIndoor() - Method in class es.situm.sdk.model.cartography.Point
Return if the POI is inside the building.
isIndoor() - Method in class es.situm.sdk.model.location.Location
Return true if the location is indoor
isInitialized() - Static method in class es.situm.sdk.SitumSdk
Return true when the SDK has been initialized calling SitumSdk.init(Context)
isInvalid() - Method in class es.situm.sdk.model.calibration.RemoteCalibration
Return true if the calibration is invalid
isLast() - Method in class es.situm.sdk.model.directions.RouteStep
Returns true if this is the last step in the route.
isLast(boolean) - Method in class es.situm.sdk.model.directions.RouteStep.Builder
 
isLocationDelimitedByRoute() - Method in class es.situm.sdk.location.LocationParametersUpdate
 
isLocationDelimitedByRoute() - Method in class es.situm.sdk.location.LocationRequest
 
isNeededLevelChange() - Method in class es.situm.sdk.model.directions.Indication
Check if the user should change the level in order to arrive to destination
isOutdoor() - Method in class es.situm.sdk.model.cartography.Poi
Returns whether the POI is placed outside the building or not.
isOutdoor() - Method in class es.situm.sdk.model.cartography.Point
Return if the POI is outside the building.
isOutdoor() - Method in class es.situm.sdk.model.location.Location
Return true if the location is outdoor
isOutdoorPositionsEnabled() - Method in class es.situm.sdk.location.OutdoorLocationOptions
isPreloadInfo() - Method in class es.situm.sdk.location.LocationRequest
 
isPublic() - Method in class es.situm.sdk.model.cartography.PoiCategory
Returns whether the category is public or not
isPublic(Boolean) - Method in class es.situm.sdk.model.cartography.PoiCategory.Builder
 
isRelative() - Method in class es.situm.sdk.model.URL
Return true if the value used to construct the URL starts by '/', meaning it has no specific host nor port.
isRunning() - Method in interface es.situm.sdk.location.LocationManager
Returns true if LocationManager.requestLocationUpdates() was called and positioning is running
isRunning() - Method in interface es.situm.sdk.navigation.NavigationManager
Returns true if the navigation is running, false otherwise
isRunning() - Method in interface es.situm.sdk.realtime.RealTimeManager
Check if the realtime is running
isSaved() - Method in class es.situm.sdk.model.calibration.LocalCalibration
 
isScansBasedDetectorAlwaysOn() - Method in class es.situm.sdk.location.OutdoorLocationOptions
isUsed() - Method in class es.situm.sdk.model.calibration.RemoteCalibration
Return true if the calibration is used in the positioning model
isUseRemoteConfig() - Method in class es.situm.sdk.Configuration
 
isUsingSimulatedLocationManager() - Static method in class es.situm.sdk.SitumSdk
Return true if a simulated location manager is set, false otherwise
isValid() - Method in class es.situm.sdk.model.directions.Indication
Check if a particular guidance make sense
isWaiting() - Method in class es.situm.sdk.model.calibration.RemoteCalibration
Return true if the calibration is in any of the waiting states

K

KEY - es.situm.sdk.utils.filter.Filter.KeyValueFilter.FilterBy
Deprecated.
 
KeyValueFilter(Filter.KeyValueFilter.FilterBy, String) - Constructor for class es.situm.sdk.utils.filter.Filter.KeyValueFilter
Deprecated.
Creates a KeyValueFilter passing the field to filter and the regex pattern

L

LEFT - es.situm.sdk.model.directions.Indication.Orientation
 
legacyRequest() - Method in class es.situm.sdk.directions.DirectionsRequest
 
level(int) - Method in class es.situm.sdk.model.cartography.Floor.Builder
Deprecated.
LocalCalibration - Class in es.situm.sdk.model.calibration
Class to represent a calibration
LocalCalibration(File) - Constructor for class es.situm.sdk.model.calibration.LocalCalibration
Constructor for build a new calibration from disk
LocalCalibration(String, String, int, Date) - Constructor for class es.situm.sdk.model.calibration.LocalCalibration
Deprecated.
LocalCalibration(String, String, int, Date, long) - Constructor for class es.situm.sdk.model.calibration.LocalCalibration
 
Location - Class in es.situm.sdk.model.location
A location.
LOCATION - es.situm.sdk.error.Error.Domain
 
LOCATION_DISABLED - es.situm.sdk.location.LocationStatus
(Building Mode only) Warning: the user has disabled the smartphone's location (e.g.
LOCATION_DISABLED - Static variable in interface es.situm.sdk.location.LocationManager.Code
Android's Location must be enabled in the smartphone in order to scan Bluetooth and/or Wi-FI, or to use the GPS.
Location.Builder - Class in es.situm.sdk.model.location
 
Location.Quality - Enum in es.situm.sdk.model.location
The quality of the location/bearing.
locationDelimitedByRoute(boolean) - Method in class es.situm.sdk.location.LocationParametersUpdate.Builder
Boolean value that determines if the location engine have to consider points (true) or not (false) when computing location.
locationDelimitedByRoute(boolean) - Method in class es.situm.sdk.location.LocationRequest.Builder
 
LocationListener - Interface in es.situm.sdk.location
Used for received locations and statuses from the LocationManager.
locationManager() - Static method in class es.situm.sdk.SitumSdk
Returns the location manager.
LocationManager - Interface in es.situm.sdk.location
This class provides Situm Indoor and / or Outdoor positioning.
LocationManager.Code - Interface in es.situm.sdk.location
The error codes that the LocationManager can generate (all errors will be communicated through the LocationListener.onError(Error) callback).
LocationManager.PropertyKey - Interface in es.situm.sdk.location
 
LocationParametersUpdate - Class in es.situm.sdk.location
 
LocationParametersUpdate.Builder - Class in es.situm.sdk.location
 
LocationParametersUpdateListener - Interface in es.situm.sdk.location
 
LocationRequest - Class in es.situm.sdk.location
A data object that allows you to configure the positioning parameters of the LocationManager (e.g.
LocationRequest.Builder - Class in es.situm.sdk.location
Builder constructor that allows to configure all the LocationRequest parameters.
LocationRequest.IndoorProvider - Enum in es.situm.sdk.location
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).
LocationRequest.MotionMode - Enum in es.situm.sdk.location
Allows to indicate how the user that carries the smartphone moves: by foot (default), by car, etc.
LocationRequest.RealtimeUpdateInterval - Enum in es.situm.sdk.location
Enum that allows to specify whether the geolocations computed should be sent to Situm Platform, and if so with which periodicity (time interval).
locations(List<Location>) - Method in class es.situm.sdk.model.realtime.RealTimeData.Builder
 
LocationStatus - Enum in es.situm.sdk.location
Location status values passed via the LocationListener.onStatusChanged(LocationStatus) callback.
logo(URL) - Method in class es.situm.sdk.model.organization.OrganizationTheme.Builder
 
logout(Handler<Object>) - Method in interface es.situm.sdk.communication.CommunicationManager
Invalidate user's token and remove it from internal credentials, if exist.
lookupKey() - Method in class es.situm.sdk.model.cartography.Point
 
lookupKey() - Method in class es.situm.sdk.model.directions.RouteStep
 
LOW - es.situm.sdk.model.location.Location.Quality
The quality of the location/bearing is low

M

MALFORMED_JSON - Static variable in interface es.situm.sdk.communication.CommunicationManager.Code
Server returned a JSON that can't be read.
mapUrl(URL) - Method in class es.situm.sdk.model.cartography.Floor.Builder
 
MAX_SNR - Static variable in class es.situm.sdk.location.OutdoorLocationOptions
(Open Sky Detector only) Default GPS SNR (Signal-To-Noise Ratio) average value (in dBm) that can be passed to method OutdoorLocationOptions.Builder.averageSnrThreshold.
method(String) - Method in class es.situm.sdk.communication.HttpRequest.Builder
Set the HTTP method.
METHOD - Static variable in interface es.situm.sdk.communication.CommunicationManager.PropertyKey
 
MIN_SNR - Static variable in class es.situm.sdk.location.OutdoorLocationOptions
(Open Sky Detector only) Minimum GPS SNR (Signal-To-Noise Ratio) average value (in dBm) that can be passed to method OutdoorLocationOptions.Builder.averageSnrThreshold.
minimizeFloorChanges() - Method in class es.situm.sdk.directions.DirectionsRequest
Deprecated.
minimizeFloorChanges(boolean) - Method in class es.situm.sdk.directions.DirectionsRequest.Builder
Sets if you want to calculate a route minimizing the floor changes even if the route is longer.
minimumOutdoorLocationAccuracy(int) - Method in class es.situm.sdk.location.OutdoorLocationOptions.Builder
Set the minimum accuracy in meters that an Outdoor Location must have to be returned via LocationListener and uploaded to Situm Platform.
minNumberSatellitesToRunDetector(int) - Method in class es.situm.sdk.location.OutdoorLocationOptions.Builder
Deprecated.
(Open Sky Detector only) Not used anymore. Use OutdoorLocationOptions.Builder.averageSnrThreshold(float) instead.
minPercentageToDetectOutdoor(float) - Method in class es.situm.sdk.location.OutdoorLocationOptions.Builder
Deprecated.
(Open Sky Detector only) Not used anymore. Use OutdoorLocationOptions.Builder.averageSnrThreshold(float) instead
minSnrToUseSatellite(float) - Method in class es.situm.sdk.location.OutdoorLocationOptions.Builder
Deprecated.
(Open Sky Detector only) Not used anymore. Use OutdoorLocationOptions.Builder.averageSnrThreshold(float) instead.
MISSING_BACKGROUND_LOCATION_PERMISSION - Static variable in interface es.situm.sdk.location.LocationManager.Code
Deprecated.
This error is not used and will never be thrown.
MISSING_BLUETOOTH_PERMISSION - Static variable in interface es.situm.sdk.location.LocationManager.Code
Missing required bluetooth permissions.
MISSING_LOCATION_PERMISSION - Static variable in interface es.situm.sdk.location.LocationManager.Code
Android Location permissions are needed to scan BLE and/or Wi-FI, or to use GPS information.
modifier(DirectionsModifier) - Method in class es.situm.sdk.model.directions.Restriction.Builder
 
motionMode(LocationRequest.MotionMode) - Method in class es.situm.sdk.location.LocationRequest.Builder
Sets the LocationRequest.MotionMode, which specifies how the user moves (e.g.

N

name(I18nString) - Method in class es.situm.sdk.model.cartography.PoiCategory.Builder
 
name(String) - Method in class es.situm.sdk.model.calibration.RemoteCalibration.Builder
 
name(String) - Method in class es.situm.sdk.model.cartography.Building.Builder
 
name(String) - Method in class es.situm.sdk.model.cartography.Floor.Builder
 
name(String) - Method in class es.situm.sdk.model.cartography.Geofence.Builder
 
name(String) - Method in class es.situm.sdk.model.cartography.Poi.Builder
 
NavigationListener - Interface in es.situm.sdk.navigation
NavigationListener Interface to receive updates from NavigationManager object.
navigationManager() - Static method in class es.situm.sdk.SitumSdk
Returns the navigation manager.
NavigationManager - Interface in es.situm.sdk.navigation
Central point to update the progress of a user when follows a route
NavigationProgress - Class in es.situm.sdk.model.navigation
Provide information of the progress of a user while following a route.
NavigationProgress.Builder - Class in es.situm.sdk.model.navigation
NavigationProgress builder static inner class.
NavigationRequest - Class in es.situm.sdk.navigation
Holds NavigationManager request parameters
NavigationRequest.Builder - Class in es.situm.sdk.navigation
NavigationState builder static inner class.
NETWORK_ERROR - Static variable in interface es.situm.sdk.communication.CommunicationManager.Code
Network error.
NetworkOptions - Interface in es.situm.sdk.configuration.network
This interface defines options relative to network operations.
NetworkOptions.CacheStrategy - Enum in es.situm.sdk.configuration.network
Supported SDK Cache Strategies.
NetworkOptionsImpl - Class in es.situm.sdk.configuration.network
This class implements NetworkOptions.
NetworkOptionsImpl.Builder - Class in es.situm.sdk.configuration.network
 
NEVER - es.situm.sdk.location.LocationRequest.RealtimeUpdateInterval
Computed geolocations won't be uploaded to Situm Platform.
nextIndication(Indication) - Method in class es.situm.sdk.model.navigation.NavigationProgress.Builder
Sets the nextIndication and returns a reference to this Builder so that the methods can be chained together.
NO_CONNECTION - es.situm.sdk.location.LocationStatus
Deprecated.
Warning: no internet connection is available (Situm SDK will not be able to download Positioning Models).
NORMAL - es.situm.sdk.location.LocationRequest.RealtimeUpdateInterval
Computed geolocations will be accumulated and sent to Situm Platform every 15 seconds.
NOT_ACCESSIBLE - es.situm.sdk.directions.DirectionsModifier.LEGACY_OPTIONS
The route should never use accessible floor changes (use this to force that routes don't use lifts)
NOT_USED - es.situm.sdk.model.calibration.RemoteCalibration.State
 
notifyClicked(Context, String) - Method in class es.situm.sdk.v1.SitumEvent
notifyConverted(Context, String) - Method in class es.situm.sdk.v1.SitumEvent
notifySeen(Context, String) - Method in class es.situm.sdk.v1.SitumEvent

O

onApplied(LocationParametersUpdate) - Method in interface es.situm.sdk.location.LocationParametersUpdateListener
Callback method that indicates that the LocationParametersUpdate has been successfully applied.
onDestinationReached() - Method in interface es.situm.sdk.navigation.NavigationListener
Called when the user is close to the destination by less than NavigationRequest.getDistanceToGoalThreshold()
onError(Error) - Method in interface es.situm.sdk.location.LocationListener
Called when an error is received during initialization.
onError(Error) - Method in interface es.situm.sdk.location.LocationParametersUpdateListener
The LocationParametersUpdate could not be applied because of an error.
onError(Error) - Method in interface es.situm.sdk.realtime.RealTimeListener
Invoked in case any error happens
onFailure(Error) - Method in interface es.situm.sdk.utils.Handler
Callback that is called in case any error happens
onLocationChanged(Location) - Method in interface es.situm.sdk.location.LocationListener
Called when the location has changed
ONLY_ACCESSIBLE - es.situm.sdk.directions.DirectionsRequest.AccessibilityMode
Deprecated.
To use this option with the new interface you have to create a DirectionsModifier and add a TagModifier prioritizing DirectionsModifier.LEGACY_OPTIONS.ACCESSIBLE
ONLY_NOT_ACCESSIBLE_FLOOR_CHANGES - es.situm.sdk.directions.DirectionsRequest.AccessibilityMode
Deprecated.
To use this option with the new interface you have to create a DirectionsModifier and add a TagModifier prioritizing DirectionsModifier.LEGACY_OPTIONS.NOT_ACCESSIBLE
onProgress(NavigationProgress) - Method in interface es.situm.sdk.navigation.NavigationListener
Called when a new location is received and the route progress is updated
onStatusChanged(LocationStatus) - Method in interface es.situm.sdk.location.LocationListener
Called when a new status is received
onSuccess(T) - Method in interface es.situm.sdk.utils.Handler
Will be invoked if the request finished successfully
onUserLocations(RealTimeData) - Method in interface es.situm.sdk.realtime.RealTimeListener
Invoked when there is a new list of devices positions
onUserOutsideRoute() - Method in interface es.situm.sdk.navigation.NavigationListener
Called when the user does not follow the route and is NavigationRequest.getOutsideRouteThreshold() meters or more far from it
options(DirectionsOptions) - Method in class es.situm.sdk.directions.DirectionsRequest.Builder
Sets additional information on how a route should be computed.
options(Map<String, Object>) - Method in class es.situm.sdk.communication.HttpRequest.Builder
Set custom options.
OR - es.situm.sdk.utils.filter.Filter.FilterMode
Deprecated.
 
organizationName(String) - Method in class es.situm.sdk.model.organization.OrganizationTheme.Builder
 
OrganizationTheme - Class in es.situm.sdk.model.organization
The organization name, UUID, colors and logo
OrganizationTheme(String, String, ThemeColors, URL) - Constructor for class es.situm.sdk.model.organization.OrganizationTheme
Deprecated. 
OrganizationTheme.Builder - Class in es.situm.sdk.model.organization
 
organizationUuid(String) - Method in class es.situm.sdk.model.organization.OrganizationTheme.Builder
 
ORIGIN_OR_DESTINATION_EXCLUDED - Static variable in interface es.situm.sdk.directions.DirectionsManager.Code
The request has an exclusion area that contains the origin or destination of the route.
outdoorLocationOptions(OutdoorLocationOptions) - Method in class es.situm.sdk.location.LocationRequest.Builder
(Global Mode only) Sets the OutdoorLocationOptions, which specify configuration related to the Global Mode (e.g.
OutdoorLocationOptions - Class in es.situm.sdk.location
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.
OutdoorLocationOptions.Builder - Class in es.situm.sdk.location
Builder for the OutdoorLocationOptions class.
OutdoorLocationOptions.BuildingDetector - Enum in es.situm.sdk.location
Allows to configure how Situm SDK will detect the building where the user is (building detector strategy).
outdoorPOIs(Collection<Poi>) - Method in class es.situm.sdk.model.cartography.BuildingInfo.Builder
 
outsideRouteThreshold(double) - Method in class es.situm.sdk.navigation.NavigationRequest.Builder
Sets the outsideRouteThreshold.
overrideSnrServervalue() - Method in class es.situm.sdk.location.OutdoorLocationOptions
Deprecated. 

P

path() - Method in class es.situm.sdk.model.URL
 
pictureThumbUrl(URL) - Method in class es.situm.sdk.model.cartography.Building.Builder
 
pictureUrl(URL) - Method in class es.situm.sdk.model.cartography.Building.Builder
 
pitch(Angle) - Method in class es.situm.sdk.model.location.Location.Builder
 
Poi - Class in es.situm.sdk.model.cartography
Point of Interest, associated to a building, regardless of whether it's place inside or outside the building.
Poi.Builder - Class in es.situm.sdk.model.cartography
Builder to create a Poi instances
PoiCategory - Class in es.situm.sdk.model.cartography
Category of Point of Interest.
PoiCategory.Builder - Class in es.situm.sdk.model.cartography
Builder to construct a PoiCategory
point(Point) - Method in class es.situm.sdk.model.cartography.Poi.Builder
 
Point - Class in es.situm.sdk.model.cartography
Associate geographical coordinate (Location) with Building and Floor (Cartography) and cartesian coordinate relative to that building.
Point(Building, String, CartesianCoordinate) - Constructor for class es.situm.sdk.model.cartography.Point
Create a point placed indoors.
Point(Building, String, Coordinate) - Constructor for class es.situm.sdk.model.cartography.Point
Create a point placed indoors.
Point(Point) - Constructor for class es.situm.sdk.model.cartography.Point
 
Point(Coordinate) - Constructor for class es.situm.sdk.model.cartography.Point
Create a point placed outdoors.
Point(String, Coordinate) - Constructor for class es.situm.sdk.model.cartography.Point
Create a point placed outdoors.
Point(String, String, Coordinate, CartesianCoordinate) - Constructor for class es.situm.sdk.model.cartography.Point
Create a point placed indoors.
points() - Method in class es.situm.sdk.model.directions.Route
Returns the list of points of the complete route for all the steps from beginning to finish
points(List<Point>) - Method in class es.situm.sdk.model.cartography.CalibrationArea.Builder
 
points(List<Point>) - Method in class es.situm.sdk.model.navigation.NavigationProgress.Builder
Sets the points and returns a reference to this Builder so that the methods can be chained together.
pollTimeMs(int) - Method in class es.situm.sdk.realtime.RealTimeRequest.Builder
The interval in milliseconds to get updates.
polygonPoints(List<Point>) - Method in class es.situm.sdk.model.cartography.Geofence.Builder
 
port() - Method in class es.situm.sdk.model.URL
Gets the port number of this URL.
position(Point) - Method in class es.situm.sdk.model.location.Location.Builder
 
POST - Static variable in annotation type es.situm.sdk.communication.HttpMethod
 
prefetchPositioningInfo(CommunicationConfig, Handler<String>) - Method in interface es.situm.sdk.communication.CommunicationManager
Download all the necessary information to start positioning.
prefetchPositioningInfo(Handler<String>) - Method in interface es.situm.sdk.communication.CommunicationManager
Download all the necessary information to start positioning.
prefetchPositioningInfo(List<String>, CommunicationConfig, Handler<String>) - Method in interface es.situm.sdk.communication.CommunicationManager
Download all the necessary information to start positioning in the selected buildings.
prefetchPositioningInfo(List<String>, Handler<String>) - Method in interface es.situm.sdk.communication.CommunicationManager
Download all the necessary information to start positioning in the selected buildings.
prefetchPositioningInfo(List<String>, Map<String, Object>, Handler<String>) - Method in interface es.situm.sdk.communication.CommunicationManager
prefetchPositioningInfo(Map<String, Object>, Handler<String>) - Method in interface es.situm.sdk.communication.CommunicationManager
PRELOAD_IMAGES - Static variable in annotation type es.situm.sdk.communication.CommunicationOptions
Deprecated.
Preload the images when you are downloading an object that contains them like Floor or PoiCategory.
preloadInfo(boolean) - Method in class es.situm.sdk.location.LocationRequest.Builder
Set if you want to load floor plan images and POI category images to cache while starting the LocationManager.
PREPARING_POSITIONING_MODEL - es.situm.sdk.location.LocationStatus
(Building Mode only) Situm SDK is getting ready to download the Positioning Model.
PRIORITIZE - es.situm.sdk.directions.DirectionsModifier.Actions
Gives preference to links
prioritizeModifier(DirectionsModifier) - Method in class es.situm.sdk.directions.DirectionsOptions.Builder
Apply DirectionsModifier that will be prioritized.
PROCESSING_POSITIONING_MODEL - es.situm.sdk.location.LocationStatus
(Building Mode only) The Positioning Model has been downloaded and now is being processed in order to start Indoor Positioning in its building.
protocol() - Method in class es.situm.sdk.model.URL
Wrap of URL.asURL() and method URL.getProtocol()
put(String, String) - Method in class es.situm.sdk.model.I18nString.Builder
Add string translated into another language.
put(Locale, String) - Method in class es.situm.sdk.model.I18nString.Builder
Add string translated into another language.
PUT - Static variable in annotation type es.situm.sdk.communication.HttpMethod
 

Q

quality(Location.Quality) - Method in class es.situm.sdk.model.location.Location.Builder
 

R

radians() - Method in class es.situm.sdk.model.location.Angle
 
radiansMinusPiPi() - Method in class es.situm.sdk.model.location.Angle
 
RADIOMAX - es.situm.sdk.location.LocationRequest.MotionMode
User movement type not known or can not be modelled properly, Situm will just return the location where the WiFi/BLE signals match better with those of the calibrations.
REALTIME - es.situm.sdk.location.LocationRequest.RealtimeUpdateInterval
Computed geolocations will be sent to Situm Platform every second.
RealTimeData - Class in es.situm.sdk.model.realtime
Represents the device positions
RealTimeData.Builder - Class in es.situm.sdk.model.realtime
Builder to create a RealTimeData instance
RealTimeListener - Interface in es.situm.sdk.realtime
Listener in which the device positions are received
realtimeManager() - Static method in class es.situm.sdk.SitumSdk
Returns realtime manager.
RealTimeManager - Interface in es.situm.sdk.realtime
RealTimeManager provides the ability to obtain real-time data from device positions.
RealTimeRequest - Class in es.situm.sdk.realtime
Represents the configuration for getting realtime devices positions in
RealTimeRequest.Builder - Class in es.situm.sdk.realtime
Builder to create a RealTimeRequest instance By default the poll time will be setted to 10 seconds.
realtimeUpdateInterval(LocationRequest.RealtimeUpdateInterval) - Method in class es.situm.sdk.location.LocationRequest.Builder
Specifies the interval between consecutive geolocations uploaded to Situm Platform (or whether they should be uploaded at all).
RemoteCalibration - Class in es.situm.sdk.model.calibration
A remote calibration stored in the cloud.
RemoteCalibration.Builder - Class in es.situm.sdk.model.calibration
 
RemoteCalibration.State - Enum in es.situm.sdk.model.calibration
 
RemoteConfig - Class in es.situm.sdk.model.configuration
This class encapsulates all the objects that can be configured remotely using the dashboard, at this moment: LocationRequest
RemoteConfig(LocationRequest) - Constructor for class es.situm.sdk.model.configuration.RemoteConfig
 
removeRealTimeUpdates() - Method in interface es.situm.sdk.realtime.RealTimeManager
Stop getting the devices positions
removeUpdates() - Method in interface es.situm.sdk.navigation.NavigationManager
Removes all location updates.
removeUpdates(LocationListener) - Method in interface es.situm.sdk.location.LocationManager
Stops positioning, removing all location updates for the given LocationListener.
request(DirectionsRequest) - Method in class es.situm.sdk.model.directions.Route.Builder
 
requestDirections(DirectionsRequest, Handler<Route>) - Method in interface es.situm.sdk.directions.DirectionsManager
Calculates a route between two points.
requestLocationUpdates(LocationRequest, LocationListener) - Method in interface es.situm.sdk.location.LocationManager
Starts positioning with the configuration specified by the LocationRequest; computed geolocations, status codes and errors will be received through the LocationListener callbacks.
requestNavigationUpdates(NavigationRequest, NavigationListener) - Method in interface es.situm.sdk.navigation.NavigationManager
Set the navigation params, and the listener that receives the updated navigation progress.
requestParams(Map<String, Object>) - Method in class es.situm.sdk.communication.HttpRequest.Builder
Set request params
requestRealTimeUpdates(RealTimeRequest, RealTimeListener) - Method in interface es.situm.sdk.realtime.RealTimeManager
Starts getting the devices positions
Resource - Class in es.situm.sdk.model
Abstract base class with common properties across Resources
Resource(Resource.Builder) - Constructor for class es.situm.sdk.model.Resource
 
responseDestinationFile(File) - Method in class es.situm.sdk.communication.HttpRequest.Builder
Set the file where the response will be writen
Restriction - Class in es.situm.sdk.model.directions
Represents a constraint that could not be satisfied when computing a Route object with DirectionsManager.requestDirections(DirectionsRequest, Handler).
Restriction.Builder - Class in es.situm.sdk.model.directions
 
restrictions(List<Restriction>) - Method in class es.situm.sdk.model.directions.Route.Builder
 
RETRY_DOWNLOAD_POSITIONING_MODEL - es.situm.sdk.location.LocationStatus
(Building Mode only) The download of the Positioning Model has failed and Situm SDK will retry again.
RIGHT - es.situm.sdk.model.directions.Indication.Orientation
 
roll(Angle) - Method in class es.situm.sdk.model.location.Location.Builder
 
rotation(Angle) - Method in class es.situm.sdk.model.cartography.Building.Builder
 
rotationMatrix(float[]) - Method in class es.situm.sdk.model.location.Location.Builder
 
roundIndicationsStep(int) - Method in class es.situm.sdk.navigation.NavigationRequest.Builder
Sets the step that will be used to round indications distance.
route(Route) - Method in class es.situm.sdk.navigation.NavigationRequest.Builder
Sets the Route whose progress is going to be updated.
Route - Class in es.situm.sdk.model.directions
Route between two points.
Route(DirectionsRequest, List<RouteStep>, List<Indication>, Building, Collection<Floor>) - Constructor for class es.situm.sdk.model.directions.Route
Just for internal SDK use
ROUTE - es.situm.sdk.error.Error.Domain
 
ROUTE_NOT_FOUND - Static variable in interface es.situm.sdk.directions.DirectionsManager.Code
Route not found between the two points
Route.Builder - Class in es.situm.sdk.model.directions
Helper class to create well formed instances of @{link es.situm.
routeId(int) - Method in class es.situm.sdk.location.LocationParametersUpdate.Builder
Identifier of the route.
routeId(int) - Method in class es.situm.sdk.location.LocationRequest.Builder
 
routePointsForDevice(long) - Method in class es.situm.sdk.model.cartography.Building
 
RouteSegment - Class in es.situm.sdk.model.directions
A continuous segment of a route that contains points of the same floor
RouteSegment() - Constructor for class es.situm.sdk.model.directions.RouteSegment
 
routeStep(RouteStep) - Method in class es.situm.sdk.model.navigation.NavigationProgress.Builder
Sets the routeStep and returns a reference to this Builder so that the methods can be chained together.
RouteStep - Class in es.situm.sdk.model.directions
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 - Class in es.situm.sdk.model.directions
RouteStep builder static inner class.
routeStepIndex(int) - Method in class es.situm.sdk.model.directions.Restriction.Builder
 

S

sameFloor(Point) - Method in class es.situm.sdk.model.cartography.Point
 
scale(double) - Method in class es.situm.sdk.model.cartography.Floor.Builder
 
Scans - Class in es.situm.sdk.model.cartography.calibration
Scans data of the calibration.
Scans(Grid) - Constructor for class es.situm.sdk.model.cartography.calibration.Scans
 
scansBasedDetectorAlwaysOn(boolean) - Method in class es.situm.sdk.location.OutdoorLocationOptions.Builder
(Not available with BuildingDetector.GPS_PROXIMITY) If true, WiFi/BLE based building detectors will continuously scan and reevaluate WiFi/BLE signal matches, in order to detect building transitions as fast as possible.
ScansType - Enum in es.situm.sdk.model.calibration
 
selectedIcon(URL) - Method in class es.situm.sdk.model.cartography.PoiCategory.Builder
 
SERVER_FIRST - es.situm.sdk.configuration.network.NetworkOptions.CacheStrategy
Force download from server.
SERVER_FIRST - Static variable in annotation type es.situm.sdk.communication.CommunicationOptions
Deprecated.
Force download from server.
SERVICE_ALREADY_RUNNING - Static variable in interface es.situm.sdk.location.LocationManager.Code
The LocationManager is already running (positioning has started).
setApiKey(String, String) - Method in class es.situm.sdk.Configuration
Provides your API key to the Situm SDK for Android.
setBottomLeft(Point2f) - Method in class es.situm.sdk.v1.SitumConversionArea
Deprecated.
 
setBottomRight(Point2f) - Method in class es.situm.sdk.v1.SitumConversionArea
Deprecated.
 
setCacheMaxAge(long, TimeUnit) - Method in class es.situm.sdk.Configuration
Sets the maximum age of a cached response.
setCacheStrategy(NetworkOptions.CacheStrategy) - Method in class es.situm.sdk.configuration.network.NetworkOptionsImpl.Builder
Sets the desired cache strategy.
setColliding(boolean) - Method in class es.situm.sdk.model.directions.Collision
 
setDashboardURL(String) - Method in class es.situm.sdk.Configuration
Set the Dashboard URL used by the SDK
setDebugOption(String, boolean) - Static method in class es.situm.sdk.SitumSdk
Set internal debug options.
setDebugOption(String, String) - Static method in class es.situm.sdk.SitumSdk
Set internal debug options.
setDistance(double) - Method in class es.situm.sdk.model.directions.Indication.Builder
 
setDistance(double) - Method in class es.situm.sdk.model.directions.Indication
 
setDistanceToNextLevel(int) - Method in class es.situm.sdk.model.directions.Indication.Builder
 
setDistanceToNextLevel(int) - Method in class es.situm.sdk.model.directions.Indication
 
setEventId(int) - Method in class es.situm.sdk.model.geofencing.EventOccurrence
Just for internal SDK use
setFloor_id(int) - Method in class es.situm.sdk.v1.SitumConversionArea
Deprecated.
 
setId(int) - Method in class es.situm.sdk.model.geofencing.EventOccurrence
Just for internal SDK use
setId(int) - Method in class es.situm.sdk.v1.SitumEvent
Just for internal SDK use.
setInstructionType(Indication.Action) - Method in class es.situm.sdk.model.directions.Indication.Builder
 
setLocationRequest(LocationRequest) - Method in class es.situm.sdk.model.configuration.RemoteConfig
 
setNetworkOptions(NetworkOptions) - Method in class es.situm.sdk.communication.CommunicationConfigImpl
 
setNextLevel(Integer) - Method in class es.situm.sdk.model.directions.Indication.Builder
 
setOrientation(double) - Method in class es.situm.sdk.model.directions.Indication.Builder
 
setOrientation(double) - Method in class es.situm.sdk.model.directions.Indication
 
setOrientationType(Indication.Orientation) - Method in class es.situm.sdk.model.directions.Indication.Builder
 
setPoints(Collection<Point>) - Method in class es.situm.sdk.model.cartography.calibration.Scans
 
setPreloadImages(Boolean) - Method in class es.situm.sdk.configuration.network.NetworkOptionsImpl.Builder
Specifies if images should be preloaded when available.
setSimulatedLocationManager(LocationManager) - Static method in class es.situm.sdk.SitumSdk
Set a simulated location manager.
setStepIdxDestination(int) - Method in class es.situm.sdk.model.directions.Indication.Builder
 
setStepIdxOrigin(int) - Method in class es.situm.sdk.model.directions.Indication.Builder
 
setStepIdxOrigin(int) - Method in class es.situm.sdk.model.directions.Indication
 
setTags(List<String>) - Method in class es.situm.sdk.model.directions.RouteStep
 
setTopLeft(Point2f) - Method in class es.situm.sdk.v1.SitumConversionArea
Deprecated.
 
setTopRight(Point2f) - Method in class es.situm.sdk.v1.SitumConversionArea
Deprecated.
 
setUseRemoteConfig(boolean) - Method in class es.situm.sdk.Configuration
Set to true if you want the SDK to download the configuration from dashboard and use it by default.
setUserPass(String, String) - Method in class es.situm.sdk.Configuration
Provides user's email and password.
setWeight(Double) - Method in class es.situm.sdk.model.directions.RouteStep
 
setWhenClicked(Date) - Method in class es.situm.sdk.model.geofencing.EventOccurrence
 
setWhenConverted(Date) - Method in class es.situm.sdk.model.geofencing.EventOccurrence
 
SHARP_LEFT - es.situm.sdk.model.directions.Indication.Orientation
 
SHARP_RIGHT - es.situm.sdk.model.directions.Indication.Orientation
 
SitumConversionArea - Class in es.situm.sdk.v1
Deprecated.
Use Circle
SitumConversionArea(Point2f, Point2f, Point2f, Point2f, int) - Constructor for class es.situm.sdk.v1.SitumConversionArea
Deprecated.
 
SitumEvent - Class in es.situm.sdk.v1
An event: POI with radius, conversion area and asociated statistics.
SitumEvent() - Constructor for class es.situm.sdk.v1.SitumEvent
 
SitumSdk - Class in es.situm.sdk
Main entry point for the Situm SDK.
SitumSdk() - Constructor for class es.situm.sdk.SitumSdk
 
SLOW - es.situm.sdk.location.LocationRequest.RealtimeUpdateInterval
Computed geolocations will be sent to Situm Platform every 25 seconds.
smallestDisplacement(float) - Method in class es.situm.sdk.location.LocationRequest.Builder
Sets the smallest smartphone displacement required between every two consecutive Indoor Position updates communicated via LocationListener.onLocationChanged(Location) callback.
speed(double) - Method in class es.situm.sdk.model.navigation.NavigationProgress.Builder
Sets the speed and returns a reference to this Builder so that the methods can be chained together.
START_DOWNLOADING_POSITIONING_MODEL - es.situm.sdk.location.LocationStatus
(Building Mode only) The download of the Positioning Model is starting.
START_SERVICE_FAILED - Static variable in interface es.situm.sdk.location.LocationManager.Code
The LocationManager could not start because the Android Service where it runs tried to start in a illegal state.
STARTING - es.situm.sdk.location.LocationStatus
This is the first action performed by the LocationManager: it just means that it is starting.
STARTING_POSITIONING - es.situm.sdk.location.LocationStatus
(Building Mode only) Indoor Positioning is starting: Situm SDK will start reading sensor data (for example, WIFI and BLE) and computing the Indoor Position within the selected building.
state(RemoteCalibration.State) - Method in class es.situm.sdk.model.calibration.RemoteCalibration.Builder
 
steps(List<RouteStep>) - Method in class es.situm.sdk.model.directions.Route.Builder
 
STOPPED - es.situm.sdk.location.LocationStatus
The LocationManager has stopped (this may happen because of an error or after calling LocationManager.removeUpdates(LocationListener)).
STRAIGHT - es.situm.sdk.model.directions.Indication.Orientation
 
SUPPORT - es.situm.sdk.location.LocationRequest.IndoorProvider
Deprecated.
INPHONE mode will be used instead

T

tag(String) - Method in class es.situm.sdk.directions.TagModifier.Builder
Set the string that describes the modifier
TagModifier - Class in es.situm.sdk.directions
Specifies a properties (tag) based on which Directions API will modify its graph.
TagModifier.Builder - Class in es.situm.sdk.directions
Helper class to create well formed instances of TagModifier class
tags(List<TagModifier>) - Method in class es.situm.sdk.directions.DirectionsModifier.Builder
Set the elements to process
themeColors(ThemeColors) - Method in class es.situm.sdk.model.organization.OrganizationTheme.Builder
 
ThemeColors - Class in es.situm.sdk.model.organization
Theme colors
ThemeColors(String, String, String, String, String, String, String) - Constructor for class es.situm.sdk.model.organization.ThemeColors
 
TIME_SETTINGS_MANUAL - es.situm.sdk.location.LocationStatus
Warning: The user has disabled the "Automatic date and time" setting of the smartphone, therefore the date and time will be manually determined by the user, instead of automatically determined by the network.
TIMED_CACHE - es.situm.sdk.configuration.network.NetworkOptions.CacheStrategy
If there is no cache or if the cache is too old it will download from server.
timestamp(long) - Method in class es.situm.sdk.model.location.Location.Builder
 
timeToFirstIndication(long) - Method in class es.situm.sdk.navigation.NavigationRequest.Builder
Sets the time to wait until the first indication is returned.
timeToIgnoreUnexpectedFloorChanges(int) - Method in class es.situm.sdk.navigation.NavigationRequest.Builder
Sets the time (in millis) to ignore the locations received during navigation, when the next indication is a floor change, if the locations are in a wrong floor (not in origin or destination floors).
to(Point) - Method in class es.situm.sdk.directions.DirectionsRequest.Builder
Sets the point to, where the route should end.
to(Point) - Method in class es.situm.sdk.model.directions.RouteStep.Builder
 
toAngle(Angle) - Method in class es.situm.sdk.location.util.CoordinateConverter
Converts and angle from building system coordinate to Earth system coordinate.
toCartesianCoordinate(Coordinate) - Method in class es.situm.sdk.location.util.CoordinateConverter
Transform geographical coordinates to cartesian coordinates (within the area defined in the constructor)
toCoordinate(CartesianCoordinate) - Method in class es.situm.sdk.location.util.CoordinateConverter
Transform cartesian coordinates (within the area defined in the constructor) into geographical coordinates
toString() - Method in class es.situm.sdk.directions.DirectionsModifier
 
toString() - Method in class es.situm.sdk.directions.DirectionsRequest
 
toString() - Method in class es.situm.sdk.directions.TagModifier
 
toString() - Method in class es.situm.sdk.location.ExternalLocation
 
toString() - Method in class es.situm.sdk.location.LocationParametersUpdate
 
toString() - Method in class es.situm.sdk.location.LocationRequest
 
toString() - Method in class es.situm.sdk.location.OutdoorLocationOptions
 
toString() - Method in class es.situm.sdk.model.calibration.RemoteCalibration
 
toString() - Method in class es.situm.sdk.model.cartography.Building
 
toString() - Method in class es.situm.sdk.model.cartography.BuildingInfo
 
toString() - Method in class es.situm.sdk.model.cartography.CalibrationArea
 
toString() - Method in class es.situm.sdk.model.cartography.Circle
 
toString() - Method in class es.situm.sdk.model.cartography.Floor
 
toString() - Method in class es.situm.sdk.model.cartography.Geofence
 
toString() - Method in class es.situm.sdk.model.cartography.Poi
 
toString() - Method in class es.situm.sdk.model.cartography.PoiCategory
 
toString() - Method in class es.situm.sdk.model.cartography.Point
 
toString() - Method in class es.situm.sdk.model.directions.Indication
 
toString() - Method in class es.situm.sdk.model.directions.Restriction
 
toString() - Method in class es.situm.sdk.model.directions.Route
 
toString() - Method in class es.situm.sdk.model.directions.RouteStep
 
toString() - Method in class es.situm.sdk.model.I18nString
 
toString() - Method in class es.situm.sdk.model.location.Angle
 
toString() - Method in class es.situm.sdk.model.location.BeaconFilter
 
toString() - Method in class es.situm.sdk.model.location.Bounds
 
toString() - Method in class es.situm.sdk.model.location.CartesianCoordinate
 
toString() - Method in class es.situm.sdk.model.location.Coordinate
 
toString() - Method in class es.situm.sdk.model.location.Dimensions
 
toString() - Method in class es.situm.sdk.model.location.Location
 
toString() - Method in class es.situm.sdk.model.navigation.NavigationProgress
 
toString() - Method in class es.situm.sdk.model.organization.OrganizationTheme
 
toString() - Method in class es.situm.sdk.model.organization.ThemeColors
 
toString() - Method in class es.situm.sdk.model.realtime.RealTimeData
 
toString() - Method in class es.situm.sdk.model.Resource
 
toString() - Method in class es.situm.sdk.model.URL
 
toString() - Method in class es.situm.sdk.navigation.NavigationRequest
 
toString() - Method in class es.situm.sdk.realtime.RealTimeRequest
 
toString() - Method in class es.situm.sdk.v1.SitumConversionArea
Deprecated.
 
toString() - Method in class es.situm.sdk.v1.SitumEvent
 
toText(Context) - Method in class es.situm.sdk.model.directions.Indication
Get a natural language string describing the instruction in the language of the Locale of the device (if translation available).
toText(Context, Locale) - Method in class es.situm.sdk.model.directions.Indication
Get a natural language string describing the instruction.
TRAIN_USED - es.situm.sdk.model.calibration.RemoteCalibration.State
 
TRAINING - es.situm.sdk.model.calibration.RemoteCalibration.State
 
TURN - es.situm.sdk.model.directions.Indication.Action
 

U

UNKNOWN - es.situm.sdk.directions.DirectionsModifier.Actions
This value is necessary for initialization purposes but as a developer you should never use it.
UNKNOWN - es.situm.sdk.model.calibration.RemoteCalibration.State
 
UNPROCESSABLE_ENTITY - Static variable in interface es.situm.sdk.error.CommonErrorConstant.Code
 
unselectedIcon(URL) - Method in class es.situm.sdk.model.cartography.PoiCategory.Builder
 
updateDevicesToFollow(boolean) - Method in class es.situm.sdk.location.LocationParametersUpdate.Builder
(De)Active parameter to update.
updateInterval(int) - Method in class es.situm.sdk.location.OutdoorLocationOptions.Builder
Value in milliseconds that determines the period between consecutive Outdoor Locations returned via the LocationListener.onLocationChanged callback and uploaded to Situm Platform.
updateLocationParameters(LocationParametersUpdate, LocationParametersUpdateListener) - Method in interface es.situm.sdk.location.LocationManager
Updates positioning parameters on the fly (without stopping and re-starting positioning).
updateOccurrence(EventOccurrence, EventAction, Handler<EventOccurrence>) - Method in interface es.situm.sdk.communication.CommunicationManager
Update an event occurrence The time when the action was produced can be provided in the occurrence; if not, new Date() is assumed.
updateRailWidth(Building, float, Handler<Object>) - Method in interface es.situm.sdk.communication.CommunicationManager
updateRailWidth(String, float, Handler<Object>) - Method in interface es.situm.sdk.communication.CommunicationManager
Update the calibrations rail width for a building
updateWithLocation(Location) - Method in interface es.situm.sdk.navigation.NavigationManager
Informs NavigationManager object the change of the user's location
uri(String) - Method in class es.situm.sdk.model.calibration.RemoteCalibration.Builder
 
url(String) - Method in class es.situm.sdk.communication.HttpRequest.Builder
Set the relative url to send the request
URL - Class in es.situm.sdk.model
Abstraction of URL.
URL - Static variable in interface es.situm.sdk.communication.CommunicationManager.PropertyKey
 
URL(String) - Constructor for class es.situm.sdk.model.URL
Create a URL object with an absolute or relative URL.
useBarometer() - Method in class es.situm.sdk.location.LocationRequest
Returns true if the barometer should be used to compute Indoor Positioning (helps with floor changes).
useBarometer(boolean) - Method in class es.situm.sdk.location.LocationRequest.Builder
Sets if the barometer should be used to compute Indoor Positioning (helps with floor changes).
useBatterySaver() - Method in class es.situm.sdk.location.LocationRequest
Returns true if Battery Saver mode is ON (stops geolocation computations after prolonged smartphone inactivity).
useBatterySaver(Boolean) - Method in class es.situm.sdk.location.LocationRequest.Builder
Activates Battery Saver mode (stopping geolocation computations after prolonged smartphone inactivity).
useBle() - Method in class es.situm.sdk.location.LocationRequest
Returns true if BLE scanning is enabled to compute Indoor Positioning.
useBle() - Method in enum es.situm.sdk.location.OutdoorLocationOptions.BuildingDetector
Tells us whether BLE scans are used by the building detector.
useBle(boolean) - Method in class es.situm.sdk.location.LocationRequest.Builder
Sets if you want to use BLE scanning for Indoor Positioning.
useCompass() - Method in class es.situm.sdk.location.LocationRequest
Returns true if compass is enabled to compute Indoor Positioning.
useCompass(boolean) - Method in class es.situm.sdk.location.LocationRequest.Builder
Sets if you want to use the compass for Indoor Positioning.
USED - es.situm.sdk.model.calibration.RemoteCalibration.State
 
useDeadReckoning() - Method in class es.situm.sdk.location.LocationRequest
Returns true Dead Reckoning should be used to compute fast orientation updates (several per second) to account for quick orientation changes (recommended to provide a smooth wayfinding experience).
useDeadReckoning(boolean) - Method in class es.situm.sdk.location.LocationRequest.Builder
Enables the use of Dead Reckoning to get sub-second orientation updates (allows to provide smooth turns in wayfinding apps).
useExternalLocations(boolean) - Method in class es.situm.sdk.Configuration
Set to true if you want the SDK to use external locations instead of it's own indoor positioning system.
useForegroundService() - Method in class es.situm.sdk.location.LocationRequest
Returns true if Situm SDK should run infinitely even if the app goes to the background.
useForegroundService(boolean) - Method in class es.situm.sdk.location.LocationRequest.Builder
Runs the LocationManager as a Foreground Service (prevents Android from killing the app while on background).
useGeofencesInBuildingSelector() - Method in class es.situm.sdk.location.OutdoorLocationOptions
useGeofencesInBuildingSelector(boolean) - Method in class es.situm.sdk.location.OutdoorLocationOptions.Builder
(Uncalibrated Indoor GPS mode only) If true, an user will be detected to be within a building if she is within one or more of the special geofences that have been set up in that building.
useGlobalLocation() - Method in class es.situm.sdk.location.LocationRequest
Return true if Global Mode is enabled (positioning anywhere with automatic building detection).
useGps() - Method in class es.situm.sdk.location.LocationRequest
Returns true if GPS geolocation is enabled to compute Indoor Positioning.
useGps(boolean) - Method in class es.situm.sdk.location.LocationRequest.Builder
(Global Mode only) Sets if you want to use GPS for Indoor Positioning.
useGyro() - Method in class es.situm.sdk.location.LocationRequest
Returns true if gyroscope is enabled to compute Indoor Positioning.
useGyro(boolean) - Method in class es.situm.sdk.location.LocationRequest.Builder
Sets if you want to use the gyroscope for Indoor Positioning.
useLocationsCache() - Method in class es.situm.sdk.location.LocationRequest
 
useLocationsCache(Boolean) - Method in class es.situm.sdk.location.LocationRequest.Builder
Activates the Location Cache, which uses the last known Indoor Position (from a previous positioning session) as a hint to accelerate convergence when positioning starts.
USER_NOT_IN_BUILDING - es.situm.sdk.location.LocationStatus
(Building Mode only) A valid position can not be computed in the selected building.
USER_WITHOUT_BUILDINGS - Static variable in interface es.situm.sdk.location.LocationManager.Code
You do not have any buildings in your account or you don't have permissions to see any.
userDefinedThreshold(boolean) - Method in class es.situm.sdk.location.OutdoorLocationOptions.Builder
Deprecated.
(Open Sky Detector only). Do not use.
userIdentifier(String) - Method in class es.situm.sdk.model.cartography.Building.Builder
 
useWifi() - Method in class es.situm.sdk.location.LocationRequest
Returns true if WiFi scanning is enabled to compute Indoor Positioning.
useWifi() - Method in enum es.situm.sdk.location.OutdoorLocationOptions.BuildingDetector
Tells us whether WiFi scans are used by the building detector.
useWifi(boolean) - Method in class es.situm.sdk.location.LocationRequest.Builder
Sets if you want to use WiFi scanning for Indoor Positioning.
uuid(String) - Method in class es.situm.sdk.model.location.BeaconFilter.Builder
Assigns the proximity UUID

V

validate(HttpRequest) - Method in class es.situm.sdk.communication.HttpRequestExecutor
 
validateUserCredentials(Handler<Object>) - Method in interface es.situm.sdk.communication.CommunicationManager
Check if the user credentials previously set with Configuration.setUserPass(String, String), SitumSdk.configuration() or in the AndroidManifest.xml are right.
VALUE - es.situm.sdk.utils.filter.Filter.KeyValueFilter.FilterBy
Deprecated.
 
valueOf(String) - Static method in enum es.situm.sdk.configuration.network.NetworkOptions.CacheStrategy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum es.situm.sdk.directions.DirectionsModifier.Actions
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum es.situm.sdk.directions.DirectionsModifier.LEGACY_OPTIONS
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum es.situm.sdk.directions.DirectionsRequest.AccessibilityMode
Deprecated.
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum es.situm.sdk.error.Error.Domain
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum es.situm.sdk.location.LocationRequest.IndoorProvider
Deprecated.
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum es.situm.sdk.location.LocationRequest.MotionMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum es.situm.sdk.location.LocationRequest.RealtimeUpdateInterval
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum es.situm.sdk.location.LocationStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum es.situm.sdk.location.OutdoorLocationOptions.BuildingDetector
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum es.situm.sdk.model.calibration.RemoteCalibration.State
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum es.situm.sdk.model.calibration.ScansType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum es.situm.sdk.model.directions.Indication.Action
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum es.situm.sdk.model.directions.Indication.Orientation
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum es.situm.sdk.model.geofencing.EventAction
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum es.situm.sdk.model.location.Location.Quality
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum es.situm.sdk.utils.filter.Filter.FilterMode
Deprecated.
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum es.situm.sdk.utils.filter.Filter.KeyValueFilter.FilterBy
Deprecated.
Returns the enum constant of this type with the specified name.
values() - Static method in enum es.situm.sdk.configuration.network.NetworkOptions.CacheStrategy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum es.situm.sdk.directions.DirectionsModifier.Actions
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum es.situm.sdk.directions.DirectionsModifier.LEGACY_OPTIONS
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum es.situm.sdk.directions.DirectionsRequest.AccessibilityMode
Deprecated.
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum es.situm.sdk.error.Error.Domain
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum es.situm.sdk.location.LocationRequest.IndoorProvider
Deprecated.
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum es.situm.sdk.location.LocationRequest.MotionMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum es.situm.sdk.location.LocationRequest.RealtimeUpdateInterval
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum es.situm.sdk.location.LocationStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum es.situm.sdk.location.OutdoorLocationOptions.BuildingDetector
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum es.situm.sdk.model.calibration.RemoteCalibration.State
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum es.situm.sdk.model.calibration.ScansType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum es.situm.sdk.model.directions.Indication.Action
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum es.situm.sdk.model.directions.Indication.Orientation
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum es.situm.sdk.model.geofencing.EventAction
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum es.situm.sdk.model.location.Location.Quality
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum es.situm.sdk.utils.filter.Filter.FilterMode
Deprecated.
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum es.situm.sdk.utils.filter.Filter.KeyValueFilter.FilterBy
Deprecated.
Returns an array containing the constants of this enum type, in the order they are declared.
VEER_LEFT - es.situm.sdk.model.directions.Indication.Orientation
 
VEER_RIGHT - es.situm.sdk.model.directions.Indication.Orientation
 
VEHICLE_VISUAL_ODOMETRY - es.situm.sdk.location.LocationRequest.MotionMode
(EXPERIMENTAL) User moves on a vehicle (e.g.
VISUAL_ODOMETRY_ERROR - Static variable in interface es.situm.sdk.location.LocationManager.Code
Visual odometry can not be used to estimate the movement of the smartphone.

W

WAITING - es.situm.sdk.model.calibration.RemoteCalibration.State
 
WIFI - es.situm.sdk.location.OutdoorLocationOptions.BuildingDetector
The user will be geolocated inside the building whose WiFi calibration signals match better with those perceived by the user smartphone.
WIFI - es.situm.sdk.model.calibration.ScansType
 
WIFI_AND_BLE - es.situm.sdk.location.OutdoorLocationOptions.BuildingDetector
The user will be geolocated inside the building whose WiFi and BLE calibration signals match better with those perceived by the user smartphone.
WIFI_SCAN_THROTTLED - es.situm.sdk.location.LocationStatus
(Android 9 and superior only) The WiFi scan is throttled (see this article for details), and the WiFi scan interval will be changed to one scan every 30 seconds.
writeToParcel(Parcel, int) - Method in class es.situm.sdk.directions.DirectionsRequest
 
writeToParcel(Parcel, int) - Method in class es.situm.sdk.location.ExternalLocation
 
writeToParcel(Parcel, int) - Method in class es.situm.sdk.location.LocationRequest
 
writeToParcel(Parcel, int) - Method in class es.situm.sdk.location.OutdoorLocationOptions
 
writeToParcel(Parcel, int) - Method in class es.situm.sdk.location.util.CoordinateConverter
 
writeToParcel(Parcel, int) - Method in class es.situm.sdk.model.calibration.RemoteCalibration
 
writeToParcel(Parcel, int) - Method in class es.situm.sdk.model.cartography.Building
 
writeToParcel(Parcel, int) - Method in class es.situm.sdk.model.cartography.BuildingInfo
 
writeToParcel(Parcel, int) - Method in class es.situm.sdk.model.cartography.CalibrationArea
 
writeToParcel(Parcel, int) - Method in class es.situm.sdk.model.cartography.Circle
 
writeToParcel(Parcel, int) - Method in class es.situm.sdk.model.cartography.Floor
 
writeToParcel(Parcel, int) - Method in class es.situm.sdk.model.cartography.Geofence
 
writeToParcel(Parcel, int) - Method in class es.situm.sdk.model.cartography.Poi
 
writeToParcel(Parcel, int) - Method in class es.situm.sdk.model.cartography.PoiCategory
 
writeToParcel(Parcel, int) - Method in class es.situm.sdk.model.cartography.Point
 
writeToParcel(Parcel, int) - Method in class es.situm.sdk.model.directions.Indication
 
writeToParcel(Parcel, int) - Method in class es.situm.sdk.model.directions.Route
 
writeToParcel(Parcel, int) - Method in class es.situm.sdk.model.directions.RouteStep
 
writeToParcel(Parcel, int) - Method in class es.situm.sdk.model.geofencing.EventOccurrence
 
writeToParcel(Parcel, int) - Method in class es.situm.sdk.model.I18nString
 
writeToParcel(Parcel, int) - Method in class es.situm.sdk.model.location.Angle
 
writeToParcel(Parcel, int) - Method in class es.situm.sdk.model.location.BeaconFilter
 
writeToParcel(Parcel, int) - Method in class es.situm.sdk.model.location.Bounds
 
writeToParcel(Parcel, int) - Method in class es.situm.sdk.model.location.CartesianCoordinate
 
writeToParcel(Parcel, int) - Method in class es.situm.sdk.model.location.Coordinate
 
writeToParcel(Parcel, int) - Method in class es.situm.sdk.model.location.Dimensions
 
writeToParcel(Parcel, int) - Method in class es.situm.sdk.model.location.Location
 
writeToParcel(Parcel, int) - Method in class es.situm.sdk.model.navigation.NavigationProgress
 
writeToParcel(Parcel, int) - Method in class es.situm.sdk.model.realtime.RealTimeData
 
writeToParcel(Parcel, int) - Method in class es.situm.sdk.model.URL
 
writeToParcel(Parcel, int) - Method in class es.situm.sdk.realtime.RealTimeRequest
 
writeToParcel(Parcel, int) - Method in class es.situm.sdk.v1.SitumConversionArea
Deprecated.
 
writeToParcel(Parcel, int) - Method in class es.situm.sdk.v1.SitumEvent
 
A B C D E F G H I K L M N O P Q R S T U V W 
All Classes All Packages