Web/API/BluetoothRemoteGATTDescriptor

This is an experimental technologyCheck 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 [[../../../Archive/B2G_OS/API/BluetoothGattDescriptor|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 BluetoothThe definition of 'BluetoothRemoteGATTDescriptor' in that specification.	Draft	Initial definition.

Browser Compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`BluetoothRemoteGATTDescriptor` 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 Full support ≤79 Notes' Full support ≤79 Notes' Notes' macOS only. Full support ≤79 Notes' Disabled' Notes' Linux and versions of Windows earlier than 10. Disabled' From version ≤79: this feature is behind the `#enable-experimental-web-platform-features` preference (needs to be set to `enabled`). Full support ≤79 Notes' Notes' Windows 10.	Firefox No support No	IE No support No	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 No support No	WebView Android No support No	Chrome Android Full support 57	Firefox Android No support No	Opera Android Full support 44	Safari iOS No support No	Samsung Internet Android Full support 7.0
`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 Full support ≤79 Notes' Full support ≤79 Notes' Notes' macOS only. Full support ≤79 Notes' Disabled' Notes' Linux and versions of Windows earlier than 10. Disabled' From version ≤79: this feature is behind the `#enable-experimental-web-platform-features` preference (needs to be set to `enabled`). Full support ≤79 Notes' Notes' Windows 10.	Firefox No support No	IE No support No	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 No support No	WebView Android No support No	Chrome Android Full support 57	Firefox Android No support No	Opera Android Full support 44	Safari iOS No support No	Samsung Internet Android Full support 7.0
`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 Full support ≤79 Notes' Full support ≤79 Notes' Notes' macOS only. Full support ≤79 Notes' Disabled' Notes' Linux and versions of Windows earlier than 10. Disabled' From version ≤79: this feature is behind the `#enable-experimental-web-platform-features` preference (needs to be set to `enabled`). Full support ≤79 Notes' Notes' Windows 10.	Firefox No support No	IE No support No	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 No support No	WebView Android No support No	Chrome Android Full support 57	Firefox Android No support No	Opera Android Full support 44	Safari iOS No support No	Samsung Internet Android Full support 7.0
`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 Full support ≤79 Notes' Full support ≤79 Notes' Notes' macOS only. Full support ≤79 Notes' Disabled' Notes' Linux and versions of Windows earlier than 10. Disabled' From version ≤79: this feature is behind the `#enable-experimental-web-platform-features` preference (needs to be set to `enabled`). Full support ≤79 Notes' Notes' Windows 10.	Firefox No support No	IE No support No	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 No support No	WebView Android No support No	Chrome Android Full support 57	Firefox Android No support No	Opera Android Full support 44	Safari iOS No support No	Samsung Internet Android Full support 7.0
`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 Full support ≤79 Notes' Full support ≤79 Notes' Notes' macOS only. Full support ≤79 Notes' Disabled' Notes' Linux and versions of Windows earlier than 10. Disabled' From version ≤79: this feature is behind the `#enable-experimental-web-platform-features` preference (needs to be set to `enabled`). Full support ≤79 Notes' Notes' Windows 10.	Firefox No support No	IE No support No	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 No support No	WebView Android No support No	Chrome Android Full support 57	Firefox Android No support No	Opera Android Full support 44	Safari iOS No support No	Samsung Internet Android Full support 7.0
`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 Full support ≤79 Notes' Full support ≤79 Notes' Notes' macOS only. Full support ≤79 Notes' Disabled' Notes' Linux and versions of Windows earlier than 10. Disabled' From version ≤79: this feature is behind the `#enable-experimental-web-platform-features` preference (needs to be set to `enabled`). Full support ≤79 Notes' Notes' Windows 10.	Firefox No support No	IE No support No	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 No support No	WebView Android No support No	Chrome Android Full support 57	Firefox Android No support No	Opera Android Full support 44	Safari iOS No support No	Samsung Internet Android Full support 7.0

Legend

Full support: Full support
No support: No support
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.

BluetoothRemoteGATTDescriptor by Mozilla Contributors is licensed under CC-BY-SA 2.5.