com.kontakt.sdk.android.ble.manager

Interface ProximityManager

All Known Implementing Classes:

ProximityManagerImpl

public interface ProximityManager

Proximity Manager is an entry point for all operations connected with ranging and monitoring BLE devices (iBeacons, Eddystones and Kontakt.io Beacon Pro secure profiles).

Method Summary

Modifier and Type	Method and Description
GeneralConfigurator	configuration() Configure scanning related options.
void	connect(OnServiceReadyListener onServiceReadyListener) Connects to backing ProximityService.
void	disconnect() Finishes scanning and disconnects from backing service.
FiltersConfigurator	filters() Configure filtering.
boolean	isConnected()
boolean	isScanning()
void	restartScanning() Stops scanning, applies latest configuration and restarts scanning.
void	setEddystoneListener(EddystoneListener listener) Sets EddystoneListener.
void	setIBeaconListener(IBeaconListener listener) Sets IBeaconListener.
void	setScanStatusListener(ScanStatusListener listener) Sets ScanStatusListener.
void	setSecureProfileListener(SecureProfileListener listener) Sets SecureProfileListener.
void	setSpaceListener(SpaceListener listener) Sets SpaceListener.
SpacesConfigurator	spaces() Configure IBeacon regions and Eddystone namespaces.
void	startScanning() Starts scanning for Kontakt.io devices.
void	stopScanning() Stops scanning.

Method Detail

connect

void connect(OnServiceReadyListener onServiceReadyListener)

Connects to backing ProximityService. This needs to be done before first calling startScanning().

Parameters:

onServiceReadyListener - Listener used to specify if ProximityManager has successfully connected to backing service. This means that all necessary Android permissions have been granted and ProximityManager is ready to start scanning.

disconnect

void disconnect()

Finishes scanning and disconnects from backing service. Calling connect(OnServiceReadyListener) is required if scanning should be started again.

startScanning

void startScanning()

Starts scanning for Kontakt.io devices.

stopScanning

void stopScanning()

Stops scanning. Does not disconnect from backing service. Call disconnect() to disconnect.

restartScanning

void restartScanning()

Stops scanning, applies latest configuration and restarts scanning.

isConnected

boolean isConnected()

Returns:

True if ProximityManager is connected to backing service and ready to scan.

isScanning

boolean isScanning()

Returns:

True if scanning is currently in progress.

setScanStatusListener

void setScanStatusListener(ScanStatusListener listener)

Sets ScanStatusListener.

Parameters:

listener - ScanStatusListener. Nullable.

setSpaceListener

void setSpaceListener(SpaceListener listener)

Sets SpaceListener.

Parameters:

listener - SpaceListener. Nullable.

setIBeaconListener

void setIBeaconListener(IBeaconListener listener)

Sets IBeaconListener.

Parameters:

listener - IBeaconListener. Nullable.

setEddystoneListener

void setEddystoneListener(EddystoneListener listener)

Sets EddystoneListener.

Parameters:

listener - EddystoneListener. Nullable.

setSecureProfileListener

void setSecureProfileListener(SecureProfileListener listener)

Sets SecureProfileListener. This should be used only when working with Kontakt.io Beacon PRO devices.

Parameters:

listener - SecureProfileListener. Nullable.

configuration

GeneralConfigurator configuration()

Configure scanning related options.

Returns:

Configuration

spaces

SpacesConfigurator spaces()

Configure IBeacon regions and Eddystone namespaces.

Returns:

ProximityManagerSpaces

filters

FiltersConfigurator filters()

Configure filtering.

Returns:

ProximityManagerFilters