BluetoothGATTDescriptor

 

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 BluetoothGATTDescriptor  interface of the Web Bluetooth API provides a GATT Descriptor, which provides further information about a characteristic’s value.

Interface

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

Properties

BluetoothGATTDescriptor.characteristic Read only
Returns the BluetoothGATTCharacteristic this descriptor belongs to.
BluetoothGATTDescriptor.uuid Read only
Returns the UUID of the characteristic descriptor, for example '00002902-0000-1000-8000-00805f9b34fb' for theClient Characteristic Configuration descriptor.
BluetoothGATTDescriptor.value Read only
Returns the currently cached descriptor value. This value gets updated when the value of the descriptor is read.

Methods

BluetoothGATTDescriptor.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.
BluetoothGATTDescriptor.writeValue()
Sets the value property to the bytes contained in an ArrayBuffer and returns a Promise.

Specifications

Specification Status Comment
Web Bluetooth Draft Initial definition.

Browser Compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support Not supported ? ? ? ?
Feature Android Android Webview Firefox Mobile (Gecko) Firefox OS IE Mobile Opera Mobile Safari Mobile Chrome for Android
Basic support Not supported Not supported ? ? ? ? ? Not supported

License

© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-us/docs/web/api/bluetoothgattdescriptor

API Bluetooth BluetoothGattDescriptor Interface Non-standard Reference Web Bluetooth API