B2G/Bluetooth/WebBluetooth-v2/BluetoothGattService

From MozillaWiki
Jump to navigation Jump to search

Overview

BluetoothGattService represents the service provided by GATT server. BluetoothGattService consists of the service definition, a list of included services which this service references, and a list of characteristics in this service.

Interfaces

BluetoothGattService

BluetoothGattService

[CheckPermissions="bluetooth"]
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, Throws] Promise<void> addIncludedService(BluetoothGattService aService);
  [NewObject, Throws] Promise<BluetoothGattCharacteristic> addCharacteristic(DOMString aUuid, CharacteristicPermission aPermissions, CharacteristicProperty aProperties)
};

Properties

characteristics

Description
A cached array of charactertistics contained in this service.
Value Type
sequence<BluetoothGattCharacteristic>
Default Value
Empty array (array with length = 0)

includedServices

Description
A cached array of included services referenced by this service.
Value Type
sequence<BluetoothGattService>
Default Value
Empty array (array with length = 0)

isPrimary

Description
Indicate whether this is a primary or secondary service.
Value Type
boolean
Default Value
false

uuid

Description
This property stores the UUID of this service.
Value Type
DOMString
Default Value
Empty string ("")

instanceId

Description
This property stores the instance id of this service.
Value Type
unsigned short
Default Value
0
Retrieved from "https://wiki.mozilla.org/index.php?title=B2G/Bluetooth/WebBluetooth-v2/BluetoothGattService&oldid=1033659"