BluetoothRemoteGATTDescriptor

Non-standard
This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.

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

In earlier versions of the spec, this was called BluetoothGATTDescriptor.

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.characteristic Read only: Returns the BluetoothRemoteGATTCharacteristic this descriptor belongs to.
BluetoothRemoteGATTDescriptor.uuid Read only: Returns the UUID of the characteristic descriptor, for example '00002902-0000-1000-8000-00805f9b34fb' for theClient Characteristic Configuration descriptor.
BluetoothRemoteGATTDescriptor.value Read 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.

Feature	Chrome	Firefox (Gecko)	Internet Explorer	Opera	Safari (WebKit)
Basic support	57	?	?	44	?

Feature	Android Webview	Chrome for Android	Firefox Mobile (Gecko)	Firefox OS	IE Mobile	Opera Mobile	Safari Mobile
Basic support	No support	57	?	?	?	44	?

Interface

Properties

Methods

Specifications

Browser Compatibility

Document Tags and Contributors