Package es.situm.sdk.location

Class LocationRequest

java.lang.Object

es.situm.sdk.location.LocationRequest

All Implemented Interfaces:

android.os.Parcelable

public class LocationRequest
extends Object
implements android.os.Parcelable

A data object that allows you to configure the positioning parameters of the LocationManager (e.g. use WiFi or BLE, Building Mode vs Global Mode, etc.).

To start positioning, this object will be passed to LocationManager.requestLocationUpdates(LocationRequest, LocationListener). To build this object, you may use the LocationRequest.Builder method (Builder Pattern).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	LocationRequest.Builder	Builder constructor that allows you to configure all LocationRequest parameters.
static enum	LocationRequest.IndoorProvider	Deprecated. This enum is no longer used.
static enum	LocationRequest.MotionMode	Indicates how the user carrying the smartphone moves: on foot (default), by car, etc.
static enum	LocationRequest.RealtimeUpdateInterval	Determines how often the SDK attempts to upload buffered location updates to Situm Platform.

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

android.os.Parcelable.ClassLoaderCreator<T extends Object>, android.os.Parcelable.Creator<T extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static final android.os.Parcelable.Creator<LocationRequest>	CREATOR
static final LocationRequest.IndoorProvider	DEFAULT_INDOOR_PROVIDER	Default indoor provider (INPHONE by default)
static final int	DEFAULT_INTERVAL	Default interval (in milliseconds) to notify location updates via the LocationListener.onLocationChanged() callback (1000 milliseconds by default)
static final LocationRequest.MotionMode	DEFAULT_MOTION_MODE	Default motion mode (BY_FOOT by default)
static final int	DEFAULT_REALTIME_PERSISTENCE_INTERVAL	Default interval in milliseconds used to limit locations stored locally for upload (1000 milliseconds by default).
static final LocationRequest.RealtimeUpdateInterval	DEFAULT_REALTIME_UPDATE_INTERVAL	Default interval (in milliseconds) between consecutive locations sent to Situm Platform (1000 milliseconds by default)
static final float	DEFAULT_SMALLEST_DISPLACEMENT	Default smallest displacement to notify location updates via the LocationListener.onLocationChanged() callback (0.0 meters by default)

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Modifier and Type	Method	Description
Boolean	autoEnableBleDuringPositioning()	Returns true if Situm SDK is configured to re-enable Bluetooth when the user disables it from the system tray.
Boolean	avoidDoze()
int	describeContents()
boolean	equals(Object o)
AssetTrackingOptions	getAssetTrackingOptions()	Returns the configured AssetTrackingOptions, which specifies options related to asset tracking using BLE beacons.
List<BeaconFilter>	getBeaconFilters()	Gets the list of beacon UUIDs that will be taken into account when using BLE signals for positioning.
String	getBuildingIdentifier()	(Building Mode) Gets the identifier of the building where Situm SDK should perform positioning.
DiagnosticsOptions	getDiagnosticsOptions()	Returns the configured DiagnosticsOptions, which specifies options related to remote diagnostic and telemetry data.
android.app.Notification	getForegroundServiceNotification()	Returns the Notification that will be shown in the system's tray when the app is running as a Foreground Service.
ForegroundServiceNotificationOptions	getForegroundServiceNotificationOptions()	Returns the options used to customize the Foreground Service Notification, if any.
LocationRequest.IndoorProvider	getIndoorProvider()	Deprecated. Indoor provider is LocationRequest.IndoorProvider.INPHONE by default and cannot be changed.
Integer	getInterval()	Gets the minimum interval in milliseconds between Indoor Positions delivered through LocationListener.onLocationChanged(Location).
LocationRequest.MotionMode	getMotionMode()	Gets the LocationRequest.MotionMode, which specifies how the user moves (e.g.
OutdoorLocationOptions	getOutdoorLocationOptions()	Gets the OutdoorLocationOptions, which specify parameters related to the Global Mode (e.g.
Integer	getRealtimePersistenceInterval()	Gets the interval used to limit locations stored locally for upload to Situm Platform.
LocationRequest.RealtimeUpdateInterval	getRealtimeUpdateInterval()	Gets the configured LocationRequest.RealtimeUpdateInterval, which specifies the upload interval for buffered locations.
RouteAdjustment	getRouteAdjustment()
Integer	getRouteId()
List<Point>	getRoutePoints()
Float	getSmallestDisplacement()	Gets the smallest smartphone displacement allowed between two consecutive Indoor Positions communicated via LocationListener.onLocationChanged(Location) callback.
int	hashCode()
Boolean	isIgnoreWifiThrottling()	Returns true if WiFi Throttling protections should be ignored (or, in other words, if WiFi should be scanned as fast as possible).
Boolean	isLocationDelimitedByRoute()
Boolean	isPreloadInfo()
String	toString()
Boolean	useBarometer()	Returns true if the barometer should be used to compute Indoor Positioning (helps with floor changes).
Boolean	useBatterySaver()	Returns true if Battery Saver mode is ON (stops geolocation computations after prolonged smartphone inactivity).
Boolean	useBle()	Returns true if BLE scanning is enabled to compute Indoor Positioning.
Boolean	useCompass()	Returns true if compass is enabled to compute Indoor Positioning.
Boolean	useDeadReckoning()	Returns true if 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).
Boolean	useForegroundService()	Returns true if Situm SDK should run infinitely even if the app goes to the background.
Boolean	useGlobalLocation()	Return true if Global Mode is enabled (positioning anywhere with automatic building detection).
Boolean	useGps()	Returns true if GPS geolocation is enabled to compute Indoor Positioning.
Boolean	useGyro()	Returns true if the gyroscope is enabled to compute Indoor Positioning.
Boolean	useLocationsCache()
Boolean	useWifi()	Returns true if WiFi scanning is enabled to compute Indoor Positioning.
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_INTERVAL

public static final int DEFAULT_INTERVAL

Default interval (in milliseconds) to notify location updates via the LocationListener.onLocationChanged() callback (1000 milliseconds by default)

See Also:

• Constant Field Values

DEFAULT_INDOOR_PROVIDER

public static final LocationRequest.IndoorProvider DEFAULT_INDOOR_PROVIDER

Default indoor provider (INPHONE by default)

DEFAULT_MOTION_MODE

public static final LocationRequest.MotionMode DEFAULT_MOTION_MODE

Default motion mode (BY_FOOT by default)

DEFAULT_SMALLEST_DISPLACEMENT

public static final float DEFAULT_SMALLEST_DISPLACEMENT

Default smallest displacement to notify location updates via the LocationListener.onLocationChanged() callback (0.0 meters by default)

See Also:

• Constant Field Values

DEFAULT_REALTIME_UPDATE_INTERVAL

public static final LocationRequest.RealtimeUpdateInterval DEFAULT_REALTIME_UPDATE_INTERVAL

Default interval (in milliseconds) between consecutive locations sent to Situm Platform (1000 milliseconds by default)

DEFAULT_REALTIME_PERSISTENCE_INTERVAL

public static final int DEFAULT_REALTIME_PERSISTENCE_INTERVAL

Default interval in milliseconds used to limit locations stored locally for upload (1000 milliseconds by default).

See Also:

• Constant Field Values

CREATOR

public static final android.os.Parcelable.Creator<LocationRequest> CREATOR

Method Details

isLocationDelimitedByRoute

public Boolean isLocationDelimitedByRoute()

getRouteId

public Integer getRouteId()

getRoutePoints

public List<Point> getRoutePoints()

getBuildingIdentifier

public String getBuildingIdentifier()

(Building Mode) Gets the identifier of the building where Situm SDK should perform positioning.

To set this value, use method LocationRequest.Builder.buildingIdentifier(String).

Returns:

String with building identifier

getInterval

public Integer getInterval()

Gets the minimum interval in milliseconds between Indoor Positions delivered through LocationListener.onLocationChanged(Location).

Use LocationRequest.Builder.interval(int) to configure this value. The default is DEFAULT_INTERVAL milliseconds.

Returns:

interval value in milliseconds

getIndoorProvider

@NonNull
public LocationRequest.IndoorProvider getIndoorProvider()

Deprecated.

Indoor provider is LocationRequest.IndoorProvider.INPHONE by default and cannot be changed.

Returns:

An LocationRequest.IndoorProvider object

useBle

public Boolean useBle()

Returns true if BLE scanning is enabled to compute Indoor Positioning.

To set this value, use LocationRequest.Builder.useBle(boolean).

Returns:

Boolean.

useWifi

public Boolean useWifi()

Returns true if WiFi scanning is enabled to compute Indoor Positioning.

To set this value, use LocationRequest.Builder.useWifi(boolean).

Returns:

Boolean.

useCompass

public Boolean useCompass()

Returns true if compass is enabled to compute Indoor Positioning.

To set this value, use LocationRequest.Builder.useCompass(boolean).

Returns:

Boolean.

useGps

public Boolean useGps()

Returns true if GPS geolocation is enabled to compute Indoor Positioning.

To set this value, use LocationRequest.Builder.useGps(boolean).

Returns:

Boolean.

useGyro

public Boolean useGyro()

Returns true if the gyroscope is enabled to compute Indoor Positioning.

To set this value, use LocationRequest.Builder.useGyro(boolean).

Returns:

Boolean.

useBatterySaver

public Boolean useBatterySaver()

Returns true if Battery Saver mode is ON (stops geolocation computations after prolonged smartphone inactivity).

To set this value, use LocationRequest.Builder.useBatterySaver(Boolean).

Returns:

Boolean.

useBarometer

public Boolean useBarometer()

Returns true if the barometer should be used to compute Indoor Positioning (helps with floor changes).

To set this value, use LocationRequest.Builder.useBarometer(boolean).

Returns:

Boolean.

isIgnoreWifiThrottling

public Boolean isIgnoreWifiThrottling()

Returns true if WiFi Throttling protections should be ignored (or, in other words, if WiFi should be scanned as fast as possible).

To set this value, use LocationRequest.Builder.ignoreWifiThrottling(boolean).

Returns:

Boolean.

isPreloadInfo

public Boolean isPreloadInfo()

useLocationsCache

public Boolean useLocationsCache()

getSmallestDisplacement

public Float getSmallestDisplacement()

Gets the smallest smartphone displacement allowed between two consecutive Indoor Positions communicated via LocationListener.onLocationChanged(Location) callback.

To set this value, use LocationRequest.Builder.smallestDisplacement(float).

Returns:

Displacement in meters (float)

getMotionMode

public LocationRequest.MotionMode getMotionMode()

Gets the LocationRequest.MotionMode, which specifies how the user moves (e.g. on foot) and adapts the positioning algorithm accordingly.

To set this value, use LocationRequest.Builder.motionMode(MotionMode). Default value is DEFAULT_MOTION_MODE.

Returns:

LocationRequest.MotionMode object

useDeadReckoning

public Boolean useDeadReckoning()

Returns true if 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).

