libbeacon/fr.maxcom.beacon.configuration/IContextConfigurator

IContextConfigurator

interface IContextConfigurator

Interface to give settings to a context holder.

Types

Link copied to clipboard
object Companion

Default values.

Functions

Link copied to clipboard
abstract fun devicesUpdateEventSlowdown(intervalMillis: Long): IContextConfigurator

Sets the minimum time that must pass since the last event before allowing another one to trigger. The default setting is DEFAULT_DEVICES_UPDATE_EVENT_SLOWDOWN_MS.

Link copied to clipboard
abstract fun lossSettings(lossSettings: LossSettings): IContextConfigurator

Sets the properties for the detection of the lost of devices. The default setting is LossSettings.DEFAULT.

Link copied to clipboard
abstract fun preventDoze(preventDoze: Boolean): IContextConfigurator

Prevents the device to enter the doze mode, when scanning is in progress. To use with caution, as it can have an impact on the power consumption. Mainly dedicated to run campaigns of tests with a not used device (screen off, no movement). The default setting is false.

Link copied to clipboard
abstract fun reminderInterval(intervalSeconds: Long): IContextConfigurator

Sets a duration to wait before to remind that a tag is still seen. The default setting is 0, meaning no reminders.

Link copied to clipboard
abstract fun rssiCalculator(rssiCalculator: IRssiCalculator): IContextConfigurator

Sets the instance of a RSSI calculator for distances. The default setting is null, meaning the rssi is used as-is.

Link copied to clipboard
abstract fun scanFrequency(scanFrequency: ScanFrequency?): IContextConfigurator

Sets the frequency mode of scanning. The default setting is ScanFrequency.RANGING.

Link copied to clipboard
abstract fun scanMode(scanMode: ScanMode): IContextConfigurator

Sets the mode of scanning. The default setting is ScanMode.BALANCED.

Link copied to clipboard
abstract fun verbose(verbose: Boolean): IContextConfigurator

Sets a verbose flag. The default setting is false.