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

From MozillaWiki
Jump to navigation Jump to search
(replace any by sequence<DOMString> in attr event)
 
(23 intermediate revisions by 3 users not shown)
Line 1: Line 1:
== Overview ==
== Overview ==
BluetoothAttributeEvent is carried as the argument of attribute chagned event handlers, such as [https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothAdapter#onattributechanged adapter.onattributechanged] and [https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothDevice#onattributechanged device.onattributechanged]. Applications can get information about the changed attribute and its updated value.
'''BluetoothAttributeEvent''' is carried as the parameter of attribute chagned event handlers, including [[B2G/Bluetooth/WebBluetooth-v2/BluetoothManager#onattributechanged|manager.onattributechanged]], [[B2G/Bluetooth/WebBluetooth-v2/BluetoothAdapter#onattributechanged|adapter.onattributechanged]], and [[B2G/Bluetooth/WebBluetooth-v2/BluetoothDevice#onattributechanged|device.onattributechanged]]. Applications can get information about the changed attributes to query the updated values.


== Interface ==
== Interface ==
[CheckPermissions="bluetooth"]
  interface BluetoothAttributeEvent : Event
  interface BluetoothAttributeEvent : Event
  {
  {
   readonly attribute short attribute;
   [Cached, Constant] readonly attribute sequence<DOMString> [[B2G/Bluetooth/WebBluetooth-v2/BluetoothAttributeEvent#attrs|attrs]];
  readonly attribute any  value;
  };
  };


== Attributes ==
== Properties ==
* [https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothAttributeEvent#attribute BluetoothAttributeEvent.attribute]
* [[B2G/Bluetooth/WebBluetooth-v2/BluetoothAttributeEvent#attrs|BluetoothAttributeEvent.attrs]]
* [https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothAttributeEvent#value BluetoothAttributeEvent.value]


=== attribute ===
=== attrs ===
; Description
; Description
: The changed attribute's enumeration value.
: The array of changed attribute's enumeration value. The enumeration values are either [[B2G/Bluetooth/WebBluetooth-v2/BluetoothManager#BluetoothManagerAttribute|BluetoothManagerAttribute]], [[B2G/Bluetooth/WebBluetooth-v2/BluetoothAdapter#BluetoothAdapterAttribute|BluetoothAdapterAttribute]], or [[B2G/Bluetooth/WebBluetooth-v2/BluetoothDevice#BluetoothDeviceAttribute|BluetoothDeviceAttribute]].


; Value type
; Value type
: short
: sequence<DOMString>
 
; Default value
: -1
 
=== value ===
; Description
: The updated value of the changed attribute. Its type depends on [https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothAttributeEvent#attribute attribute]'s type.
 
; Value type
: any
 
; Default value
: null

Latest revision as of 06:34, 24 April 2015

Overview

BluetoothAttributeEvent is carried as the parameter of attribute chagned event handlers, including manager.onattributechanged, adapter.onattributechanged, and device.onattributechanged. Applications can get information about the changed attributes to query the updated values.

Interface

[CheckPermissions="bluetooth"]
interface BluetoothAttributeEvent : Event
{
  [Cached, Constant] readonly attribute sequence<DOMString> attrs;
};

Properties

attrs

Description
The array of changed attribute's enumeration value. The enumeration values are either BluetoothManagerAttribute, BluetoothAdapterAttribute, or BluetoothDeviceAttribute.
Value type
sequence<DOMString>