Class GeofenceManagerConfiguration

    • Constructor Detail

    • Method Detail

      • getBetweenScanPeriodBackground

         int getBetweenScanPeriodBackground()

        Get betweenScanPeriodBackground. Scanning period while the app is in the background Default is 300000

        Returns:

        betweenScanPeriodBackground value

      • getBetweenScanPeriodForeground

         int getBetweenScanPeriodForeground()

        Get betweenScanPeriodForeground. Scanning period while the app is in the foreground Default is 0

        Returns:

        betweenScanPeriodForeground value

      • getGeofenceRecheckingPeriodInSeconds

         float getGeofenceRecheckingPeriodInSeconds()

        Get geofenceRecheckingPeriodInSeconds. Period of rechecking geofences in seconds Default is 60.0

        Returns:

        geofenceRecheckingPeriodInSeconds value

      • getGeofenceWindowDurationInSeconds

         float getGeofenceWindowDurationInSeconds()

        Get geofenceWindowDurationInSeconds. How long an entry signal should be considered when determining building entry Default is 10.0

        Returns:

        geofenceWindowDurationInSeconds value

      • getGeofencesToRegisterMaxCountAndroid

         int getGeofencesToRegisterMaxCountAndroid()

        Get geofencesToRegisterMaxCountAndroid. The maximum number of geofences to register with native services (Android only) Default is 100

        Returns:

        geofencesToRegisterMaxCountAndroid value

      • getGeofencesToRegisterMaxDistanceInMeters

         float getGeofencesToRegisterMaxDistanceInMeters()

        Get geofencesToRegisterMaxDistanceInMeters. The maximum distance to current location of the geofences that are selected to be registered with native geofencing services Default is 50000.0

        Returns:

        geofencesToRegisterMaxDistanceInMeters value

      • getGlobalGeofenceDistanceToleranceForEnter

         float getGlobalGeofenceDistanceToleranceForEnter()

        Get globalGeofenceDistanceToleranceForEnter. Geofence is expanded / shrunk by X percentage (of the geofence's approximate radius) for detecting Enter Default is 1.5

        Returns:

        globalGeofenceDistanceToleranceForEnter value

      • getGlobalGeofenceDistanceToleranceForExit

         float getGlobalGeofenceDistanceToleranceForExit()

        Get globalGeofenceDistanceToleranceForExit. Geofence is expanded / shrunk by X percentage (of the geofence's approximate radius) for detecting Exit Default is 3.0

        Returns:

        globalGeofenceDistanceToleranceForExit value

      • getGlobalGeofenceIgnorePeriodSinceLastTriggerInSeconds

         float getGlobalGeofenceIgnorePeriodSinceLastTriggerInSeconds()

        Get globalGeofenceIgnorePeriodSinceLastTriggerInSeconds. Geofences that have a state change within the value of this setting will not fire an event. In seconds Default is 30.0

        Returns:

        globalGeofenceIgnorePeriodSinceLastTriggerInSeconds value

      • getIsGlobalGeofencingEnabled

         boolean getIsGlobalGeofencingEnabled()

        Get isGlobalGeofencingEnabled. Enable/Disable golbal geofences Default is true

        Returns:

        isGlobalGeofencingEnabled value

      • getIsGlobalGeofencingNativeOnlyAndroid

         boolean getIsGlobalGeofencingNativeOnlyAndroid()

        Get isGlobalGeofencingNativeOnlyAndroid. If this is true, then global geofencing logic relies only on native geofencing (for Android) Default is true

        Returns:

        isGlobalGeofencingNativeOnlyAndroid value

      • getIsLevelGeofencingEnabled

         boolean getIsLevelGeofencingEnabled()

        Get isLevelGeofencingEnabled. Enable/Disable level geofences Default is true

        Returns:

        isLevelGeofencingEnabled value

      • getLevelGeofenceDistanceToleranceForEnter

         float getLevelGeofenceDistanceToleranceForEnter()

        Get levelGeofenceDistanceToleranceForEnter. Geofence is expanded / shrunk by X percentage (of the geofence's approximate radius) for detecting Enter Default is 0.0

        Returns:

        levelGeofenceDistanceToleranceForEnter value

      • getLevelGeofenceDistanceToleranceForExit

         float getLevelGeofenceDistanceToleranceForExit()

        Get levelGeofenceDistanceToleranceForExit. Geofence is expanded / shrunk by X percentage (of the geofence's approximate radius) for detecting Exit Default is 0.0

        Returns:

        levelGeofenceDistanceToleranceForExit value

      • getLevelGeofenceIgnorePeriodSinceLastTriggerInSeconds

         float getLevelGeofenceIgnorePeriodSinceLastTriggerInSeconds()

        Get levelGeofenceIgnorePeriodSinceLastTriggerInSeconds. Geofences that have a state change within the value of this setting will not fire an event. In seconds Default is 30.0

        Returns:

        levelGeofenceIgnorePeriodSinceLastTriggerInSeconds value

      • getLocationWorstAccuracyAccepted

         float getLocationWorstAccuracyAccepted()

        Get locationWorstAccuracyAccepted. Location updates with accuracy worse than this value will be ignored (in meters) Default is 1000.0

        Returns:

        locationWorstAccuracyAccepted value

      • getRegionTimeoutInterval

         float getRegionTimeoutInterval()

        Get regionTimeoutInterval. Time in seconds since last detected inside, after which a exit event is considered Default is 300.0

        Returns:

        regionTimeoutInterval value

      • getScanPeriodBackground

         int getScanPeriodBackground()

        Get scanPeriodBackground. Scanning period while the app is in the background Default is 10000

        Returns:

        scanPeriodBackground value

      • getScanPeriodForeground

         int getScanPeriodForeground()

        Get scanPeriodForeground. Scanning period while the app is in the foreground Default is 1100

        Returns:

        scanPeriodForeground value

      • getShouldUploadGlobalGeofenceStateUpdates

         boolean getShouldUploadGlobalGeofenceStateUpdates()

        Get shouldUploadGlobalGeofenceStateUpdates. Whether geofence state updates should be uploaded Default is false

        Returns:

        shouldUploadGlobalGeofenceStateUpdates value

      • getShouldUploadLevelGeofenceStateUpdates

         boolean getShouldUploadLevelGeofenceStateUpdates()

        Get shouldUploadLevelGeofenceStateUpdates. Whether geofence state updates should be uploaded Default is false

        Returns:

        shouldUploadLevelGeofenceStateUpdates value

      • getSignificantGPSChangeThresholdInMeters

         float getSignificantGPSChangeThresholdInMeters()

        Get significantGPSChangeThresholdInMeters. How much distance in meters is considered a significant change of GPS Default is 1000.0

        Returns:

        significantGPSChangeThresholdInMeters value