com.kontakt.sdk.android.ble.connection

Interface SyncableKontaktDeviceConnection

public interface SyncableKontaktDeviceConnection

Syncable Kontakt device connection combines KontaktDeviceConnection and KontaktCloud functionality. The syncable iBeacon connection allows for immediate pushes to both Bluetooth iBeacon and its representation in kontakt.io Web API.

Method Summary

Modifier and Type	Method and Description
void	applyConfig(Config config, com.kontakt.sdk.android.ble.connection.SyncableKontaktDeviceConnectionImpl.SyncWriteBatchListener<Config> syncWriteBatchListener) Applies pending configuration (Config) for Beacon.
void	applySecureConfig(Config secureConfig, com.kontakt.sdk.android.ble.connection.SyncableKontaktDeviceConnectionImpl.SyncWriteListener syncWriteListener) Writes secure config and tries to sync with REST API
void	close() Closes Beacon connection releases provided resources.
boolean	connectToDevice() Connects to beacon device
RemoteBluetoothDevice	getDevice() Gets devices 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, com.kontakt.sdk.android.ble.connection.SyncableKontaktDeviceConnectionImpl.SyncWriteListener syncWriteListener) Writes advertising interval and tries to sync with REST API
void	overwriteInstanceId(java.lang.String instanceId, com.kontakt.sdk.android.ble.connection.SyncableKontaktDeviceConnectionImpl.SyncWriteListener syncWriteListener) Overwrites instanceId
void	overwriteMajor(int value, com.kontakt.sdk.android.ble.connection.SyncableKontaktDeviceConnectionImpl.SyncWriteListener syncWriteListener) Writes major value and tries to sync with REST API
void	overwriteMinor(int value, com.kontakt.sdk.android.ble.connection.SyncableKontaktDeviceConnectionImpl.SyncWriteListener syncWriteListener) Writes minor value and tries to sync with REST API
void	overwriteModelName(java.lang.String modelName, com.kontakt.sdk.android.ble.connection.SyncableKontaktDeviceConnectionImpl.SyncWriteListener syncWriteListener) Writes model name and tries to sync with REST API
void	overwriteNamespace(java.lang.String namespaceId, com.kontakt.sdk.android.ble.connection.SyncableKontaktDeviceConnectionImpl.SyncWriteListener syncWriteListener) Overwrites namespae
void	overwritePassword(java.lang.String password, com.kontakt.sdk.android.ble.connection.SyncableKontaktDeviceConnectionImpl.SyncWriteListener syncWriteListener) Writes password and tries to sync with REST API
void	overwritePowerLevel(int value, com.kontakt.sdk.android.ble.connection.SyncableKontaktDeviceConnectionImpl.SyncWriteListener syncWriteListener) Writes power level and tries to sync with REST API
void	overwriteProximityUUID(java.util.UUID proximityUUID, com.kontakt.sdk.android.ble.connection.SyncableKontaktDeviceConnectionImpl.SyncWriteListener syncWriteListener) Writes proximity uuid value and tries to sync with REST API
void	overwriteUrl(java.lang.String url, com.kontakt.sdk.android.ble.connection.SyncableKontaktDeviceConnectionImpl.SyncWriteListener syncWriteListener) Overwrites url
void	resetDevice(WriteListener writeListener) Resets device so that connection is established once again.

Method Detail

connectToDevice

boolean connectToDevice()

Connects to beacon device

Returns:

true, if the connection attempt was initiated succesfully

isConnectedToDevice

boolean isConnectedToDevice()

Returns true if Connection with Beacon is established.

Returns:

the boolean flag indicating whether connection is established.

close

void close()

Closes Beacon connection releases provided resources.

getDevice

RemoteBluetoothDevice getDevice()

Gets devices that the connection is established with.

Returns:

the iBeacon device.

isDeviceAuthenticated

boolean isDeviceAuthenticated()

Returns true if Beacon was successfully authenticated.

Returns:

the boolean flag indicating whether beacon was authenticated.

overwriteMinor

void overwriteMinor(int value,
                    com.kontakt.sdk.android.ble.connection.SyncableKontaktDeviceConnectionImpl.SyncWriteListener syncWriteListener)

Writes minor value and tries to sync with REST API

Parameters:

value - the minor value to set

syncWriteListener - SyncableKontaktDeviceConnectionImpl.SyncWriteListener

