B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor: Difference between revisions

← Older edit

B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor (view source)

Revision as of 09:32, 9 September 2015

878 bytes added , 9 September 2015

revise description of readValue in GattDescriptor

Joliu

120

edits

@@ Line 10: / Line 10: @@
   {
     readonly attribute [[B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic#BluetoothGattCharacteristic|BluetoothGattCharacteristic]] [[B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor#characteristic|characteristic]];
-    readonly attribute DOMString                   [[B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor#uuid|uuid]];
+    readonly attribute DOMString [[B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor#uuid|uuid]];
-    readonly attribute ArrayBuffer?                [[B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor#value|value]];
+    readonly attribute ArrayBuffer? [[B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor#value|value]];
+   [Cached, Constant] readonly attribute [[B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic#GattPermissions|GattPermissions]] [[B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor#permissions|permissions]];
-    [NewObject, Throws] Promise<ArrayBuffer> [[B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor#readValue.28.29|readValue()]];
+    [NewObject] Promise<ArrayBuffer> [[B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor#readValue.28.29|readValue()]];
-    [NewObject, Throws] Promise<ArrayBuffer> [[B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor#writeValue.28ArrayBuffer value.29|writeValue(ArrayBuffer value)]];
+    [NewObject] Promise<void> [[B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor#writeValue.28ArrayBuffer value.29|writeValue(ArrayBuffer value)]];
   };
@@ Line 21: / Line 22: @@
 * [[B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor#uuid|BluetoothGattDescriptor.uuid]]
 * [[B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor#value|BluetoothGattDescriptor.value]]
+* [[B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor#permissions|BluetoothGattDescriptor.permissions]]
 === characteristic ===
@@ Line 55: / Line 57: @@
 ; Default Value
 : null pointer
+=== permissions ===
+; Description
+: A bit mask which describes allowed operations on the characteristic.
+; Value Type
+: dictionary [[B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic#GattPermissions|GattPermissions]]
+; Default Value
+: 0
 == Methods ==
@@ Line 63: / Line 76: @@
 ; Description
-: Read the descriptor value from the remote device. The cached value property is also updated after retrieving the value.
+: Read the descriptor value from either remote device (client role) or the local device (server role). In client mode, the cached value property is also updated after retrieving the value from the remote GATT server.
 ; Return
-: A Promise to indicate whether the operation is resolved or rejected. The Promise is resolved along with the value retrieved from the remote device.
+: A Promise to indicate whether the operation is resolved or rejected. The Promise is resolved along with the value retrieved from the remote device or local device.
 === writeValue(ArrayBuffer value) ===
 ; Description
-: Write the descriptor value to the remote device.
+: Write the descriptor value to the GATT server. If the local device is the GATT client, the value will be written to the remote GATT server. On the other hand, if the local device is the GATT server, the value will be written to [[B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor#value|value]].
 ; Parameter
 : ''value''
-:: Desired value to be written to the remote device.
+:: Desired value to be written to the GATT server.
 ; Return
 : A Promise to indicate whether the operation is resolved or rejected. The Promise is resolved along with the descriptor value after this write operation.