BluetoothGattDescriptor

Description

The BluetoothGattDescriptor interface of the Web Bluetooth API represents a GATT descriptor, which contains related information about a characteristic value.

Interface overview

[CheckAnyPermissions="bluetooth"]

interface BluetoothGattDescriptor

{

readonly attribute BluetoothGattCharacteristic characteristic;

readonly attribute DOMString uuid;

readonly attribute ArrayBuffer? value;

[Cached, Constant] readonly attribute GattPermissions permissions;

[NewObject] Promise<ArrayBuffer> readValue();

[NewObject] Promise<void> writeValue(ArrayBuffer value);

};

Properties

• BluetoothGattDescriptor.characteristic

      Returns the BluetoothGattCharacteristic object representing the characteristic this descriptor belongs to.

• BluetoothGattDescriptor.uuid

      Returns the UUID of this descriptor.

• BluetoothGattDescriptor.value

      Stores the cached value of this descriptor. This value can be updated via the BluetoothGattDescriptor.readValue() method.

• BluetoothGattDescriptor.permissions

      Returns a bit mask that describes the operations allowed on the characteristic.

Methods

• BluetoothGattDescriptor.readValue()

      Reads the descriptor value from the remote device. The cached BluetoothGattDescriptor.value is also updated after retrieving the value.

• BluetoothGattDescriptor.writeValue()

      Writes the descriptor value to the GATT server. If the local device is the GATT client, the value will be written to the remote GATT server. On the other hand, if the local device is the GATT server, the value will be written to BluetoothGattDescriptor.value.