com.kontakt.sdk.android.connection

Class SyncableIBeaconConnection

java.lang.Object

com.kontakt.sdk.android.connection.SyncableIBeaconConnection

public class SyncableIBeaconConnection
extends java.lang.Object

Syncable iBeacon connection combines IBeaconConnection and KontaktApiClient functionalities. The syncable iBeacon connection allows for immediate pushes to both Bluetooth iBeacon and its representation int kontakt.io Web API.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SyncableIBeaconConnection.SyncWriteBatchListener<T> Abstract class used as listener to notify about batch updating device and syncing with REST API
static class	SyncableIBeaconConnection.SyncWriteListener Abstract class used as listener to notify about updating device and syncing with REST API

Constructor Summary

Constructors

Constructor and Description
SyncableIBeaconConnection(android.content.Context context, IBeaconDevice beaconDevice, IBeaconConnection.ConnectionListener connectionListener) Instantiates a new Syncable i beacon connection.

Method Summary

Modifier and Type	Method and Description
void	applyConfig(Config config, SyncableIBeaconConnection.SyncWriteBatchListener<Config> syncWriteBatchListener) Applies pending configuration (Config) for Beacon.
void	close() Closes Beacon connection releases provided resources.
boolean	connectToDevice() Connects to beacon device
IBeaconDevice	getDevice() Gets beacon that the connection is established with.
boolean	isConnectedToDevice() Returns true if Connection with Beacon is established.
boolean	isDeviceAuthenticated() Returns true if Beacon was successfully authenticated.
void	overwriteAdvertisingInterval(long interval, SyncableIBeaconConnection.SyncWriteListener syncWriteListener) Writes advertising interval and tries to sync with REST API
void	overwriteMajor(int value, SyncableIBeaconConnection.SyncWriteListener syncWriteListener) Writes major value and tries to sync with REST API
void	overwriteMinor(int value, SyncableIBeaconConnection.SyncWriteListener syncWriteListener) Writes minor value and tries to sync with REST API
void	overwriteModelName(java.lang.String modelName, SyncableIBeaconConnection.SyncWriteListener syncWriteListener) Writes model name and tries to sync with REST API
void	overwritePassword(java.lang.String password, SyncableIBeaconConnection.SyncWriteListener syncWriteListener) Writes password and tries to sync with REST API
void	overwritePowerLevel(int value, SyncableIBeaconConnection.SyncWriteListener syncWriteListener) Writes power level and tries to sync with REST API
void	overwriteProximityUUID(java.util.UUID proximityUUID, SyncableIBeaconConnection.SyncWriteListener syncWriteListener) Writes proximity uuid value and tries to sync with REST API
void	resetDevice(IBeaconConnection.WriteListener writeListener) Resets device so that connection is established once again.

Methods inherited from class java.lang.Object

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

Constructor Detail

SyncableIBeaconConnection

public SyncableIBeaconConnection(android.content.Context context,
                                 IBeaconDevice beaconDevice,
                                 IBeaconConnection.ConnectionListener connectionListener)

Instantiates a new Syncable i beacon connection.

Parameters:

context - the context

beaconDevice - the beacon device

connectionListener - the connection listener

Method Detail

connectToDevice

public boolean connectToDevice()

Connects to beacon device

Returns:

true, if the connection attempt was initiated succesfully

isConnectedToDevice

public boolean isConnectedToDevice()

Returns true if Connection with Beacon is established.

Returns:

the boolean flag indicating whether connection is established.

close

public void close()

Closes Beacon connection releases provided resources.

getDevice

public IBeaconDevice getDevice()

Gets beacon that the connection is established with.

Returns:

the iBeacon device.

isDeviceAuthenticated

public boolean isDeviceAuthenticated()

Returns true if Beacon was successfully authenticated.

Returns:

the boolean flag indicating whether beacon was authenticated.

overwriteMinor

public void overwriteMinor(int value,
                           SyncableIBeaconConnection.SyncWriteListener syncWriteListener)

Writes minor value and tries to sync with REST API

Parameters:

value - the minor value to set

syncWriteListener - SyncableIBeaconConnection.SyncWriteListener

overwriteMajor

public void overwriteMajor(int value,
                           SyncableIBeaconConnection.SyncWriteListener syncWriteListener)

Writes major value and tries to sync with REST API

Parameters:

value - the major value

syncWriteListener - SyncableIBeaconConnection.SyncWriteListener

overwritePowerLevel

public void overwritePowerLevel(int value,
                                SyncableIBeaconConnection.SyncWriteListener syncWriteListener)

Writes power level and tries to sync with REST API

Parameters:

value - the power level

syncWriteListener - SyncableIBeaconConnection.SyncWriteListener

overwriteProximityUUID

public void overwriteProximityUUID(java.util.UUID proximityUUID,
                                   SyncableIBeaconConnection.SyncWriteListener syncWriteListener)

Writes proximity uuid value and tries to sync with REST API

Parameters:

proximityUUID - the proximity UUID

syncWriteListener - SyncableIBeaconConnection.SyncWriteListener

overwritePassword

public void overwritePassword(java.lang.String password,
                              SyncableIBeaconConnection.SyncWriteListener syncWriteListener)

Writes password and tries to sync with REST API

Parameters:

password - the password for device

syncWriteListener - SyncableIBeaconConnection.SyncWriteListener

overwriteAdvertisingInterval

public void overwriteAdvertisingInterval(long interval,
                                         SyncableIBeaconConnection.SyncWriteListener syncWriteListener)

Writes advertising interval and tries to sync with REST API

Parameters:

interval - advertising interval

syncWriteListener - SyncableIBeaconConnection.SyncWriteListener

overwriteModelName

public void overwriteModelName(java.lang.String modelName,
                               SyncableIBeaconConnection.SyncWriteListener syncWriteListener)

Writes model name and tries to sync with REST API

Parameters:

modelName - model name

syncWriteListener - SyncableIBeaconConnection.SyncWriteListener

resetDevice

public void resetDevice(IBeaconConnection.WriteListener writeListener)

Resets device so that connection is established once again. For more information see kontakt.io Datasheet - version 2.0. The result callback is invoked by WriteListener.

Parameters:

writeListener - SyncableIBeaconConnection.SyncWriteListener

See Also:

kontakt.io Beacon Datasheet - version 2.0.

applyConfig

public void applyConfig(Config config,
                        SyncableIBeaconConnection.SyncWriteBatchListener<Config> syncWriteBatchListener)

Applies pending configuration (Config) for Beacon. * It is possible to encounter problems during batch (the Config in this case) write operation which result in launching error handle callback method. Once the write batch operation failes, the Write Batch Processor will attempt performing rollback write batch operation aiming at restoring original Beacon configuration. The rollback operation however may not succeed as well leaving Beacon device changed partially. Therefore it is strongly advisable to write batches in relatively close distance to Beacon device. Thus, the risk of leaving Beacon in unspecified state may be avoided. If batch write succeed attempt to sync with REST API will be done

Parameters:

config - Config

syncWriteBatchListener - SyncableIBeaconConnection.SyncWriteBatchListener