Android APIs
public abstract class

BluetoothGattCallback

extends Object
java.lang.Object
   ↳ android.bluetooth.BluetoothGattCallback

Class Overview

This abstract class is used to implement BluetoothGatt callbacks.

Summary

Public Constructors
BluetoothGattCallback()
Public Methods
void onCharacteristicChanged(BluetoothGatt gatt, BluetoothGattCharacteristic characteristic)
Callback triggered as a result of a remote characteristic notification.
void onCharacteristicRead(BluetoothGatt gatt, BluetoothGattCharacteristic characteristic, int status)
Callback reporting the result of a characteristic read operation.
void onCharacteristicWrite(BluetoothGatt gatt, BluetoothGattCharacteristic characteristic, int status)
Callback indicating the result of a characteristic write operation.
void onConnectionStateChange(BluetoothGatt gatt, int status, int newState)
Callback indicating when GATT client has connected/disconnected to/from a remote GATT server.
void onDescriptorRead(BluetoothGatt gatt, BluetoothGattDescriptor descriptor, int status)
Callback reporting the result of a descriptor read operation.
void onDescriptorWrite(BluetoothGatt gatt, BluetoothGattDescriptor descriptor, int status)
Callback indicating the result of a descriptor write operation.
void onMtuChanged(BluetoothGatt gatt, int mtu, int status)
Callback indicating the MTU for a given device connection has changed.
void onReadRemoteRssi(BluetoothGatt gatt, int rssi, int status)
Callback reporting the RSSI for a remote device connection.
void onReliableWriteCompleted(BluetoothGatt gatt, int status)
Callback invoked when a reliable write transaction has been completed.
void onServicesDiscovered(BluetoothGatt gatt, int status)
Callback invoked when the list of remote services, characteristics and descriptors for the remote device have been updated, ie new services have been discovered.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public BluetoothGattCallback ()

Added in API level 18

Public Methods

public void onCharacteristicChanged (BluetoothGatt gatt, BluetoothGattCharacteristic characteristic)

Added in API level 18

Callback triggered as a result of a remote characteristic notification.

Parameters
gatt BluetoothGatt: GATT client the characteristic is associated with
characteristic BluetoothGattCharacteristic: Characteristic that has been updated as a result of a remote notification event.

public void onCharacteristicRead (BluetoothGatt gatt, BluetoothGattCharacteristic characteristic, int status)

Added in API level 18

Callback reporting the result of a characteristic read operation.

Parameters
gatt BluetoothGatt: GATT client invoked readCharacteristic(BluetoothGattCharacteristic)
characteristic BluetoothGattCharacteristic: Characteristic that was read from the associated remote device.
status int: GATT_SUCCESS if the read operation was completed successfully.

public void onCharacteristicWrite (BluetoothGatt gatt, BluetoothGattCharacteristic characteristic, int status)

Added in API level 18

Callback indicating the result of a characteristic write operation.

If this callback is invoked while a reliable write transaction is in progress, the value of the characteristic represents the value reported by the remote device. An application should compare this value to the desired value to be written. If the values don't match, the application must abort the reliable write transaction.

Parameters
gatt BluetoothGatt: GATT client invoked writeCharacteristic(BluetoothGattCharacteristic)
characteristic BluetoothGattCharacteristic: Characteristic that was written to the associated remote device.
status int: The result of the write operation GATT_SUCCESS if the operation succeeds.

public void onConnectionStateChange (BluetoothGatt gatt, int status, int newState)

Added in API level 18

Callback indicating when GATT client has connected/disconnected to/from a remote GATT server.

Parameters
gatt BluetoothGatt: GATT client
status int: Status of the connect or disconnect operation. GATT_SUCCESS if the operation succeeds.
newState int: Returns the new connection state. Can be one of STATE_DISCONNECTED or STATE_CONNECTED

public void onDescriptorRead (BluetoothGatt gatt, BluetoothGattDescriptor descriptor, int status)

Added in API level 18

Callback reporting the result of a descriptor read operation.

Parameters
gatt BluetoothGatt: GATT client invoked readDescriptor(BluetoothGattDescriptor)
descriptor BluetoothGattDescriptor: Descriptor that was read from the associated remote device.
status int: GATT_SUCCESS if the read operation was completed successfully

public void onDescriptorWrite (BluetoothGatt gatt, BluetoothGattDescriptor descriptor, int status)

Added in API level 18

Callback indicating the result of a descriptor write operation.

Parameters
gatt BluetoothGatt: GATT client invoked writeDescriptor(BluetoothGattDescriptor)
descriptor BluetoothGattDescriptor: Descriptor that was writte to the associated remote device.
status int: The result of the write operation GATT_SUCCESS if the operation succeeds.

public void onMtuChanged (BluetoothGatt gatt, int mtu, int status)

Added in API level 21

Callback indicating the MTU for a given device connection has changed. This callback is triggered in response to the requestMtu(int) function, or in response to a connection event.

Parameters
gatt BluetoothGatt: GATT client invoked requestMtu(int)
mtu int: The new MTU size
status int: GATT_SUCCESS if the MTU has been changed successfully

public void onReadRemoteRssi (BluetoothGatt gatt, int rssi, int status)

Added in API level 18

Callback reporting the RSSI for a remote device connection. This callback is triggered in response to the readRemoteRssi() function.

Parameters
gatt BluetoothGatt: GATT client invoked readRemoteRssi()
rssi int: The RSSI value for the remote device
status int: GATT_SUCCESS if the RSSI was read successfully

public void onReliableWriteCompleted (BluetoothGatt gatt, int status)

Added in API level 18

Callback invoked when a reliable write transaction has been completed.

Parameters
gatt BluetoothGatt: GATT client invoked executeReliableWrite()
status int: GATT_SUCCESS if the reliable write transaction was executed successfully

public void onServicesDiscovered (BluetoothGatt gatt, int status)

Added in API level 18

Callback invoked when the list of remote services, characteristics and descriptors for the remote device have been updated, ie new services have been discovered.

Parameters
gatt BluetoothGatt: GATT client invoked discoverServices()
status int: GATT_SUCCESS if the remote device has been explored successfully.