com.kontakt.sdk.android.ble.configuration

Class ActivityCheckConfiguration

java.lang.Object

com.kontakt.sdk.android.ble.configuration.ActivityCheckConfiguration

public final class ActivityCheckConfiguration
extends java.lang.Object

Activity Check configuration describes the time boundary after which the beacon device is interpreted as absent and than is removed from internal cache.

The configuration consists of 2 parameters - removal inactivityTimeout and checkPeriod.

The former describes time threshold after which beacon device is interpreted as inactive and should be removed.

The latter specifies period of search of inactive beacons.

Field Summary

Fields

Modifier and Type	Field and Description
static ActivityCheckConfiguration	DEFAULT Predefined default Beacon Activity Check Configuration.
static ActivityCheckConfiguration	DISABLED Predefined constant disabling device activity check configuration.
static ActivityCheckConfiguration	MINIMAL Predefined minimal allowed Beacon Activity Check Configuration.

Method Summary

Modifier and Type	Method and Description
static ActivityCheckConfiguration	create(long inactivityTimeout, long checkPeriod) Instantiates new immutable Beacon Activity Check Configuration instance
boolean	equals(java.lang.Object o)
long	getCheckPeriod() Provides check period.
long	getInactivityTimeout() Provides Beacon Inactivity Timeout [ms].
int	hashCode()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

DISABLED

public static final ActivityCheckConfiguration DISABLED

Predefined constant disabling device activity check configuration.

MINIMAL

public static final ActivityCheckConfiguration MINIMAL

Predefined minimal allowed Beacon Activity Check Configuration.

The MINIMAL configuration specifies beacon inactivity timeout equal to 3 seconds. Inactivity check will be performed every 1 seconds.
This option is very "aggressive" when it comes to reporting lost beacons. It should only be used for smartphones with really good BLE hardware.
In majority of usecases DEFAULT is the best option.

DEFAULT

public static final ActivityCheckConfiguration DEFAULT

Predefined default Beacon Activity Check Configuration. This configuration is set when no different is specified. The DEFAULT configuration specifies beacon inactivity timeout equal to 10 seconds. Inactivity check will be performed every 5 seconds of active scanning.

This is the best option for majority of use cases.

Method Detail

create

public static ActivityCheckConfiguration create(long inactivityTimeout,
                                                long checkPeriod)

Instantiates new immutable Beacon Activity Check Configuration instance

Parameters:

inactivityTimeout - the removal threshold [ms]

checkPeriod - the removal period [ms]

Returns:

ActivityCheckConfiguration instance

getInactivityTimeout

public long getInactivityTimeout()

Provides Beacon Inactivity Timeout [ms].

Returns:

the beacon inactivity timeout

getCheckPeriod

public long getCheckPeriod()

Provides check period.

Returns:

the check period [ms]

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object