Class PositionManagerConfiguration
-
- All Implemented Interfaces:
public class PositionManagerConfiguration extends ConfigurationSection
-
-
Method Summary
Modifier and Type Method Description int
getActivityType()
Get activityType. int
getBeaconPowerLevel()
Get beaconPowerLevel. float
getBeaconSilenceTimeInSeconds()
Get beaconSilenceTimeInSeconds. float
getCompassHeadingAccuracy()
Get compassHeadingAccuracy. int
getGpsAccuracyModeInBackground()
Get gpsAccuracyModeInBackground. int
getGpsAccuracyModeInForeground()
Get gpsAccuracyModeInForeground. float
getGpsDistanceFilter()
Get gpsDistanceFilter. float
getGpsFastestUpdateIntervalInSecondsInBackground()
Get gpsFastestUpdateIntervalInSecondsInBackground. float
getGpsFastestUpdateIntervalInSecondsInForeground()
Get gpsFastestUpdateIntervalInSecondsInForeground. float
getGpsSilenceTimeInSeconds()
Get gpsSilenceTimeInSeconds. float
getGpsUpdateIntervalInSecondsInBackground()
Get gpsUpdateIntervalInSecondsInBackground. float
getGpsUpdateIntervalInSecondsInForeground()
Get gpsUpdateIntervalInSecondsInForeground. float
getHeadingOffset()
Get headingOffset. boolean
getIsBackgroundPositioningEnabled()
Get isBackgroundPositioningEnabled. boolean
getIsCompassEnabled()
Get isCompassEnabled. boolean
getIsCoreBluetoothEnabled()
Get isCoreBluetoothEnabled. boolean
getIsCoreLocationEnabled()
Get isCoreLocationEnabled. boolean
getIsCoreMotionEnabled()
Get isCoreMotionEnabled. boolean
getIsGpsEnabled()
Get isGpsEnabled. boolean
getIsGpsTrackingEnabled()
Get isGpsTrackingEnabled. boolean
getIsGpsTrackingEnabledInBackground()
Get isGpsTrackingEnabledInBackground. boolean
getIsGpsTrackingEnabledInForeground()
Get isGpsTrackingEnabledInForeground. float
getMagneticDeclination()
Get magneticDeclination. int
getOutdoorBuildingInternalIdentifier()
Get outdoorBuildingInternalIdentifier. int
getOutdoorFacilityInternalIdentifier()
Get outdoorFacilityInternalIdentifier. int
getOutdoorLevelIndex()
Get outdoorLevelIndex. boolean
getShouldAllowLandscapeDeviceOrientations()
Get shouldAllowLandscapeDeviceOrientations. boolean
getShouldEnablePositioningInBackground()
Get shouldEnablePositioningInBackground. boolean
getShouldRestartBleWhenCorrupted()
Get shouldRestartBleWhenCorrupted. float
getThresholdForFadingPositionInSeconds()
Get thresholdForFadingPositionInSeconds. float
getThresholdForInvalidatingPosition()
Get thresholdForInvalidatingPosition. float
getThresholdForLosingPositionInSeconds()
Get thresholdForLosingPositionInSeconds. boolean
getUseBuildingGeometriesAsOutdoorObstacles()
Get useBuildingGeometriesAsOutdoorObstacles. -
-
Method Detail
-
getActivityType
int getActivityType()
Get activityType. Preferred activity type for OS location services Default is 2
- Returns:
activityType value
-
getBeaconPowerLevel
int getBeaconPowerLevel()
Get beaconPowerLevel. Configured Bluetooth beacon transmission power level (between 1-9) Default is 4
- Returns:
beaconPowerLevel value
-
getBeaconSilenceTimeInSeconds
float getBeaconSilenceTimeInSeconds()
Get beaconSilenceTimeInSeconds. Time to spend in beacon silence before stopping positioning (in seconds) Default is 60.0
- Returns:
beaconSilenceTimeInSeconds value
-
getCompassHeadingAccuracy
float getCompassHeadingAccuracy()
Get compassHeadingAccuracy. Compass heading accuracy (in radians). It corresponds to the standard deviation of the spread, so this will be visualized as an arc twice the size of this value. Default is 1.25
- Returns:
compassHeadingAccuracy value
-
getGpsAccuracyModeInBackground
int getGpsAccuracyModeInBackground()
Get gpsAccuracyModeInBackground. Preferred GPS accuracy in app background state Default is 4
- Returns:
gpsAccuracyModeInBackground value
-
getGpsAccuracyModeInForeground
int getGpsAccuracyModeInForeground()
Get gpsAccuracyModeInForeground. Preferred GPS accuracy in app foreground state Default is 2
- Returns:
gpsAccuracyModeInForeground value
-
getGpsDistanceFilter
float getGpsDistanceFilter()
Get gpsDistanceFilter. (iOS only) Distance to be covered before triggering a GPS update (in meters) Default is -1.0
- Returns:
gpsDistanceFilter value
-
getGpsFastestUpdateIntervalInSecondsInBackground
float getGpsFastestUpdateIntervalInSecondsInBackground()
Get gpsFastestUpdateIntervalInSecondsInBackground. Fastest GPS location update interval in app background state (in seconds) Default is 2.0
- Returns:
gpsFastestUpdateIntervalInSecondsInBackground value
-
getGpsFastestUpdateIntervalInSecondsInForeground
float getGpsFastestUpdateIntervalInSecondsInForeground()
Get gpsFastestUpdateIntervalInSecondsInForeground. Fastest GPS location update interval in app foreground state (in seconds) Default is 1.0
- Returns:
gpsFastestUpdateIntervalInSecondsInForeground value
-
getGpsSilenceTimeInSeconds
float getGpsSilenceTimeInSeconds()
Get gpsSilenceTimeInSeconds. Time to spend in GPS silence before stopping positioning (in seconds) Default is 120.0
- Returns:
gpsSilenceTimeInSeconds value
-
getGpsUpdateIntervalInSecondsInBackground
float getGpsUpdateIntervalInSecondsInBackground()
Get gpsUpdateIntervalInSecondsInBackground. Typical GPS location update interval in app background state (in seconds) Default is 6.0
- Returns:
gpsUpdateIntervalInSecondsInBackground value
-
getGpsUpdateIntervalInSecondsInForeground
float getGpsUpdateIntervalInSecondsInForeground()
Get gpsUpdateIntervalInSecondsInForeground. Typical GPS location update interval in app foreground state (in seconds) Default is 3.0
- Returns:
gpsUpdateIntervalInSecondsInForeground value
-
getHeadingOffset
float getHeadingOffset()
Get headingOffset. Heading offset of the map relative to true north in degrees Default is -999999.0
- Returns:
headingOffset value
-
getIsBackgroundPositioningEnabled
boolean getIsBackgroundPositioningEnabled()
Get isBackgroundPositioningEnabled. Whether beacon-based positioning is enabled in the app background state Default is false
- Returns:
isBackgroundPositioningEnabled value
-
getIsCompassEnabled
boolean getIsCompassEnabled()
Get isCompassEnabled. Whether compass heading should be shown before high accuracy heading is available. It is also advised to set `magneticDeclination` parameter for improved compass heading accuracy. Default is true
- Returns:
isCompassEnabled value
-
getIsCoreBluetoothEnabled
boolean getIsCoreBluetoothEnabled()
Get isCoreBluetoothEnabled. Whether CoreBluetooth is enabled Default is false
- Returns:
isCoreBluetoothEnabled value
-
getIsCoreLocationEnabled
boolean getIsCoreLocationEnabled()
Get isCoreLocationEnabled. Whether CoreLocation is enabled for location (beacons or GPS) input Default is true
- Returns:
isCoreLocationEnabled value
-
getIsCoreMotionEnabled
boolean getIsCoreMotionEnabled()
Get isCoreMotionEnabled. Whether CoreMotion is enabled for motion sensors input Default is true
- Returns:
isCoreMotionEnabled value
-
getIsGpsEnabled
boolean getIsGpsEnabled()
Get isGpsEnabled. Whether GPS is enabled in the app foreground state Default is true
- Returns:
isGpsEnabled value
-
getIsGpsTrackingEnabled
boolean getIsGpsTrackingEnabled()
Get isGpsTrackingEnabled. Whether GPS is enabled in the app foreground state Default is true
- Returns:
isGpsTrackingEnabled value
-
getIsGpsTrackingEnabledInBackground
boolean getIsGpsTrackingEnabledInBackground()
Get isGpsTrackingEnabledInBackground. Whether GPS is enabled in the app background state Default is false
- Returns:
isGpsTrackingEnabledInBackground value
-
getIsGpsTrackingEnabledInForeground
boolean getIsGpsTrackingEnabledInForeground()
Get isGpsTrackingEnabledInForeground. Whether GPS is enabled in the app foreground state Default is true
- Returns:
isGpsTrackingEnabledInForeground value
-
getMagneticDeclination
float getMagneticDeclination()
Get magneticDeclination. Magnetic declination of the site (in degrees). Positive values mean Easterly declination. This value is used to improve compass heading accuracy. Default is 0.0
- Returns:
magneticDeclination value
-
getOutdoorBuildingInternalIdentifier
int getOutdoorBuildingInternalIdentifier()
Get outdoorBuildingInternalIdentifier. Internal identifier of the building assigned to outdoor locations Default is -999999
- Returns:
outdoorBuildingInternalIdentifier value
-
getOutdoorFacilityInternalIdentifier
int getOutdoorFacilityInternalIdentifier()
Get outdoorFacilityInternalIdentifier. Internal identifier of the building assigned to outdoor locations Default is -999999
- Returns:
outdoorFacilityInternalIdentifier value
-
getOutdoorLevelIndex
int getOutdoorLevelIndex()
Get outdoorLevelIndex. Index of the level assigned to outdoor locations, if outdoor building assignment is enabled Default is 0
- Returns:
outdoorLevelIndex value
-
getShouldAllowLandscapeDeviceOrientations
boolean getShouldAllowLandscapeDeviceOrientations()
Get shouldAllowLandscapeDeviceOrientations. Whether to allow and consider landscape orientations for heading calculation. Disabling this will assume portrait orientation always. Default is false
- Returns:
shouldAllowLandscapeDeviceOrientations value
-
getShouldEnablePositioningInBackground
boolean getShouldEnablePositioningInBackground()
Get shouldEnablePositioningInBackground. Whether beacon-based positioning is enabled in the app background state Default is false
- Returns:
shouldEnablePositioningInBackground value
-
getShouldRestartBleWhenCorrupted
boolean getShouldRestartBleWhenCorrupted()
Get shouldRestartBleWhenCorrupted. Whether to try restarting BLE automatically, when BLE stack gets corrupted. Default is false
- Returns:
shouldRestartBleWhenCorrupted value
-
getThresholdForFadingPositionInSeconds
float getThresholdForFadingPositionInSeconds()
Get thresholdForFadingPositionInSeconds. Time to spend in beacon/GPS silence before fading location (in seconds) Default is 5.0
- Returns:
thresholdForFadingPositionInSeconds value
-
getThresholdForInvalidatingPosition
float getThresholdForInvalidatingPosition()
Get thresholdForInvalidatingPosition. Time required to pass after last valid location to produce an invalid location output (in seconds) Default is 5.0
- Returns:
thresholdForInvalidatingPosition value
-
getThresholdForLosingPositionInSeconds
float getThresholdForLosingPositionInSeconds()
Get thresholdForLosingPositionInSeconds. Time to spend in beacon/GPS silence before losing location (in seconds) Default is 30.0
- Returns:
thresholdForLosingPositionInSeconds value
-
getUseBuildingGeometriesAsOutdoorObstacles
boolean getUseBuildingGeometriesAsOutdoorObstacles()
Get useBuildingGeometriesAsOutdoorObstacles. Whether to use building geometries as obstacles to be avoided by the blue dot when outdoors Default is false
- Returns:
useBuildingGeometriesAsOutdoorObstacles value
-
-
-
-