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
[CheckPermissions="bluetooth"] interface BluetoothGattDescriptor { readonly attribute BluetoothGattCharacteristic characteristic; readonly attribute DOMString uuid; readonly attribute ArrayBuffer? value; [Cached, Constant] readonly attribute Permissions permissions; [NewObject] Promise<ArrayBuffer> readValue(); [NewObject] Promise<void> writeValue(ArrayBuffer value); };
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
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
Document Tags and Contributors
Tags:
Contributors to this page:
chrisdavidmills
Last updated by:
chrisdavidmills,