B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor

From MozillaWiki
Jump to navigation Jump to search

Overview

BluetoothGattDescriptor represents a GATT descriptor, which contains related information about a characteristic value.

Interfaces

BluetoothGattDescriptor

BluetoothGattDescriptor

[CheckPermissions="bluetooth"]
interface BluetoothGattDescriptor
{
  readonly attribute BluetoothGattCharacteristic characteristic;
  readonly attribute DOMString uuid;
  readonly attribute ArrayBuffer? value;
  [Cached, Constant] readonly attribute Permissions permissions;

  [NewObject, Throws] Promise<ArrayBuffer> readValue();
  [NewObject, Throws] Promise<ArrayBuffer> writeValue(ArrayBuffer value);
};

Properties

characteristic

Description
The characteristic which this descriptor belongs to.
Value Type
BluetoothGattCharacteristic
Default Value
null pointer

uuid

Description
This property stores the UUID of this descriptor.
Value Type
DOMString
Default Value
Empty string ("")

value

Description
The cached value of this descriptor.
This value can be updated via readValue() method.
Value Type
ArrayBuffer or null
Default Value
null pointer

permissions

Description
A bit mask which describes allowed operations on the characteristic.
Value Type
dictionary Permissions
Default Value
0

Methods

readValue()

Description
Read the descriptor value from the remote device. The cached value property is also updated after retrieving the value.
Return
A Promise to indicate whether the operation is resolved or rejected. The Promise is resolved along with the value retrieved from the remote device.

writeValue(ArrayBuffer value)

Description
Write the descriptor value to the remote device.
Parameter
value
Desired value to be written to the remote device.
Return
A Promise to indicate whether the operation is resolved or rejected. The Promise is resolved along with the descriptor value after this write operation.
Retrieved from "https://wiki.allizom.org/index.php?title=B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor&oldid=1035080"