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 AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
BluetoothRemoteGATTService
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 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 NoIE No support NoOpera 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 No support NoWebView Android No support NoChrome Android Full support 56Firefox Android No support NoOpera Android Full support 43Safari iOS No support NoSamsung Internet Android Full support 6.0
device
Experimental
Chrome No support NoEdge No support NoFirefox No support NoIE No support NoOpera 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 No support NoWebView Android No support NoChrome Android No support NoFirefox Android No support NoOpera Android Full support 43Safari iOS No support NoSamsung Internet Android No support No
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 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 NoIE No support NoOpera 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 No support NoWebView Android No support NoChrome Android Full support 56Firefox Android No support NoOpera Android Full support 43Safari iOS No support NoSamsung Internet Android Full support 6.0
getCharacteristics
Experimental
Chrome No support NoEdge No support NoFirefox No support NoIE No support NoOpera No support NoSafari No support NoWebView Android No support NoChrome Android No support NoFirefox Android No support NoOpera Android No support NoSafari iOS No support NoSamsung Internet Android No support No
getIncludedService
Experimental
Chrome No support NoEdge No support NoFirefox No support NoIE No support NoOpera No support NoSafari No support NoWebView Android No support NoChrome Android No support NoFirefox Android No support NoOpera Android No support NoSafari iOS No support NoSamsung Internet Android No support No
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 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 NoIE No support NoOpera 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 No support NoWebView Android No support NoChrome Android Full support 56Firefox Android No support NoOpera Android Full support 43Safari iOS No support NoSamsung Internet Android Full support 6.0
isPrimary
Experimental
Chrome No support NoEdge No support NoFirefox No support NoIE No support NoOpera No support NoSafari No support NoWebView Android No support NoChrome Android No support NoFirefox Android No support NoOpera Android No support NoSafari iOS No support NoSamsung Internet Android No support No
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 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 NoIE No support NoOpera 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 No support NoWebView Android No support NoChrome Android Full support 56Firefox Android No support NoOpera Android Full support 43Safari iOS No support NoSamsung Internet Android Full support 6.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.