BluetoothRemoteGATTCharacteristic
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The BluetoothRemoteGattCharacteristic interface of the Web Bluetooth API represents a GATT Characteristic, which is a basic data element that provides further information about a peripheral's service.
Instance properties
BluetoothRemoteGATTCharacteristic.serviceRead only Experimental-
Returns the
BluetoothRemoteGATTServicethis characteristic belongs to. BluetoothRemoteGATTCharacteristic.uuidRead only Experimental-
Returns a string containing the UUID of the characteristic, for example
'00002a37-0000-1000-8000-00805f9b34fb'for the Heart Rate Measurement characteristic. BluetoothRemoteGATTCharacteristic.propertiesRead only Experimental-
Returns the properties of this characteristic.
BluetoothRemoteGATTCharacteristic.valueRead only Experimental-
The currently cached characteristic value. This value gets updated when the value of the characteristic is read or updated via a notification or indication.
Instance methods
BluetoothRemoteGATTCharacteristic.getDescriptor()Experimental-
Returns a
Promisethat resolves to the firstBluetoothRemoteGATTDescriptorfor a given descriptor UUID. BluetoothRemoteGATTCharacteristic.getDescriptors()Experimental-
Returns a
Promisethat resolves to anArrayof allBluetoothRemoteGATTDescriptorobjects for a given descriptor UUID. BluetoothRemoteGATTCharacteristic.readValue()Experimental-
Returns a
Promisethat resolves to anDataViewholding a duplicate of thevalueproperty if it is available and supported. Otherwise it throws an error. BluetoothRemoteGATTCharacteristic.writeValue()Deprecated-
Sets the
valueproperty to the bytes contained in a givenArrayBuffer, writes the characteristic value with optional response, and returns the resultingPromise. BluetoothRemoteGATTCharacteristic.writeValueWithResponse()Experimental-
Sets the
valueproperty to the bytes contained in a givenArrayBuffer, writes the characteristic value with required response, and returns the resultingPromise. BluetoothRemoteGATTCharacteristic.writeValueWithoutResponse()Experimental-
Sets the
valueproperty to the bytes contained in a givenArrayBuffer, writes the characteristic value without response, and returns the resultingPromise. BluetoothRemoteGATTCharacteristic.startNotifications()Experimental-
Returns a
Promisethat resolves whennavigator.bluetoothis added to the active notification context. BluetoothRemoteGATTCharacteristic.stopNotifications()Experimental-
Returns a
Promisethat resolves whennavigator.bluetoothis removed from the active notification context.
Events
characteristicvaluechangedExperimental-
Fired on a
BluetoothRemoteGATTCharacteristicwhen its value changes.
Specifications
| Specification |
|---|
| Web Bluetooth> # bluetoothgattcharacteristic-interface> |
Browser compatibility
Loading...