To set this value, use LocationRequest.Builder.useDeadReckoning(boolean).

Returns:

Boolean.

useForegroundService

public Boolean useForegroundService()

Returns true if Situm SDK should run infinitely even if the app goes to the background.

To set this value, use LocationRequest.Builder.useForegroundService(boolean).

Returns:

Boolean

getForegroundServiceNotification

@Nullable
public android.app.Notification getForegroundServiceNotification()

Returns the Notification that will be shown in the system's tray when the app is running as a Foreground Service.

You may set this Notification with LocationRequest.Builder.foregroundServiceNotification(Notification). The app runs as a Foreground Service if useForegroundService() is true.

Returns:

An android.app.Notification object

getForegroundServiceNotificationOptions

@Nullable
public ForegroundServiceNotificationOptions getForegroundServiceNotificationOptions()

Returns the options used to customize the Foreground Service Notification, if any.

Returns:

ForegroundServiceNotificationOptions

getOutdoorLocationOptions

@NonNull
public OutdoorLocationOptions getOutdoorLocationOptions()

Gets the OutdoorLocationOptions, which specify parameters related to the Global Mode (e.g. building detector to be used, outdoor positioning frequency configuration, etc.)

To set this value, use LocationRequest.Builder.outdoorLocationOptions(OutdoorLocationOptions).

