BluetoothGattDescriptor (Firefox OS)

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

Interface overview

[CheckPermissions="bluetooth"]
interface BluetoothGattDescriptor
{
  readonly attribute <a href="https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic#BluetoothGattCharacteristic" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic">BluetoothGattCharacteristic</a> <a href="https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor#characteristic" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor">characteristic</a>;
  readonly attribute DOMString <a href="https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor#uuid" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor">uuid</a>;
  readonly attribute ArrayBuffer? <a href="https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor#value" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor">value</a>;
  [Cached, Constant] readonly attribute <a href="https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic#Permissions" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic">Permissions</a> <a href="https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor#permissions" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor">permissions</a>;

  [NewObject] Promise<ArrayBuffer> <a href="https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor#readValue.28.29" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor">readValue()</a>;
  [NewObject] Promise<void> <a href="https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor#writeValue.28ArrayBuffer_value.29" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor">writeValue(ArrayBuffer value)</a>;
};

Properties

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.

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.

 

Specifications

Browser Compatibility

See also

Using the Web Bluetooth API