com.kontakt.sdk.android.ble.manager.configuration

Class Configuration

java.lang.Object

com.kontakt.sdk.android.ble.manager.configuration.Configuration

All Implemented Interfaces:

FiltersConfigurator, GeneralConfigurator, SpacesConfigurator

public class Configuration
extends java.lang.Object
implements GeneralConfigurator, SpacesConfigurator, FiltersConfigurator

This class is responsible for ranging/monitoring configuration.

Constructor Summary

Constructors

Constructor and Description
Configuration(ScanContext scanContext, InternalProximityManagerConfiguration proximityManagerConfiguration)

Method Summary

Modifier and Type	Method and Description
GeneralConfigurator	activityCheckConfiguration(ActivityCheckConfiguration activityCheckConfiguration) Sets ActivityCheckConfiguration.
GeneralConfigurator	cacheFileName(java.lang.String name) Cache file name for resolved shuffled device ids from Kontakt.io Proximity REST API.
InternalProximityManagerConfiguration	createKontaktManagerConfiguration()
ScanContext	createScanContext()
GeneralConfigurator	deviceUpdateCallbackInterval(int intervalInMillis) The device update callback interval prevents the update from being called instantly.
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.
FiltersConfigurator	eddystoneTlmFilter(TLMFilter filter) Add single Eddystone TLMFilter.
FiltersConfigurator	eddystoneTlmFilters(java.util.Collection<TLMFilter> filters) Add multiple Eddystone TLMFilter.
FiltersConfigurator	eddystoneUidFilter(UIDFilter filter) Add single Eddystone UIDFilter.
FiltersConfigurator	eddystoneUidFilters(java.util.Collection<UIDFilter> filters) Add multiple Eddystone UIDFilter.
FiltersConfigurator	eddystoneUrlFilter(URLFilter filter) Add single Eddystone URLFilter.
FiltersConfigurator	eddystoneUrlFilters(java.util.Collection<URLFilter> filters) Add multiple Eddystone URLFilter.
GeneralConfigurator	forceScanConfiguration(ForceScanConfiguration forceScanConfiguration) Sets ForceScanConfiguration.
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.
GeneralConfigurator	monitoringSyncInterval(int intervalInSeconds) Interval between next monitoring events sync attempts in seconds.
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

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

Constructor Detail

Configuration

public Configuration(ScanContext scanContext,
                     InternalProximityManagerConfiguration proximityManagerConfiguration)

Method Detail

createScanContext

public ScanContext createScanContext()

createKontaktManagerConfiguration

public InternalProximityManagerConfiguration createKontaktManagerConfiguration()

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. 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.MINIMAL

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(int 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 causes interruptions when interacting with UI. The device update callback interval causes the update event to be called periodically. Default: ScanContext.DEFAULT_DEVICES_UPDATE_CALLBACK_INTERVAL 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. The required frame type is EddystoneFrameType.UID.

The all possible combinations include:
Eddystone device with EddystoneFrameType.UID,
Eddystone device with EddystoneFrameType.UID and EddystoneFrameType.URL,
Eddystone device with EddystoneFrameType.UID and EddystoneFrameType.TLM,
Eddystone device with EddystoneFrameType.UID, EddystoneFrameType.URL and EddystoneFrameType.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

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

eddystoneUidFilter

public FiltersConfigurator eddystoneUidFilter(UIDFilter filter)

Description copied from interface: FiltersConfigurator

Add single Eddystone UIDFilter.
See EddystoneFilters for predefined filters.

Specified by:

eddystoneUidFilter in interface FiltersConfigurator

Parameters:

filter - Eddystone UID filter to add.

Returns:

void builder

eddystoneUidFilters

public FiltersConfigurator eddystoneUidFilters(java.util.Collection<UIDFilter> filters)

Description copied from interface: FiltersConfigurator

Add multiple Eddystone UIDFilter.
See EddystoneFilters for predefined filters.

Specified by:

eddystoneUidFilters in interface FiltersConfigurator

Parameters:

filters - Eddystone UID filters to add.

Returns:

void builder

eddystoneUrlFilter

public FiltersConfigurator eddystoneUrlFilter(URLFilter filter)

Description copied from interface: FiltersConfigurator

Add single Eddystone URLFilter.
See EddystoneFilters for predefined filters.

Specified by:

eddystoneUrlFilter in interface FiltersConfigurator

Parameters:

filter - Eddystone URL filter to add.

Returns:

void builder

eddystoneUrlFilters

public FiltersConfigurator eddystoneUrlFilters(java.util.Collection<URLFilter> filters)

Description copied from interface: FiltersConfigurator

Add multiple Eddystone URLFilter.
See EddystoneFilters for predefined filters.

Specified by:

eddystoneUrlFilters in interface FiltersConfigurator

Parameters:

filters - Eddystone URL filters to add.

Returns:

void builder

eddystoneTlmFilter

public FiltersConfigurator eddystoneTlmFilter(TLMFilter filter)

Description copied from interface: FiltersConfigurator

Add single Eddystone TLMFilter.
See EddystoneFilters for predefined filters.

Specified by:

eddystoneTlmFilter in interface FiltersConfigurator

Parameters:

filter - Eddystone TLM filters to add.

Returns:

void builder

eddystoneTlmFilters

public FiltersConfigurator eddystoneTlmFilters(java.util.Collection<TLMFilter> filters)

Description copied from interface: FiltersConfigurator

Add multiple Eddystone TLMFilter.
See EddystoneFilters for predefined filters.

Specified by:

eddystoneTlmFilters in interface FiltersConfigurator

Parameters:

filters - Eddystone TLM filters to add.

Returns:

void builder