client-api/no.nordicsemi.android.kotlin.ble.client.api/ClientGattEvent

ClientGattEvent

sealed interface ClientGattEvent

An event class which maps BluetoothGattCallback callbacks into data classes.

Inheritors

ServicesDiscovered

ConnectionStateChanged

Types

BondStateChanged

data class BondStateChanged(val bondState: BondState) : ClientGattEvent

This is an additional event which doesn't exist in BluetoothGattCallback. It is added here to make events complete, but the source of the emission comes from BondingBroadcastReceiver.

CharacteristicChanged

data class CharacteristicChanged(val characteristic: IBluetoothGattCharacteristic, val value: DataByteArray) : ClientGattEvent.CharacteristicEvent

Event triggered as a result of a remote characteristic notification. Note that the value within the characteristic object may have changed since receiving the remote characteristic notification, so check the parameter value for the value at the time of notification.

CharacteristicEvent

sealed interface CharacteristicEvent : ClientGattEvent.ServiceEvent

Interface which groups characteristic related events.

CharacteristicRead

data class CharacteristicRead(val characteristic: IBluetoothGattCharacteristic, val value: DataByteArray, val status: BleGattOperationStatus) : ClientGattEvent.CharacteristicEvent

Event reporting the result of a characteristic read operation.

CharacteristicWrite

data class CharacteristicWrite(val characteristic: IBluetoothGattCharacteristic, val status: BleGattOperationStatus) : ClientGattEvent.CharacteristicEvent

Event indicating the result of a characteristic write operation.

ConnectionStateChanged

data class ConnectionStateChanged(val status: BleGattConnectionStatus, val newState: GattConnectionState) : ClientGattEvent

Event emitted when GATT client has connected/disconnected to/from a remote GATT server.

DescriptorEvent

sealed interface DescriptorEvent : ClientGattEvent.ServiceEvent

Interface which groups descriptor related event.

DescriptorRead

data class DescriptorRead(val descriptor: IBluetoothGattDescriptor, val value: DataByteArray, val status: BleGattOperationStatus) : ClientGattEvent.DescriptorEvent

Event reporting the result of a descriptor read operation.

DescriptorWrite

data class DescriptorWrite(val descriptor: IBluetoothGattDescriptor, val status: BleGattOperationStatus) : ClientGattEvent.DescriptorEvent

Event indicating the result of a descriptor write operation.

MtuChanged

data class MtuChanged(val mtu: Int, val status: BleGattOperationStatus) : ClientGattEvent

Event indicating the MTU for a given device connection has changed. This callback is triggered in response to the BluetoothGatt.requestMtu function, or in response to a connection event.

PhyRead

data class PhyRead(val txPhy: BleGattPhy, val rxPhy: BleGattPhy, val status: BleGattOperationStatus) : ClientGattEvent

Event emitted as result of BluetoothGatt.readPhy.

PhyUpdate

data class PhyUpdate(val txPhy: BleGattPhy, val rxPhy: BleGattPhy, val status: BleGattOperationStatus) : ClientGattEvent

Event emitted as result of BluetoothGatt.setPreferredPhy, or as a result of remote device changing the PHY.

ReadRemoteRssi

data class ReadRemoteRssi(val rssi: Int, val status: BleGattOperationStatus) : ClientGattEvent

Event reporting the RSSI for a remote device connection. This callback is triggered in response to the BluetoothGatt.readRemoteRssi function.

ReliableWriteCompleted

data class ReliableWriteCompleted(val status: BleGattOperationStatus) : ClientGattEvent.ServiceEvent

Event invoked when a reliable write transaction has been completed.

ServiceChanged

class ServiceChanged : ClientGattEvent

An event indicating "service changed" event is received. Receiving this event means that the GATT database is out of sync with the remote device. BluetoothGatt.discoverServices should be called to re-discover the services.

ServiceEvent

sealed interface ServiceEvent : ClientGattEvent

Interface which groups service related events.

ServicesDiscovered

data class ServicesDiscovered(val services: List<IBluetoothGattService>, val status: BleGattOperationStatus) : ClientGattEvent

Event emitted when the list of remote services, characteristics and descriptors for the remote device have been updated, i.e. new services have been discovered.

ClientGattEvent

See also

Inheritors

Types