BluetoothGattService (Firefox OS)

This API is available on Firefox OS for internal applications only.

The BluetoothGattService interface of the Web Bluetooth API represents a service provided by a GATT server, including the service definition, a list of referenced services, and a list of the characteristics of this service.

Interface overview

[CheckPermissions="bluetooth",
 Constructor(boolean isPrimary, DOMString uuid)]
interface BluetoothGattService
{
  [Cached, Pure] readonly attribute sequence<BluetoothGattCharacteristic> characteristics;
  [Cached, Pure] readonly attribute sequence<BluetoothGattService> includedServices;
  readonly attribute boolean isPrimary;
  readonly attribute DOMString uuid;
  readonly attribute unsigned short instanceId;
  [NewObject] Promise<BluetoothGattCharacteristic> addCharacteristic(DOMString uuid, Permission permissions, Properties properties, ArrayBuffer value);
  [NewObject] Promise<void> addIncludedService(BluetoothGattService service);
};

Properties

BluetoothGattService.characteristics Read only
Returns a cached array of BluetoothServiceCharacteristic objects representing the characteristics of this service.
BluetoothGattService.includedServices Read only
Returns a cached array of BluetoothGattService objects representing the included services referenced by this service.
BluetoothGattService.isPrimary Read only
Returns a Boolean Indicating whether this is a primary or secondary service. The default value is false, indicating a secondary service.
BluetoothGattService.uuid Read only
Returns a DOMString representing the UUID of this service.
BluetoothGattService.instanceId Read only
Returns a number representing the instance id of this service.

Methods

BluetoothGattService.addCharacteristic()
Adds a characteristic to this service.
BluetoothGattService.addIncludedService()
Adds a referenced included service to this service.

Specifications

Specification Status Comment
Web Bluetooth
The definition of 'BluetoothGattService' in that specification.
Draft Rough draft; not part of any official specification yet. It should be discussed as part of the W3C's System Applications Working Group.

Browser Compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support No support No support No support No support No support
Feature Android Android Webview Firefox Mobile (Gecko) Firefox OS IE Mobile Opera Mobile Safari Mobile Chrome for Android
Basic support No support No support No support 2.1 No support No support No support No support

 

See also

Using the Web Bluetooth API

Document Tags and Contributors

 Contributors to this page: chrisdavidmills
 Last updated by: chrisdavidmills,