com.kontakt.sdk.android.ble.configuration

Class ScanContext.Builder

java.lang.Object

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

All Implemented Interfaces:

FiltersConfigurator, GeneralConfigurator, SpacesConfigurator

Enclosing class:

ScanContext

public static final class ScanContext.Builder
extends java.lang.Object
implements GeneralConfigurator, SpacesConfigurator, FiltersConfigurator

Constructor Summary

Constructors

Constructor and Description
Builder()
Builder(ScanContext context)

Method Summary

Modifier and Type	Method and Description
GeneralConfigurator	activityCheckConfiguration(ActivityCheckConfiguration activityCheckConfiguration) Sets ActivityCheckConfiguration.
ScanContext.Builder	addObservedProfile(DeviceProfile profile)
ScanContext	build()
GeneralConfigurator	cacheFileName(java.lang.String name) Cache file name for resolved shuffled device ids from Kontakt.io Proximity REST API.
void	clearAll() Clears all currently set IBeacon and Eddystone filters;
GeneralConfigurator	deviceUpdateCallbackInterval(long intervalInMillis) The device update callback interval prevents the update from being called instantly.
FiltersConfigurator	eddystoneFilter(EddystoneFilter filter) Add single Eddystone EddystoneFilter.
FiltersConfigurator	eddystoneFilters(java.util.Collection<EddystoneFilter> filters) Add multiple Eddystone EddystoneFilter.
GeneralConfigurator	eddystoneFrameTypes(java.util.Collection<EddystoneFrameType> eddystoneFrameTypes) Gets trigger frame types.
SpacesConfigurator	eddystoneNamespace(IEddystoneNamespace namespace) Sets Eddystone namespace within which Eddystone devices are searched.
SpacesConfigurator	eddystoneNamespaces(java.util.Collection<IEddystoneNamespace> namespaces) Sets Eddystone namespaces within which Eddystone devices are searched.
GeneralConfigurator	forceScanConfiguration(ForceScanConfiguration forceScanConfiguration) Sets ForceScanConfiguration.
java.util.List<EddystoneFilter>	getEddystoneFilters() Returns currently set Eddystone filters.
java.util.Set<IEddystoneNamespace>	getEddystoneNamespaces() Returns currently set Eddystone namespaces.
java.util.List<IBeaconFilter>	getIBeaconFilters() Returns currently set iBeacon filters.
java.util.Set<IBeaconRegion>	getIBeaconRegions() Returns currently set iBeacon regions.
FiltersConfigurator	iBeaconFilter(IBeaconFilter filter) Add single IBeaconFilter.
FiltersConfigurator	iBeaconFilters(java.util.Collection<IBeaconFilter> filters) Add multiple IBeaconFilter.
SpacesConfigurator	iBeaconRegion(IBeaconRegion region) Sets IBeacon region within which IBeacon devices are searched.
SpacesConfigurator	iBeaconRegions(java.util.Collection<IBeaconRegion> regions) Sets IBeacon regions within which IBeacon devices are searched.
GeneralConfigurator	monitoringEnabled(boolean enabled) Enables or disables collecting monitoring events e.g. battery level of device.
GeneralConfigurator	monitoringSyncInterval(int intervalInSeconds) Interval between next monitoring events sync attempts in seconds.
ScanContext.Builder	observedProfiles(java.util.Set<DeviceProfile> observedProfiles)
ScanContext.Builder	removeObservedProfile(DeviceProfile profile)
GeneralConfigurator	resolveShuffledInterval(int intervalInSeconds) Interval between next shuffled beacons resolving attempts in seconds.
GeneralConfigurator	rssiCalculator(RssiCalculator rssiCalculator) Sets RssiCalculator.
GeneralConfigurator	scanMode(ScanMode scanMode) Sets ScanMode.
GeneralConfigurator	scanPeriod(ScanPeriod scanPeriod) Sets ScanPeriod.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Builder

public Builder(ScanContext context)

Method Detail

scanPeriod

public GeneralConfigurator scanPeriod(ScanPeriod scanPeriod)

Description copied from interface: GeneralConfigurator

Sets ScanPeriod. Default: ScanPeriod.RANGING

Specified by:

scanPeriod in interface GeneralConfigurator

Parameters:

scanPeriod - ScanPeriod

Returns:

GeneralConfigurator builder

scanMode

public GeneralConfigurator scanMode(ScanMode scanMode)

Description copied from interface: GeneralConfigurator

Sets ScanMode. Default: ScanMode.BALANCED

Specified by:

scanMode in interface GeneralConfigurator

Parameters:

scanMode - ScanMode

Returns:

