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

From MozillaWiki
Jump to navigation Jump to search
(Created page with "== Overview == The BluetoothAdapterEvent API provides access to a Bluetooth adapter when the adapteradded event is fired. See [https://wiki.mozilla.org/B2G/Bluetooth/WebBlueto...")
 
 
(30 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Overview ==
== Overview ==
The BluetoothAdapterEvent API provides access to a Bluetooth adapter when the adapteradded event is fired. See [https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothAdapter#onadapteradded BluetoothAdapter.onadapteradded] for more information.
'''BluetoothAdapterEvent''' is carried as the parameter of [[B2G/Bluetooth/WebBluetooth-v2/BluetoothManager#onadapteradded|manager.onadapteradded]] and [[B2G/Bluetooth/WebBluetooth-v2/BluetoothManager#onadapterremoved|manager.onadapterremoved]] event handlers. Applications can get the added [[B2G/Bluetooth/WebBluetooth-v2/BluetoothAdapter|BluetoothAdapter]] object or the address of removed adapter.


== Interface ==
== Interface ==
[CheckPermissions="bluetooth"]
  interface BluetoothAdapterEvent : Event
  interface BluetoothAdapterEvent : Event
  {
  {
   readonly attribute BluetoothAdapter adapter;
   readonly attribute BluetoothAdapter? [[B2G/Bluetooth/WebBluetooth-v2/BluetoothAdapterEvent#adapter|adapter]];
  readonly attribute DOMString?        [[B2G/Bluetooth/WebBluetooth-v2/BluetoothAdapterEvent#address|address]];
  };
  };


== Attributes ==
== Properties ==
* [https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothAdapterEvent#adapter BluetoothAdapterEvent.adapter]
* [[B2G/Bluetooth/WebBluetooth-v2/BluetoothAdapterEvent#adapter|BluetoothAdapterEvent.adapter]]
* [[B2G/Bluetooth/WebBluetooth-v2/BluetoothAdapterEvent#address|BluetoothAdapterEvent.address]]


=== adapter ===
=== adapter ===
; Description
; Description
: A BluetoothAdapter object representing the physical interface which is used to interact with local Bluetooth device.
: The added adapter. The property is null for event handler [[B2G/Bluetooth/WebBluetooth-v2/BluetoothManager#onadapterremoved|manager.onadapterremoved]] since the corresponding [[B2G/Bluetooth/WebBluetooth-v2/BluetoothAdapter|BluetoothAdapter]] is already removed.


; Value type
; Value type
: BluetoothAdapter
: [[B2G/Bluetooth/WebBluetooth-v2/BluetoothAdapter|BluetoothAdapter]]
 
=== address ===
; Description
: The address of removed adapter. The property is empty string for event handler [[B2G/Bluetooth/WebBluetooth-v2/BluetoothManager#onadapteradded|manager.onadapteradded]] since [[B2G/Bluetooth/WebBluetooth-v2/BluetoothAdapter|BluetoothAdapter]] already has property [[B2G/Bluetooth/WebBluetooth-v2/BluetoothAdapter#address|address]].
 
; Value type
: DOMString

Latest revision as of 01:50, 25 January 2016

Overview

BluetoothAdapterEvent is carried as the parameter of manager.onadapteradded and manager.onadapterremoved event handlers. Applications can get the added BluetoothAdapter object or the address of removed adapter.

Interface

[CheckPermissions="bluetooth"]
interface BluetoothAdapterEvent : Event
{
  readonly attribute BluetoothAdapter? adapter;
  readonly attribute DOMString?        address;
};

Properties

adapter

Description
The added adapter. The property is null for event handler manager.onadapterremoved since the corresponding BluetoothAdapter is already removed.
Value type
BluetoothAdapter

address

Description
The address of removed adapter. The property is empty string for event handler manager.onadapteradded since BluetoothAdapter already has property address.
Value type
DOMString
Retrieved from "https://dev.wikimo.nonprod.webservices.mozgcp.net/index.php?title=B2G/Bluetooth/WebBluetooth-v2/BluetoothAdapterEvent&oldid=1114055"