
public final class Settings

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`Settings.Companion`
`public class`	`Settings.Defaults`
`public final class`	`Settings.Builder`
`public final class`	`Settings.ScanPeriods`
`public interface`	`Settings.ScanStrategy`
`public final class`	`Settings.JobServiceScanStrategy`
`public final class`	`Settings.BackgroundServiceScanStrategy`
`public final class`	`Settings.ForegroundServiceScanStrategy`
`public final class`	`Settings.IntentScanStrategy`
`public final class`	`Settings.DisabledBeaconSimulator`

Field Summary

Fields
Modifier and Type	Field	Description
`private final Boolean`	`debug`
`private final Boolean`	`regionStatePersistenceEnabled`
`private final Boolean`	`hardwareEqualityEnforced`
`private final Settings.ScanPeriods`	`scanPeriods`
`private final Integer`	`regionExitPeriodMillis`
`private final Boolean`	`useTrackingCache`
`private final Integer`	`maxTrackingAgeMillis`
`private final Boolean`	`manifestCheckingDisabled`
`private final BeaconSimulator`	`beaconSimulator`
`private final Class<?>`	`rssiFilterClass`
`private final String`	`distanceModelUpdateUrl`
`private final DistanceCalculatorFactory`	`distanceCalculatorFactory`
`private final Settings.ScanStrategy`	`scanStrategy`
`private final Boolean`	`longScanForcingEnabled`

Constructor Summary

Constructors
Constructor	Description
`Settings(Boolean debug, Boolean regionStatePersistenceEnabled, Boolean hardwareEqualityEnforced, Settings.ScanPeriods scanPeriods, Integer regionExitPeriodMillis, Boolean useTrackingCache, Integer maxTrackingAgeMillis, Boolean manifestCheckingDisabled, BeaconSimulator beaconSimulator, Class<?> rssiFilterClass, String distanceModelUpdateUrl, DistanceCalculatorFactory distanceCalculatorFactory, Settings.ScanStrategy scanStrategy, Boolean longScanForcingEnabled)`

Method Summary

Modifier and Type	Method	Description
`final Boolean`	`getDebug()`	Sets the log level on the library to debug (true) or info (false) Default is false
`final Boolean`	`getRegionStatePersistenceEnabled()`	Determines if monitored regions are persisted to app shared preferences so if the app restarts, the same regions are monitored.
`final Boolean`	`getHardwareEqualityEnforced()`	Determines if two beacons with the same identifiers but with different hardware MAC addresses are treated as different beacons.
`final Settings.ScanPeriods`	`getScanPeriods()`
`final Integer`	`getRegionExitPeriodMillis()`	How many milliseconds to wait after seeing the last beacon in a region before marking it as exited.
`final Boolean`	`getUseTrackingCache()`
`final Integer`	`getMaxTrackingAgeMillis()`
`final Boolean`	`getManifestCheckingDisabled()`
`final BeaconSimulator`	`getBeaconSimulator()`
`final Class<?>`	`getRssiFilterClass()`
`final String`	`getDistanceModelUpdateUrl()`
`final DistanceCalculatorFactory`	`getDistanceCalculatorFactory()`
`final Settings.ScanStrategy`	`getScanStrategy()`
`final Boolean`	`getLongScanForcingEnabled()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Settings

Settings(Boolean debug, Boolean regionStatePersistenceEnabled, Boolean hardwareEqualityEnforced, Settings.ScanPeriods scanPeriods, Integer regionExitPeriodMillis, Boolean useTrackingCache, Integer maxTrackingAgeMillis, Boolean manifestCheckingDisabled, BeaconSimulator beaconSimulator, Class<?> rssiFilterClass, String distanceModelUpdateUrl, DistanceCalculatorFactory distanceCalculatorFactory, Settings.ScanStrategy scanStrategy, Boolean longScanForcingEnabled)

Method Detail
- getDebug
```
 final Boolean getDebug()
```
  Sets the log level on the library to debug (true) or info (false) Default is false
- getRegionStatePersistenceEnabled
```
 final Boolean getRegionStatePersistenceEnabled()
```
  Determines if monitored regions are persisted to app shared preferences so if the app restarts, the same regions are monitored. Default is true
- getHardwareEqualityEnforced
```
 final Boolean getHardwareEqualityEnforced()
```
  Determines if two beacons with the same identifiers but with different hardware MAC addresses are treated as different beacons. Default is false
- getScanPeriods
```
 final Settings.ScanPeriods getScanPeriods()
```
- getRegionExitPeriodMillis
```
 final Integer getRegionExitPeriodMillis()
```
  How many milliseconds to wait after seeing the last beacon in a region before marking it as exited.
- getUseTrackingCache
```
 final Boolean getUseTrackingCache()
```
- getMaxTrackingAgeMillis
```
 final Integer getMaxTrackingAgeMillis()
```
- getManifestCheckingDisabled
```
 final Boolean getManifestCheckingDisabled()
```
- getBeaconSimulator
```
 final BeaconSimulator getBeaconSimulator()
```
- getRssiFilterClass
```
 final Class<?> getRssiFilterClass()
```
- getDistanceModelUpdateUrl
```
 final String getDistanceModelUpdateUrl()
```
- getDistanceCalculatorFactory
```
 final DistanceCalculatorFactory getDistanceCalculatorFactory()
```
- getScanStrategy
```
 final Settings.ScanStrategy getScanStrategy()
```
- getLongScanForcingEnabled
```
 final Boolean getLongScanForcingEnabled()
```

Class Settings

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Settings

Method Detail

getDebug

getRegionStatePersistenceEnabled

getHardwareEqualityEnforced

getScanPeriods

getRegionExitPeriodMillis

getUseTrackingCache

getMaxTrackingAgeMillis

getManifestCheckingDisabled

getBeaconSimulator

getRssiFilterClass

getDistanceModelUpdateUrl

getDistanceCalculatorFactory

getScanStrategy

getLongScanForcingEnabled