BluetoothRemoteGATTService

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 Boolean Indicating whether this is a primary or secondary service. 
BluetoothRemoteGATTService.uuidRead only
Returns a DOMString representing the UUID of this service.

Methods

BluetoothRemoteGATTService.getCharacteristic()
Returns a Promise to an instance of BluetoothGATTCharacteristic for a given universally unique identifier (UUID).
BluetoothRemoteGATTService.getCharacteristics()
Returns a Promise to an Array of BluetoothGATTCharacteristic instances for an optional universally unique identifier (UUID).
BluetoothRemoteGATTService.getIncludedService()
Returns a Promise to an instance of BluetoothRemoteGATTService for a given universally unique identifier (UUID).
BluetoothRemoteGATTService.getIncludedServices()
Returns a Promise to an Array of BluetoothRemoteGATTService instances 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

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidEdge MobileFirefox for AndroidOpera for AndroidiOS SafariSamsung Internet
Basic support
Experimental
Chrome Full support 56
Notes
Full support 56
Notes
Notes macOS only.
Full support 56
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 56: 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 43
Notes
Full support 43
Notes
Notes macOS only.
Full support 43
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 43: 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 56Edge Mobile ? Firefox Android ? Opera Android Full support 43Safari iOS ? Samsung Internet Android ?
device
Experimental
Chrome No support NoEdge ? Firefox ? IE ? Opera Full support 43
Notes
Full support 43
Notes
Notes macOS only.
Full support 43
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 43: 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 No support NoEdge Mobile ? Firefox Android ? Opera Android Full support 43Safari iOS ? Samsung Internet Android ?
getCharacteristic
Experimental
Chrome Full support 56
Notes
Full support 56
Notes
Notes macOS only.
Full support 56
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 56: 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 43
Notes
Full support 43
Notes
Notes macOS only.
Full support 43
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 43: 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 56Edge Mobile ? Firefox Android ? Opera Android Full support 43Safari iOS ? Samsung Internet Android ?
getCharacteristics
Experimental
Chrome No support NoEdge ? Firefox ? IE ? Opera ? Safari ? WebView Android No support NoChrome Android No support NoEdge Mobile ? Firefox Android ? Opera Android ? Safari iOS ? Samsung Internet Android ?
getIncludedService
Experimental
Chrome No support NoEdge ? Firefox ? IE ? Opera ? Safari ? WebView Android No support NoChrome Android No support NoEdge Mobile ? Firefox Android ? Opera Android ? Safari iOS ? Samsung Internet Android ?
getIncludedServices
Experimental
Chrome Full support 56
Notes
Full support 56
Notes
Notes macOS only.
Full support 56
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 56: 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 43
Notes
Full support 43
Notes
Notes macOS only.
Full support 43
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 43: 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 56Edge Mobile ? Firefox Android ? Opera Android Full support 43Safari iOS ? Samsung Internet Android ?
isPrimary
Experimental
Chrome No support NoEdge ? Firefox ? IE ? Opera ? Safari ? WebView Android No support NoChrome Android No support NoEdge Mobile ? Firefox Android ? Opera Android ? Safari iOS ? Samsung Internet Android ?
uuid
Experimental
Chrome Full support 56
Notes
Full support 56
Notes
Notes macOS only.
Full support 56
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 56: 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 43
Notes
Full support 43
Notes
Notes macOS only.
Full support 43
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 43: 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 56Edge Mobile ? Firefox Android ? Opera Android Full support 43Safari 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, chrisdavidmills, jpmedley
Last updated by: ExE-Boss,