BluetoothGattDescriptor (Firefox OS)

This API is available on Firefox OS for internal applications only.

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

Interface overview

interface BluetoothGattDescriptor
  readonly attribute <a href="" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic">BluetoothGattCharacteristic</a> <a href="" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor">characteristic</a>;
  readonly attribute DOMString <a href="" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor">uuid</a>;
  readonly attribute ArrayBuffer? <a href="" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor">value</a>;
  [Cached, Constant] readonly attribute <a href="" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic">Permissions</a> <a href="" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor">permissions</a>;

  [NewObject] Promise<ArrayBuffer> <a href="" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor">readValue()</a>;
  [NewObject] Promise<void> <a href="" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor">writeValue(ArrayBuffer value)</a>;


BluetoothGattDescriptor.characteristic Read only
Returns the BluetoothGattCharacteristic object representing the characteristic this descriptor belongs to.
BluetoothGattDescriptor.uuid Read only
Returns the UUID of this descriptor.
BluetoothGattDescriptor.value Read only
Stores the cached value of this descriptor. This value can be updated via the BluetoothGattDescriptor.readValue() method.
BluetoothGattDescriptor.permissions Read only
Returns a bit mask that describes the operations allowed on the characteristic.


Reads the descriptor value from the remote device. The cached BluetoothGattDescriptor.value is also updated after retrieving the value.
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.


Specification Status Comment
Web Bluetooth
The definition of 'BluetoothGattDescriptor' in that specification.
Draft Rough draft; not part of any official specification yet. It should be discussed as part of the W3C's System Applications Working Group.

Browser Compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support No support No support No support No support No support
Feature Android Android Webview Firefox Mobile (Gecko) Firefox OS IE Mobile Opera Mobile Safari Mobile Chrome for Android
Basic support No support No support No support 2.1 No support No support No support No support


See also

Using the Web Bluetooth API


© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.

API B2G Bluetooth BluetoothGattDescriptor Certified Firefox OS Interface Non-standard Reference Web Bluetooth