BluetoothRemoteGATTService - Web APIs

Experimental

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

BCD tables only load in the browser