Class PositionManagerConfiguration

    • Constructor Detail

    • 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 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 for beacon input Default is false

        Returns:

        isCoreBluetoothEnabled value

      • getIsCoreLocationEnabled

         boolean getIsCoreLocationEnabled()

        Get isCoreLocationEnabled. Whether CoreLocation is enabled for beacon input Default is true

        Returns:

        isCoreLocationEnabled value

      • getIsCoreMotionEnabled

         boolean getIsCoreMotionEnabled()

        Get isCoreMotionEnabled. Whether CoreMotion is enabled for motion input Default is true

        Returns:

        isCoreMotionEnabled value

      • getIsFusionEnabled

         boolean getIsFusionEnabled()

        Get isFusionEnabled. Whether sensor fusion is enabled (for improved location accuracy) Default is true

        Returns:

        isFusionEnabled 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

      • getSensorSamplingPeriodInSeconds

         float getSensorSamplingPeriodInSeconds()

        Get sensorSamplingPeriodInSeconds. Sensor sampling period (in seconds) Default is 0.02

        Returns:

        sensorSamplingPeriodInSeconds 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