com.kontakt.sdk.android.ble.manager

Interface ProximityManagerContract

All Known Implementing Classes:

KontaktProximityManager, ProximityManager

public interface ProximityManagerContract

Contract interface representing Proximity Manager programming interface.

Method Summary

Modifier and Type	Method and Description
boolean	attachListener(ProximityManager.ProximityListener proximityListener) Attaches listener.
void	clearBuffers() Clears buffers resolved beacon cache Available only in KontaktProximityManager
void	clearCache() Clears resolved beacon cache Available only in KontaktProximityManager
void	connect(OnServiceReadyListener listener) Connects to backing Service.
boolean	detachListener(ProximityManager.ProximityListener proximityListener) Detaches listener.
void	disconnect() Disconnects 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.

Method Detail

getId

int getId()

Gets proximity manager id.

Returns:

the id

connect

void connect(OnServiceReadyListener listener)

Connects to backing Service.

Parameters:

listener - the listener

isConnected

boolean isConnected()

Provides information about connection state with backing service.

Returns:

the true if connection with backing service is established.

disconnect

void disconnect()

Disconnects from backing service.

isScanning

boolean isScanning()

Provides information whether the ProximityManager is currently scanning.

Returns:

true if the scan is active

initializeScan

boolean initializeScan(ScanContext scanContext)

Initializes scan

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

void initializeScan(ScanContext scanContext,
                    OnServiceReadyListener onServiceReadyListener)

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

Parameters:

scanContext - the scan context

onServiceReadyListener - the on service ready listener

restartScan

boolean restartScan(ScanContext scanContext)

Restarts scan.

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

void restartScan(ScanContext scanContext,
                 OnServiceReadyListener onServiceReadyListener)

Restart scan.

Parameters:

scanContext - the scan context

onServiceReadyListener - the on service ready listener

attachListener

boolean attachListener(ProximityManager.ProximityListener proximityListener)

Attaches listener.

Parameters:

proximityListener - the proximity listener

Returns:

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

detachListener

boolean detachListener(ProximityManager.ProximityListener proximityListener)

Detaches listener.

Parameters:

proximityListener - the proximity listener

Returns:

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

finishScan

boolean finishScan()

Finishes scan.

Returns:

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

clearCache

void clearCache()

Clears resolved beacon cache
Available only in KontaktProximityManager

clearBuffers

void clearBuffers()

Clears buffers resolved beacon cache
Available only in KontaktProximityManager