GeneralConfigurator builder

forceScanConfiguration

public GeneralConfigurator forceScanConfiguration(ForceScanConfiguration forceScanConfiguration)

Description copied from interface: GeneralConfigurator

Sets ForceScanConfiguration. This will always be set to DISABLED for Android N and higher (https://github.com/AltBeacon/android-beacon-library/issues/418).
Default: ForceScanConfiguration.DISABLED

Specified by:

forceScanConfiguration in interface GeneralConfigurator

Parameters:

forceScanConfiguration - ForceScanConfiguration

Returns:

GeneralConfigurator builder

activityCheckConfiguration

public GeneralConfigurator activityCheckConfiguration(ActivityCheckConfiguration activityCheckConfiguration)

Description copied from interface: GeneralConfigurator

Sets ActivityCheckConfiguration. Default: ActivityCheckConfiguration.DEFAULT

Specified by:

activityCheckConfiguration in interface GeneralConfigurator

Parameters:

activityCheckConfiguration - ActivityCheckConfiguration.

Returns:

GeneralConfigurator builder.

cacheFileName

public GeneralConfigurator cacheFileName(java.lang.String name)

Description copied from interface: GeneralConfigurator

Cache file name for resolved shuffled device ids from Kontakt.io Proximity REST API. Cache file name must be unique for safe serialization between different InternalProximityManager used in the same app.

Specified by:

cacheFileName in interface GeneralConfigurator

Parameters:

name - file name

Returns:

GeneralConfigurator builder

monitoringEnabled

public GeneralConfigurator monitoringEnabled(boolean enabled)

Description copied from interface: GeneralConfigurator

Enables or disables collecting monitoring events e.g. battery level of device. Default: ENABLED.

Specified by:

monitoringEnabled in interface GeneralConfigurator

Parameters:

enabled - true or false

Returns:

GeneralConfigurator builder

monitoringSyncInterval

public GeneralConfigurator monitoringSyncInterval(int intervalInSeconds)

Description copied from interface: GeneralConfigurator

Interval between next monitoring events sync attempts in seconds. Must be greater than 0. Default: 10 seconds.

Specified by:

monitoringSyncInterval in interface GeneralConfigurator

Parameters:

intervalInSeconds - interval in seconds

Returns:

GeneralConfigurator builder

resolveShuffledInterval

public GeneralConfigurator resolveShuffledInterval(int intervalInSeconds)

Description copied from interface: GeneralConfigurator

Interval between next shuffled beacons resolving attempts in seconds. Must be greater than 0. Default: 3 seconds.

Specified by:

resolveShuffledInterval in interface GeneralConfigurator

Parameters:

intervalInSeconds - interval in seconds

Returns:

GeneralConfigurator builder

deviceUpdateCallbackInterval

public GeneralConfigurator deviceUpdateCallbackInterval(long intervalInMillis)

Description copied from interface: GeneralConfigurator

The device update callback interval prevents the update from being called instantly.
Once the Android device enters a space with many BLE devices the update event starts to be called with instantly growing number of updated BLE devices.
This may cause interruptions when interacting with UI. The device update callback interval option causes the update callback to be invoked no more often than given interval. Default: 3000 milliseconds.

Specified by:

deviceUpdateCallbackInterval in interface GeneralConfigurator

Parameters:

intervalInMillis - Interval in milliseconds.

Returns:

GeneralConfigurator builder

rssiCalculator

public GeneralConfigurator rssiCalculator(RssiCalculator rssiCalculator)

Description copied from interface: GeneralConfigurator

Sets RssiCalculator.

Specified by:

rssiCalculator in interface GeneralConfigurator

Parameters:

rssiCalculator - RSSI calculator instance.

Returns:

GeneralConfigurator builder

eddystoneFrameTypes

public GeneralConfigurator eddystoneFrameTypes(java.util.Collection<EddystoneFrameType> eddystoneFrameTypes)

Description copied from interface: GeneralConfigurator

Gets trigger frame types. The trigger frame types specify with which frame types received at least the Eddystone device should be notified.
If not set Eddystone device will be notified as soon as any frame will be scanned (UID, URL or TLM).

Specified by:

eddystoneFrameTypes in interface GeneralConfigurator

Parameters:

eddystoneFrameTypes - eddystone format frame types

Returns:

GeneralConfigurator builder

iBeaconRegion

public SpacesConfigurator iBeaconRegion(IBeaconRegion region)

Description copied from interface: SpacesConfigurator

Sets IBeacon region within which IBeacon devices are searched.

Specified by:

iBeaconRegion in interface SpacesConfigurator

Parameters:

region - the IBeacon region

Returns:

ProximityManagerSpaces builder

iBeaconRegions

public SpacesConfigurator iBeaconRegions(java.util.Collection<IBeaconRegion> regions)

Description copied from interface: SpacesConfigurator

Sets IBeacon regions within which IBeacon devices are searched.

Specified by:

iBeaconRegions in interface SpacesConfigurator

Parameters:

regions - the IBeacon regions

Returns:

ProximityManagerSpaces builder

eddystoneNamespace

public SpacesConfigurator eddystoneNamespace(IEddystoneNamespace namespace)

Description copied from interface: SpacesConfigurator

Sets Eddystone namespace within which Eddystone devices are searched.

Specified by:

eddystoneNamespace in interface SpacesConfigurator

Parameters:

namespace - the eddystone namespaces

Returns:

ProximityManagerSpaces builder

eddystoneNamespaces

public SpacesConfigurator eddystoneNamespaces(java.util.Collection<IEddystoneNamespace> namespaces)

Description copied from interface: SpacesConfigurator

Sets Eddystone namespaces within which Eddystone devices are searched.

Specified by:

eddystoneNamespaces in interface SpacesConfigurator

Parameters:

namespaces - the eddystone namespaces

Returns:

ProximityManagerSpaces builder

getIBeaconRegions

public java.util.Set<IBeaconRegion> getIBeaconRegions()

Description copied from interface: SpacesConfigurator

Returns currently set iBeacon regions.

Specified by:

getIBeaconRegions in interface SpacesConfigurator

Returns:

unmodifiable set of iBeacon regions.

getEddystoneNamespaces

public java.util.Set<IEddystoneNamespace> getEddystoneNamespaces()

Description copied from interface: SpacesConfigurator

Returns currently set Eddystone namespaces.

Specified by:

getEddystoneNamespaces in interface SpacesConfigurator

Returns:

unmodifiable set of Eddystone namespaces.

iBeaconFilter

public FiltersConfigurator iBeaconFilter(IBeaconFilter filter)

Description copied from interface: FiltersConfigurator

Add single IBeaconFilter.
See IBeaconFilters for predefined filters.

Specified by:

iBeaconFilter in interface FiltersConfigurator

Parameters:

filter - IBeacon filter to add

Returns:

ProximityManagerFilters builder

iBeaconFilters

public FiltersConfigurator iBeaconFilters(java.util.Collection<IBeaconFilter> filters)

Description copied from interface: FiltersConfigurator

Add multiple IBeaconFilter.
See IBeaconFilters for predefined filters.

Specified by:

iBeaconFilters in interface FiltersConfigurator

Parameters:

filters - IBeacon filters to add

Returns:

void builder

eddystoneFilter

public FiltersConfigurator eddystoneFilter(EddystoneFilter filter)

Description copied from interface: FiltersConfigurator

Add single Eddystone EddystoneFilter.
See EddystoneFilters for predefined filters.

Specified by:

eddystoneFilter in interface FiltersConfigurator

Parameters:

filter - Eddystone UID filter to add.

Returns:

void builder

eddystoneFilters

public FiltersConfigurator eddystoneFilters(java.util.Collection<EddystoneFilter> filters)

Description copied from interface: FiltersConfigurator

Add multiple Eddystone EddystoneFilter.
See EddystoneFilters for predefined filters.

Specified by:

eddystoneFilters in interface FiltersConfigurator

Parameters:

filters - Eddystone UID filters to add.

Returns:

void builder

getIBeaconFilters

public java.util.List<IBeaconFilter> getIBeaconFilters()

Description copied from interface: FiltersConfigurator

Returns currently set iBeacon filters.

Specified by:

getIBeaconFilters in interface FiltersConfigurator

Returns:

unmodifiable list of iBeacon filters

getEddystoneFilters

public java.util.List<EddystoneFilter> getEddystoneFilters()

Description copied from interface: FiltersConfigurator

Returns currently set Eddystone filters.

Specified by:

getEddystoneFilters in interface FiltersConfigurator

Returns:

unmodifiable list of Eddystone filters

clearAll

public void clearAll()

Description copied from interface: FiltersConfigurator

Clears all currently set IBeacon and Eddystone filters;

Specified by:

clearAll in interface FiltersConfigurator

observedProfiles

public ScanContext.Builder observedProfiles(java.util.Set<DeviceProfile> observedProfiles)

addObservedProfile

public ScanContext.Builder addObservedProfile(DeviceProfile profile)

removeObservedProfile

public ScanContext.Builder removeObservedProfile(DeviceProfile profile)

build

public ScanContext build()