overwriteMajor

void overwriteMajor(int value,
                    com.kontakt.sdk.android.ble.connection.SyncableKontaktDeviceConnectionImpl.SyncWriteListener syncWriteListener)

Writes major value and tries to sync with REST API

Parameters:

value - the major value

syncWriteListener - SyncableKontaktDeviceConnectionImpl.SyncWriteListener

overwritePowerLevel

void overwritePowerLevel(int value,
                         com.kontakt.sdk.android.ble.connection.SyncableKontaktDeviceConnectionImpl.SyncWriteListener syncWriteListener)

Writes power level and tries to sync with REST API

Parameters:

value - the power level

syncWriteListener - SyncableKontaktDeviceConnectionImpl.SyncWriteListener

overwriteProximityUUID

void overwriteProximityUUID(java.util.UUID proximityUUID,
                            com.kontakt.sdk.android.ble.connection.SyncableKontaktDeviceConnectionImpl.SyncWriteListener syncWriteListener)

Writes proximity uuid value and tries to sync with REST API

Parameters:

proximityUUID - the proximity UUID

syncWriteListener - SyncableKontaktDeviceConnectionImpl.SyncWriteListener

overwritePassword

void overwritePassword(java.lang.String password,
                       com.kontakt.sdk.android.ble.connection.SyncableKontaktDeviceConnectionImpl.SyncWriteListener syncWriteListener)

Writes password and tries to sync with REST API

Parameters:

password - the password for device

syncWriteListener - SyncableKontaktDeviceConnectionImpl.SyncWriteListener

overwriteAdvertisingInterval

void overwriteAdvertisingInterval(long interval,
                                  com.kontakt.sdk.android.ble.connection.SyncableKontaktDeviceConnectionImpl.SyncWriteListener syncWriteListener)

Writes advertising interval and tries to sync with REST API

Parameters:

interval - advertising interval

syncWriteListener - SyncableKontaktDeviceConnectionImpl.SyncWriteListener

overwriteModelName

void overwriteModelName(java.lang.String modelName,
                        com.kontakt.sdk.android.ble.connection.SyncableKontaktDeviceConnectionImpl.SyncWriteListener syncWriteListener)

Writes model name and tries to sync with REST API

Parameters:

modelName - model name

syncWriteListener - SyncableKontaktDeviceConnectionImpl.SyncWriteListener

resetDevice

void resetDevice(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 - SyncableKontaktDeviceConnectionImpl.SyncWriteListener

See Also:

kontakt.io Beacon Datasheet - version 2.0.

overwriteUrl

void overwriteUrl(java.lang.String url,
                  com.kontakt.sdk.android.ble.connection.SyncableKontaktDeviceConnectionImpl.SyncWriteListener syncWriteListener)

Overwrites url

Parameters:

url - the url

syncWriteListener - SyncableKontaktDeviceConnectionImpl.SyncWriteListener

overwriteNamespace

void overwriteNamespace(java.lang.String namespaceId,
                        com.kontakt.sdk.android.ble.connection.SyncableKontaktDeviceConnectionImpl.SyncWriteListener syncWriteListener)

Overwrites namespae

Parameters:

namespaceId - the namespace

syncWriteListener - SyncableKontaktDeviceConnectionImpl.SyncWriteListener

overwriteInstanceId

void overwriteInstanceId(java.lang.String instanceId,
                         com.kontakt.sdk.android.ble.connection.SyncableKontaktDeviceConnectionImpl.SyncWriteListener syncWriteListener)

Overwrites instanceId

Parameters:

instanceId - the instanceId

syncWriteListener - SyncableKontaktDeviceConnectionImpl.SyncWriteListener

applySecureConfig

void applySecureConfig(Config secureConfig,
                       com.kontakt.sdk.android.ble.connection.SyncableKontaktDeviceConnectionImpl.SyncWriteListener syncWriteListener)

Writes secure config and tries to sync with REST API

Parameters:

secureConfig - the secureConfig

syncWriteListener - SyncableKontaktDeviceConnectionImpl.SyncWriteListener

applyConfig

void applyConfig(Config config,
                 com.kontakt.sdk.android.ble.connection.SyncableKontaktDeviceConnectionImpl.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 results 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 - SyncableKontaktDeviceConnectionImpl.SyncWriteBatchListener