BluetoothRemoteGATTDescriptor

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The BluetoothRemoteGATTDescriptor interface of the Web Bluetooth API provides a GATT Descriptor, which provides further information about a characteristic’s value.

This page describes the W3C Community Group Web Bluetooth API. For the Firefox OS Bluetooth API, see BluetoothGattDescriptor (Firefox OS).

Interface

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

Properties

BluetoothRemoteGATTDescriptor.characteristicRead only
Returns the BluetoothRemoteGATTCharacteristic this descriptor belongs to.
BluetoothRemoteGATTDescriptor.uuidRead only
Returns the UUID of the characteristic descriptor, for example '00002902-0000-1000-8000-00805f9b34fb' for theClient Characteristic Configuration descriptor.
BluetoothRemoteGATTDescriptor.valueRead only
Returns the currently cached descriptor value. This value gets updated when the value of the descriptor is read.

Methods

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

Specifications

Specification Status Comment
Web Bluetooth
The definition of 'BluetoothRemoteGATTDescriptor' in that specification.
Draft Initial definition.

Browser Compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidEdge MobileFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
Basic support
Experimental
Chrome Full support 57
Notes
Full support 57
Notes
Notes macOS only.
Full support 57
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 57: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled). To change preferences in Chrome, visit chrome://flags.
Full support 70
Notes
Notes Windows 10.
Edge ? Firefox ? IE ? Opera Full support 44
Notes
Full support 44
Notes
Notes macOS only.
Full support 44
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 44: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled).
Full support 57
Notes
Notes Windows 10.
Safari ? WebView Android No support NoChrome Android Full support 57Edge Mobile ? Firefox Android ? Opera Android Full support 44Safari iOS ? Samsung Internet Android ?
characteristic
Experimental
Chrome Full support 57
Notes
Full support 57
Notes
Notes macOS only.
Full support 57
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 57: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled). To change preferences in Chrome, visit chrome://flags.
Full support 70
Notes
Notes Windows 10.
Edge ? Firefox ? IE ? Opera Full support 44
Notes
Full support 44
Notes
Notes macOS only.
Full support 44
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 44: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled).
Full support 57
Notes
Notes Windows 10.
Safari ? WebView Android No support NoChrome Android Full support 57Edge Mobile ? Firefox Android ? Opera Android Full support 44Safari iOS ? Samsung Internet Android ?
uuid
Experimental
Chrome Full support 57
Notes
Full support 57
Notes
Notes macOS only.
Full support 57
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 57: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled). To change preferences in Chrome, visit chrome://flags.
Full support 70
Notes
Notes Windows 10.
Edge ? Firefox ? IE ? Opera Full support 44
Notes
Full support 44
Notes
Notes macOS only.
Full support 44
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 44: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled).
Full support 57
Notes
Notes Windows 10.
Safari ? WebView Android No support NoChrome Android Full support 57Edge Mobile ? Firefox Android ? Opera Android Full support 44Safari iOS ? Samsung Internet Android ?
value
Experimental
Chrome Full support 57
Notes
Full support 57
Notes
Notes macOS only.
Full support 57
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 57: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled). To change preferences in Chrome, visit chrome://flags.
Full support 70
Notes
Notes Windows 10.
Edge ? Firefox ? IE ? Opera Full support 44
Notes
Full support 44
Notes
Notes macOS only.
Full support 44
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 44: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled).
Full support 57
Notes
Notes Windows 10.
Safari ? WebView Android No support NoChrome Android Full support 57Edge Mobile ? Firefox Android ? Opera Android Full support 44Safari iOS ? Samsung Internet Android ?
readValue
Experimental
Chrome Full support 57
Notes
Full support 57
Notes
Notes macOS only.
Full support 57
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 57: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled). To change preferences in Chrome, visit chrome://flags.
Full support 70
Notes
Notes Windows 10.
Edge ? Firefox ? IE ? Opera Full support 44
Notes
Full support 44
Notes
Notes macOS only.
Full support 44
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 44: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled).
Full support 57
Notes
Notes Windows 10.
Safari ? WebView Android No support NoChrome Android Full support 57Edge Mobile ? Firefox Android ? Opera Android Full support 44Safari iOS ? Samsung Internet Android ?
writeValue
Experimental
Chrome Full support 57
Notes
Full support 57
Notes
Notes macOS only.
Full support 57
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 57: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled). To change preferences in Chrome, visit chrome://flags.
Full support 70
Notes
Notes Windows 10.
Edge ? Firefox ? IE ? Opera Full support 44
Notes
Full support 44
Notes
Notes macOS only.
Full support 44
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 44: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled).
Full support 57
Notes
Notes Windows 10.
Safari ? WebView Android No support NoChrome Android Full support 57Edge Mobile ? Firefox Android ? Opera Android Full support 44Safari iOS ? Samsung Internet Android ?

Legend

Full support  
Full support
No support  
No support
Compatibility unknown  
Compatibility unknown
Experimental. Expect behavior to change in the future.
Experimental. Expect behavior to change in the future.
See implementation notes.
See implementation notes.
User must explicitly enable this feature.
User must explicitly enable this feature.

Document Tags and Contributors

Contributors to this page: ExE-Boss, fscholz, jpmedley, chrisdavidmills
Last updated by: ExE-Boss,