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

Latest revision as of 01:49, 25 January 2016

Overview

BluetoothDeviceEvent is carried as the parameter of remote device found, paired, and unpaired event handlers, including discoveryHandle.ondevicefound, adapter.ondevicepaired, adapter.ondeviceunpaired. Applications can get the found/paired BluetoothDevice object or the address of unpaired remote device.

Interface

[CheckPermissions="bluetooth"]
interface BluetoothDeviceEvent : Event
{
  readonly attribute BluetoothDevice? device;
  readonly attribute DOMString? address;
};

Properties

device

Description: The paired remote device. The property is null for event handler adapter.ondeviceunpaired since the event handler only requires the address of unpaired device.

Value type: BluetoothDevice

address

Description: The address of unpaired remote device. The property is empty string for event handlers discoveryHandle.ondevicefound and adapter.ondevicepaired since BluetoothDevice already has property address.

Value type: DOMString

@@ Line 1: / Line 1: @@
 == Overview ==
-The BluetoothDeviceEvent API provides access to a Bluetooth device when the ''devicefound'' event is fired. See [https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothAdapter#startDiscovery.28.29 BluetoothStartDiscoveryRequest.ondevicefound] for more information. <br>
+'''BluetoothDeviceEvent''' is carried as the parameter of remote device found, paired, and unpaired event handlers, including [[B2G/Bluetooth/WebBluetooth-v2/BluetoothDiscoveryHandle#ondevicefound|discoveryHandle.ondevicefound]], [[B2G/Bluetooth/WebBluetooth-v2/BluetoothAdapter#ondevicepaired|adapter.ondevicepaired]], [[B2G/Bluetooth/WebBluetooth-v2/BluetoothAdapter#ondeviceunpaired|adapter.ondeviceunpaired]]. Applications can get the found/paired [[B2G/Bluetooth/WebBluetooth-v2/BluetoothDevice#BluetoothDevice|BluetoothDevice]] object or the address of unpaired remote device.
-This interface inherits from the [https://developer.mozilla.org/en-US/docs/Web/API/Event Event] interface.
 == Interface ==
+ [CheckPermissions="bluetooth"]
   interface BluetoothDeviceEvent : Event
   {
-    readonly attribute BluetoothDevice device;
+    readonly attribute [[B2G/Bluetooth/WebBluetooth-v2/BluetoothDevice#BluetoothDevice|BluetoothDevice]]? [[B2G/Bluetooth/WebBluetooth-v2/BluetoothDeviceEvent#device|device]];
+   readonly attribute DOMString? [[B2G/Bluetooth/WebBluetooth-v2/BluetoothDeviceEvent#address|address]];
   };
-== Attributes ==
+== Properties ==
-* [https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothDeviceEvent#adapter BluetoothAdapterEvent.device]
+* [[B2G/Bluetooth/WebBluetooth-v2/BluetoothDeviceEvent#device|BluetoothDeviceEvent.device]]
+* [[B2G/Bluetooth/WebBluetooth-v2/BluetoothDeviceEvent#address|BluetoothDeviceEvent.address]]
 === device ===
 ; Description
-: A BluetoothDevice object representing the device to access
+: The paired remote device. The property is null for event handler [[B2G/Bluetooth/WebBluetooth-v2/BluetoothAdapter#ondeviceunpaired|adapter.ondeviceunpaired]] since the event handler only requires the address of unpaired device.
 ; Value type
-: [https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothDevice BluetoothDevice]
+: [[B2G/Bluetooth/WebBluetooth-v2/BluetoothDevice#BluetoothDevice|BluetoothDevice]]
+=== address ===
+; Description
+: The address of unpaired remote device. The property is empty string for event handlers [[B2G/Bluetooth/WebBluetooth-v2/BluetoothDiscoveryHandle#ondevicefound|discoveryHandle.ondevicefound]] and [[B2G/Bluetooth/WebBluetooth-v2/BluetoothAdapter#ondevicepaired|adapter.ondevicepaired]] since [[B2G/Bluetooth/WebBluetooth-v2/BluetoothDevice#BluetoothDevice|BluetoothDevice]] already has property [[B2G/Bluetooth/WebBluetooth-v2/BluetoothDevice#address|address]].
+; Value type
+: DOMString