com.kontakt.sdk.android.ble.configuration.scan

Class ScanContext.Builder

java.lang.Object

com.kontakt.sdk.android.ble.configuration.scan.ScanContext.Builder

Enclosing class:

ScanContext

public static final class ScanContext.Builder
extends java.lang.Object

Configuration builder is responsible for creating immutable configuration which acts as a parameters and callbacks supplier and thus describes desired behaviour. By default the Builder is initialized with all default parameters which do not enable any of the functionality.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ScanContext	build() Builds global scan context instance.
ScanContext.Builder	setActivityCheckConfiguration(ActivityCheckConfiguration actvitivyCheckConfiguration) Sets ActivityCheckConfiguration.
ScanContext.Builder	setEddystoneScanContext(EddystoneScanContext eddystoneScanContext) Sets EddystoneScanContext to ScanContext.
ScanContext.Builder	setForceScanConfiguration(ForceScanConfiguration forceScanConfiguration) Sets ForceScanConfiguration (ForceScanConfiguration).
ScanContext.Builder	setIBeaconScanContext(IBeaconScanContext iBeaconScanContext) Sets IBeaconScanContext to ScanContext.
ScanContext.Builder	setScanMode(int scanMode) Sets Scan Mode.
ScanContext.Builder	setScanPeriod(ScanPeriod scanPeriod) Sets ScanPeriod.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

setIBeaconScanContext

public ScanContext.Builder setIBeaconScanContext(IBeaconScanContext iBeaconScanContext)

Sets IBeaconScanContext to ScanContext. Use null for disabling ibeacon scan

Parameters:

iBeaconScanContext -

Returns:

the builder

setEddystoneScanContext

public ScanContext.Builder setEddystoneScanContext(EddystoneScanContext eddystoneScanContext)

Sets EddystoneScanContext to ScanContext. Use null for disabling eddystone scan

Parameters:

eddystoneScanContext -

Returns:

the builder

setActivityCheckConfiguration

public ScanContext.Builder setActivityCheckConfiguration(ActivityCheckConfiguration actvitivyCheckConfiguration)

Sets ActivityCheckConfiguration. By default, the removal configuration is disabled and beacons which signal's strength becomes unidentifiable remain in the delivered list. Filtering active beacons list by applying removal configuration gives more reliable relation to real beacons surrounding in particular moment. This parameter should be applied if desired before invoking startMonitoring/startRanging methods. If not set, the RemovalConfiguration with unacceptable values is applied and thus the functionality is disabled.

Parameters:

actvitivyCheckConfiguration - the activity check configuration

setScanMode

public ScanContext.Builder setScanMode(int scanMode)

Sets Scan Mode. Android L comes with functionality controlling scan performance. there are three predefined variables according to which device scan may be handled depending on user's choice. Our SDK takes advantage fo this feature for devices running on Android Lollipop and higher. For devices running on Android OS with version lower than Lollipop this parameter does not affect scan performance. You can set one of three values: ProximityManager.SCAN_MODE_BALANCED - perform Bluetooth LE scan in balanced power mode. ProximityManager.SCAN_MODE_LOW_LATENCY - scan using highest duty cycle. ProximityManager.SCAN_MODE_LOW_POWER - perform Bluetooth LE scan in low power mode.

Parameters:

scanMode - the scan mode

Returns:

the builder instance

setForceScanConfiguration

public ScanContext.Builder setForceScanConfiguration(ForceScanConfiguration forceScanConfiguration)

Sets ForceScanConfiguration (ForceScanConfiguration).

Parameters:

forceScanConfiguration - the force scan configuration

Returns:

the builder instance

setScanPeriod

public ScanContext.Builder setScanPeriod(ScanPeriod scanPeriod)

Sets ScanPeriod.

Parameters:

scanPeriod - the monitor period

Returns:

the builder instance

build

public ScanContext build()

Builds global scan context instance.

Returns:

new immutable configuration instance