com.kontakt.sdk.android.ble.manager

Class ProximityManager

java.lang.Object

com.kontakt.sdk.android.ble.manager.ProximityManager

All Implemented Interfaces:

ProximityManagerContract, ServiceConnector

public class ProximityManager
extends java.lang.Object
implements ProximityManagerContract

Provides scan management API according to which the Android device may scan remote bluetooth devices.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ProximityManager.ProximityListener Proximity listener provides callbacks for scan process performed by (ProximityManager).

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_DEVICES_UPDATE_CALLBACK_INTERVAL The constant DEFAULT_DEVICES_UPDATE_CALLBACK_INTERVAL.
static int	SCAN_MODE_BALANCED Perform Bluetooth LE scan in balanced power mode.
static int	SCAN_MODE_LOW_LATENCY Scan using highest duty cycle.
static int	SCAN_MODE_LOW_POWER Perform Bluetooth LE scan in low power mode.

Constructor Summary

Constructors

Constructor and Description
ProximityManager(Context ctx) Instantiates a new Proximity manager.

Method Summary

Modifier and Type	Method and Description
boolean	attachListener(ProximityManager.ProximityListener proximityListener) Attaches listener.
protected void	checkPermissions() Checks specific permissions under which Service connector works.
void	clearBuffers() Clears buffers resolved beacon cache Available only in KontaktProximityManager
void	clearCache() Clears resolved beacon cache Available only in KontaktProximityManager
void	connect(OnServiceReadyListener onServiceReadyistener) Connects to backing Service.
boolean	detachListener(ProximityManager.ProximityListener proximityListener) Detaches listener.
void	disconnect() Disconnects the connector from backing service.
boolean	finishScan() Finishes scan.
int	getId() Gets proximity manager id.
boolean	initializeScan(ScanContext scanContext) Initializes scan
void	initializeScan(ScanContext scanContext, OnServiceReadyListener onServiceReadyListener) Initializes scan and connects to backing service if the connection is not established.
boolean	isConnected() Provides information about connection state with backing service.
boolean	isScanning() Provides information whether the ProximityManager is currently scanning.
boolean	restartScan(ScanContext scanContext) Restarts scan.
void	restartScan(ScanContext scanContext, OnServiceReadyListener onServiceReadyListener) Restart scan.

Methods inherited from class java.lang.Object

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

Field Detail

SCAN_MODE_LOW_POWER

public static final int SCAN_MODE_LOW_POWER

Perform Bluetooth LE scan in low power mode. This is the default scan mode as it consumes the least power.

See Also:

Constant Field Values

SCAN_MODE_BALANCED

public static final int SCAN_MODE_BALANCED

Perform Bluetooth LE scan in balanced power mode. Scan results are returned at a rate that provides a good trade-off between scan frequency and power consumption.

See Also:

Constant Field Values

SCAN_MODE_LOW_LATENCY

public static final int SCAN_MODE_LOW_LATENCY

Scan using highest duty cycle. It's recommended to only use this mode when the application is running in the foreground.

See Also:

Constant Field Values

DEFAULT_DEVICES_UPDATE_CALLBACK_INTERVAL

public static final long DEFAULT_DEVICES_UPDATE_CALLBACK_INTERVAL

The constant DEFAULT_DEVICES_UPDATE_CALLBACK_INTERVAL.

See Also:

Constant Field Values

Constructor Detail

ProximityManager

public ProximityManager(Context ctx)

Instantiates a new Proximity manager.

Parameters:

ctx - the ctx

Method Detail

getId

public int getId()

Description copied from interface: ProximityManagerContract

Gets proximity manager id.

Specified by:

getId in interface ProximityManagerContract

Returns:

the id

connect

public void connect(OnServiceReadyListener onServiceReadyistener)

Description copied from interface: ProximityManagerContract

Connects to backing Service.

Specified by:

connect in interface ProximityManagerContract

Specified by:

connect in interface ServiceConnector

Parameters:

onServiceReadyistener - the listener

isConnected

public boolean isConnected()

Description copied from interface: ProximityManagerContract

Provides information about connection state with backing service.

Specified by:

isConnected in interface ProximityManagerContract

Specified by:

isConnected in interface ServiceConnector

Returns:

the true if connection with backing service is established.

initializeScan

public boolean initializeScan(ScanContext scanContext)

Description copied from interface: ProximityManagerContract

Initializes scan

Specified by:

initializeScan in interface ProximityManagerContract

Parameters:

scanContext - the scan context

Returns:

the true if scan initialization request is sent. False if either the connection with backing service is not established or the applied scan context is same as the one according to which scan has been initialized.

initializeScan

public void initializeScan(ScanContext scanContext,
                           OnServiceReadyListener onServiceReadyListener)

Description copied from interface: ProximityManagerContract

Initializes scan and connects to backing service if the connection is not established.

Specified by:

initializeScan in interface ProximityManagerContract

Parameters:

scanContext - the scan context

onServiceReadyListener - the on service ready listener

restartScan

public boolean restartScan(ScanContext scanContext)

Description copied from interface: ProximityManagerContract

Restarts scan.

Specified by:

restartScan in interface ProximityManagerContract

Parameters:

scanContext - the scan context

Returns:

true if scan restart request has been sent to the backing service. False if connection to the backing service is not established.

restartScan

public void restartScan(ScanContext scanContext,
                        OnServiceReadyListener onServiceReadyListener)

Description copied from interface: ProximityManagerContract

Restart scan.

Specified by:

restartScan in interface ProximityManagerContract

Parameters:

scanContext - the scan context

onServiceReadyListener - the on service ready listener

attachListener

public boolean attachListener(ProximityManager.ProximityListener proximityListener)

Description copied from interface: ProximityManagerContract

Attaches listener.

Specified by:

attachListener in interface ProximityManagerContract

Parameters:

proximityListener - the proximity listener

Returns:

true if attach request is sent. False if connection to the backing service is not established.

detachListener

public boolean detachListener(ProximityManager.ProximityListener proximityListener)

Description copied from interface: ProximityManagerContract

Detaches listener.

Specified by:

detachListener in interface ProximityManagerContract

Parameters:

proximityListener - the proximity listener

Returns:

true if detach request is sent. False is connection to the backing service is not established.

finishScan

public boolean finishScan()

Description copied from interface: ProximityManagerContract

Finishes scan.

Specified by:

finishScan in interface ProximityManagerContract

Returns:

true if finish scan request is sent. False if connection to the backing service is not established.

disconnect

public void disconnect()

Description copied from interface: ServiceConnector

Disconnects the connector from backing service.

Specified by:

disconnect in interface ProximityManagerContract

Specified by:

disconnect in interface ServiceConnector

isScanning

public boolean isScanning()

Description copied from interface: ProximityManagerContract

Provides information whether the ProximityManager is currently scanning.

Specified by:

isScanning in interface ProximityManagerContract

Returns:

true if the scan is active

clearCache

public void clearCache()

Description copied from interface: ProximityManagerContract

Clears resolved beacon cache
Available only in KontaktProximityManager

Specified by:

clearCache in interface ProximityManagerContract

clearBuffers

public void clearBuffers()

Description copied from interface: ProximityManagerContract

Clears buffers resolved beacon cache
Available only in KontaktProximityManager

Specified by:

clearBuffers in interface ProximityManagerContract

checkPermissions

protected void checkPermissions()

Checks specific permissions under which Service connector works.