B2G/Bluetooth/WebBluetooth-v2/BluetoothGattService

From MozillaWiki
< B2G‎ | Bluetooth‎ | WebBluetooth-v2
Revision as of 10:46, 21 August 2014 by Joliu (talk | contribs) (→‎BluetoothGattService)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Overview

TBD

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 int                                   instanceId;

  [NewObject, Throws]
  Promise<BluetoothGattCharacteristic> findCharacteristic(DOMString uuid);
};

Properties

characteristics

Description
A cached array of charactertistics contained in this service.
Value Type
sequence<BluetoothGattCharacteristic>
Default Value
An 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
interger
Default Value
0

Methods

findCharacteristic(DOMString uuid)

Description
The method finds a characteristic in this service by the given UUID.
When there are multiple characteristics with the same UUID existed in the service, the first one will be returned.
Parameters
uuid
UUID DOMString of the characteristic to seek for.
Return
A Promise to indicate whether the operation is resolved or rejected. If the Promise is resolved, it returns the target characteristic.
The Promise will be rejected if no characteristic with the given UUID is found.
Sample
TBD
Retrieved from "https://wiki.mozilla.org/index.php?title=B2G/Bluetooth/WebBluetooth-v2/BluetoothGattService&oldid=1007918"