BluetoothRemoteGATTDescriptor

Experimental

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The BluetoothRemoteGATTDescriptor interface of the Web Bluetooth API provides a GATT Descriptor, which provides further information about a characteristic’s value.

This page describes the W3C Community Group Web Bluetooth API. For the Firefox OS Bluetooth API, see BluetoothGattDescriptor (Firefox OS).

Interface

interface BluetoothRemoteGATTDescriptor {
  readonly attribute BluetoothGATTCharacteristic characteristic;
  readonly attribute UUID uuid;
  readonly attribute ArrayBuffer? value;
  Promise<ArrayBuffer> readValue();
  Promise<void> writeValue(BufferSource value);
};

Properties

BluetoothRemoteGATTDescriptor.characteristicRead only
Returns the BluetoothRemoteGATTCharacteristic this descriptor belongs to.
BluetoothRemoteGATTDescriptor.uuidRead only
Returns the UUID of the characteristic descriptor, for example '00002902-0000-1000-8000-00805f9b34fb' for theClient Characteristic Configuration descriptor.
BluetoothRemoteGATTDescriptor.valueRead only
Returns the currently cached descriptor value. This value gets updated when the value of the descriptor is read.

Methods

BluetoothRemoteGATTDescriptor.readValue()
Returns a Promise that resolves to an ArrayBuffer holding a duplicate  of the value property if it is available and supported. Otherwise it throws an error.
BluetoothRemoteGATTDescriptor.writeValue()
Sets the value property to the bytes contained in an ArrayBuffer and returns a Promise.

Specifications

Specification Status Comment
Web Bluetooth
The definition of 'BluetoothRemoteGATTDescriptor' in that specification.
Draft Initial definition.

Browser compatibility

BCD tables only load in the browser