Returns:

OutdoorLocationOptions object

getRouteAdjustment

@Nullable
public RouteAdjustment getRouteAdjustment()

useGlobalLocation

public Boolean useGlobalLocation()

Return true if Global Mode is enabled (positioning anywhere with automatic building detection). Global Mode will be enabled if no building identifier has been set using the method LocationRequest.Builder.buildingIdentifier(String).

See Also:

• LocationRequest.Builder.buildingIdentifier(String)

getBeaconFilters

public List<BeaconFilter> getBeaconFilters()

Gets the list of beacon UUIDs that will be taken into account when using BLE signals for positioning.

By default, this list is empty, although beacons with the standard Situm UUID ("73697475-6D73-6974-756D-736974756D15") will always be used for BLE-based positioning.

If you wish to use beacons with other UUIDs, configure them with LocationRequest.Builder.addBeaconFilters(List) or LocationRequest.Builder.addBeaconFilter(BeaconFilter).

Returns:

list of beacon filters

avoidDoze

public Boolean avoidDoze()

getRealtimeUpdateInterval

public LocationRequest.RealtimeUpdateInterval getRealtimeUpdateInterval()

Gets the configured LocationRequest.RealtimeUpdateInterval, which specifies the upload interval for buffered locations.

To set this value, use LocationRequest.Builder.realtimeUpdateInterval(RealtimeUpdateInterval).

Returns:

LocationRequest.RealtimeUpdateInterval object

getRealtimePersistenceInterval

@Nullable
@IntRange(from=1000L)
public Integer getRealtimePersistenceInterval()

Gets the interval used to limit locations stored locally for upload to Situm Platform.

This value does not change location computation, application callback cadence, or upload batching. It limits how frequently Indoor and Outdoor Locations can be stored locally for later upload.

Returns:

interval in milliseconds, or null when it has not been set locally

autoEnableBleDuringPositioning

public Boolean autoEnableBleDuringPositioning()

Returns true if Situm SDK is configured to re-enable Bluetooth when the user disables it from the system tray.

To set this value, use LocationRequest.Builder.autoEnableBleDuringPositioning(Boolean).

Returns:

Boolean

getDiagnosticsOptions

@NonNull
public DiagnosticsOptions getDiagnosticsOptions()

Returns the configured DiagnosticsOptions, which specifies options related to remote diagnostic and telemetry data.

Returns:

DiagnosticsOptions

getAssetTrackingOptions

@NonNull
public AssetTrackingOptions getAssetTrackingOptions()

Returns the configured AssetTrackingOptions, which specifies options related to asset tracking using BLE beacons.

Returns:

AssetTrackingOptions

toString

@NonNull
public String toString()

Overrides:

toString in class Object

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
 int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object