This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
This page describes the W3C Community Group BluetoothRemoteGATTService, formerly called BluethoothGATTService. For the Firefox OS interface of the same name, see BluetoothGattService.
The BluetoothRemoteGATTService interface of the Web Bluetooth API represents a service provided by a GATT server, including a device, a list of referenced services, and a list of the characteristics of this service.
Interface
interface BluetoothRemoteGATTService : ServiceEventHandlers {
readonly attribute UUID uuid;
readonly attribute boolean isPrimary;
readonly attribute BluetoothDevice device;
Promise<BluetoothGATTCharacteristic> getCharacteristic(BluetoothCharacteristicUUID characteristic);
Promise<sequence<BluetoothGATTCharacteristic>> getCharacteristics(optional BluetoothCharacteristicUUID characteristic);
Promise<BluetoothGATTService> getIncludedService(BluetoothServiceUUID service);
Promise<sequence<BluetoothGATTService>> getIncludedServices(optional BluetoothServiceUUID service);
};
Properties
BluetoothRemoteGATTService.deviceRead only- Returns information about a Bluetooth device through an instance of
BluetoothDevice. BluetoothRemoteGATTService.isPrimaryRead only- Returns a
BooleanIndicating whether this is a primary or secondary service. BluetoothRemoteGATTService.uuidRead only- Returns a
DOMStringrepresenting the UUID of this service.
Methods
BluetoothRemoteGATTService.getCharacteristic()- Returns a
Promiseto an instance ofBluetoothGATTCharacteristicfor a given universally unique identifier (UUID). BluetoothRemoteGATTService.getCharacteristics()- Returns a
Promiseto anArrayofBluetoothGATTCharacteristicinstances for an optional universally unique identifier (UUID). BluetoothRemoteGATTService.getIncludedService()- Returns a
Promiseto an instance ofBluetoothRemoteGATTServicefor a given universally unique identifier (UUID). BluetoothRemoteGATTService.getIncludedServices()- Returns a
Promiseto anArrayofBluetoothRemoteGATTServiceinstances for an optional universally unique identifier (UUID).
Specifications
| Specification | Status | Comment |
|---|---|---|
| Web Bluetooth The definition of 'BluetoothRemoteGATTService' in that specification. |
Draft | Initial definition. |
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
| Feature | Chrome | Edge | Firefox | Internet Explorer | Opera | Safari |
|---|---|---|---|---|---|---|
| Basic support | 531 512 45 — 533 | ? | ? | ? | ? | ? |
device | No | ? | ? | ? | ? | ? |
getCharacteristic | 453 | ? | ? | ? | ? | ? |
getCharacteristics | No | ? | ? | ? | ? | ? |
getIncludedService | No | ? | ? | ? | ? | ? |
getIncludedServices | 531 51 — 532 45 — 533 | ? | ? | ? | ? | ? |
isPrimary | No | ? | ? | ? | ? | ? |
uuid | 453 | ? | ? | ? | ? | ? |
| Feature | Android webview | Chrome for Android | Edge mobile | Firefox for Android | Opera Android | iOS Safari | Samsung Internet |
|---|---|---|---|---|---|---|---|
| Basic support | No | 534 45 — 535 | ? | ? | ? | ? | ? |
device | No | No | ? | ? | ? | ? | ? |
getCharacteristic | No | No | ? | ? | ? | ? | ? |
getCharacteristics | No | No | ? | ? | ? | ? | ? |
getIncludedService | No | No | ? | ? | ? | ? | ? |
getIncludedServices | No | 534 45 — 535 | ? | ? | ? | ? | ? |
isPrimary | No | No | ? | ? | ? | ? | ? |
uuid | No | ? | ? | ? | ? | ? | ? |
1. Mac support added and Origin Trial.
2. Linux support.
3. Behind a preference flag in Chrome OS.
4. Origin Trial.
5. Behind a preference flag.