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

Class EddystoneScanContext

java.lang.Object

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

public final class EddystoneScanContext
extends java.lang.Object

Eddystone scan context provides describes criteria according to which the Android device scans Eddystone devices. The context provides plenty of customizations including: searching by namespaces, filters for UID, URL and TLM advertising packets, selection of desired event types (for more information see EventType), rssi signal manipulation, sorting devices by their distance from Android device, notifying events with updated device with specific interval

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EddystoneScanContext.Builder Eddystone Scan context Builder.

Field Summary

Fields

Modifier and Type	Field and Description
static EddystoneScanContext	DEFAULT DEFAULT EddystoneScanContext provides .

Method Summary

Modifier and Type	Method and Description
long	getDevicesUpdateCallbackInterval()
DistanceSort	getDistanceSort()
java.util.Collection<EventType>	getEventTypes()
int	getId()
RssiCalculator	getRssiCalculator()
java.util.Collection<IEddystoneNamespace>	getSpaces()
java.util.Collection<TLMFilter>	getTLMFilters() Provides TLM advertising packet filters.
java.util.Collection<EddystoneFrameType>	getTriggerFrameTypes() Gets trigger frame types.
java.util.Collection<UIDFilter>	getUIDFilters() Provides UID advertising packet filters.
java.util.Collection<URLFilter>	getURLFilters() Provides URL advertising packet filters.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final EddystoneScanContext DEFAULT

DEFAULT EddystoneScanContext provides .

Method Detail

getUIDFilters

public java.util.Collection<UIDFilter> getUIDFilters()

Provides UID advertising packet filters.

Returns:

the uID filters

getURLFilters

public java.util.Collection<URLFilter> getURLFilters()

Provides URL advertising packet filters.

Returns:

the uRL filters

getTLMFilters

public java.util.Collection<TLMFilter> getTLMFilters()

Provides TLM advertising packet filters.

Returns:

the tLM filters

getSpaces

public java.util.Collection<IEddystoneNamespace> getSpaces()

getTriggerFrameTypes

public java.util.Collection<EddystoneFrameType> getTriggerFrameTypes()

Gets trigger frame types. The trigger frame types specify with which frame types received at least the Eddystone device should be notified. The reuired 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.

Returns:

the trigger frame types

getId

public int getId()

getDevicesUpdateCallbackInterval

public long getDevicesUpdateCallbackInterval()

getRssiCalculator

public RssiCalculator getRssiCalculator()

getDistanceSort

public DistanceSort getDistanceSort()

getEventTypes

public java.util.Collection<EventType> getEventTypes()