Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
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 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 ()

Public Methods

public void onCharacteristicChanged ( BluetoothGatt gatt, BluetoothGattCharacteristic characteristic)

Callback triggered as a result of a remote characteristic notification.

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

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

Callback reporting the result of a characteristic read operation.

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

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

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 GATT client invoked writeCharacteristic(BluetoothGattCharacteristic)
characteristic Characteristic that was written to the associated remote device.
status The result of the write operation GATT_SUCCESS if the operation succeeds.

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

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

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

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

Callback reporting the result of a descriptor read operation.

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

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

Callback indicating the result of a descriptor write operation.

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

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

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

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

public void onReliableWriteCompleted ( BluetoothGatt gatt, int status)

Callback invoked when a reliable write transaction has been completed.

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

public 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.

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