com.kontakt.sdk.android.ble.filter.ibeacon

Class IBeaconFilters

java.lang.Object

com.kontakt.sdk.android.ble.filter.ibeacon.IBeaconFilters

public final class IBeaconFilters
extends java.lang.Object

Filters are designed to enable more detailed devices search. There are several predefined filters including:

• Proximity UUID filter - accepts devices only with desired Proximity UUID
• Beacon Unique ID filter - every kontakt Beacon has assigned Unique Id to itself. What is more this Unique Id may be read in Service Data in the Advertising Package. Thus, filtering by this property is enabled as well. Please note that this filter works well only for Beacons produces by Kontakt.
• Device Name filter - accepts only devices named as specified during filter creation and inclusion to ProximityManager configuration
• Firmware filter - accepts only devices with specified version of firmware version. Please note that this filter works well only with Kontakt beacons
• Major filter - accepts only devices with specified major value
• Minor filter - accepts only devices with specified minor value
• Multi filter - accepts only devices with specified batch of parameters including: device name, proximity UUID, MAC address, unique Id, firmware
• Custom filter - this filter is introduced to perform custom filtering. Despite the fact that other filters should meet your needs, you have possibility to create your own filter.

In Android version lower than Build.VERSION_CODES.LOLLIPOP filters are included the form as they are specified. For the latest one and further the filters are converted to ScanFilters and passed to handle by the framework.

Method Summary

Modifier and Type	Method and Description
static DeviceNameFilter	newDeviceNameFilter(java.lang.String beaconName) Creates new device name filter.
static FirmwareFilter	newFirmwareFilter(java.lang.String firmwareVersion) Creates new firmware filter.
static MajorFilter	newMajorFilter(int major) Creates new Major filter.
static MinorFilter	newMinorFilter(int minor) Creates new Minor filter.
static IBeaconMultiFilter.Builder	newMultiFilterBuilder() Creates new Multi Filter builder.
static ProximityUUIDFilter	newProximityUUIDFilter(java.util.UUID proximityUUID) Creates new proximity UUID filter.
static IBeaconUniqueIdFilter	newUniqueIdFilter(java.lang.String beaconUniqueId) Creates new beacon unique Id filter.

Methods inherited from class java.lang.Object

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

Method Detail

newProximityUUIDFilter

public static ProximityUUIDFilter newProximityUUIDFilter(java.util.UUID proximityUUID)

Creates new proximity UUID filter.

Parameters:

proximityUUID - the proximity uUID

Returns:

the proximity UUID filter

newUniqueIdFilter

public static IBeaconUniqueIdFilter newUniqueIdFilter(java.lang.String beaconUniqueId)

Creates new beacon unique Id filter.

Parameters:

beaconUniqueId - the beacon unique id

Returns:

the beacon unique id filter

newDeviceNameFilter

public static DeviceNameFilter newDeviceNameFilter(java.lang.String beaconName)

Creates new device name filter.

Parameters:

beaconName - the beacon name

Returns:

the device name filter

newFirmwareFilter

public static FirmwareFilter newFirmwareFilter(java.lang.String firmwareVersion)

Creates new firmware filter.

Parameters:

firmwareVersion - the firmware version

Returns:

the firmware filter

newMajorFilter

public static MajorFilter newMajorFilter(int major)

Creates new Major filter.

Parameters:

major - the major

Returns:

the major filter

newMinorFilter

public static MinorFilter newMinorFilter(int minor)

Creates new Minor filter.

Parameters:

minor - the minor

Returns:

the minor filter

newMultiFilterBuilder

public static IBeaconMultiFilter.Builder newMultiFilterBuilder()

Creates new Multi Filter builder.

Returns:

the multi filter builder