dom/webidl/MozTetheringManager.webidl
author Ben Kelly <ben@wanderview.com>
Tue, 13 Sep 2016 20:14:02 -0700
changeset 313770 12ee5e6a9c9d06c102e2f8bb8ad3ed31494d857a
parent 305167 20a6fd076505809220e031dd594e03029459a664
permissions -rw-r--r--
Bug 1300658 P5 Make service worker APIs use the MainThreadTaskQueue. r=baku

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

enum TetheringType {
  "bluetooth",
  "usb",
  "wifi"
};

enum SecurityType {
  "open",
  "wpa-psk",
  "wpa2-psk"
};

dictionary WifiTetheringConfig {
  DOMString ssid;
  SecurityType security;
  DOMString key;
};

dictionary TetheringConfiguration {
  DOMString ip;
  DOMString prefix;
  DOMString startIp;
  DOMString endIp;
  DOMString dns1;
  DOMString dns2;
  WifiTetheringConfig wifiConfig;
};

[JSImplementation="@mozilla.org/tetheringmanager;1",
 NavigatorProperty="mozTetheringManager",
 ChromeOnly]
interface MozTetheringManager {
  /**
   * Enable/Disable tethering.
   * @param enabled True to enable tethering, False to disable tethering.
   * @param type Tethering type to enable/disable.
   * @param config Configuration should have following fields when enable is True:
   *               - ip ip address.
   *               - prefix mask length.
   *               - startIp start ip address allocated by DHCP server for tethering.
   *               - endIp end ip address allocated by DHCP server for tethering.
   *               - dns1 first DNS server address.
   *               - dns2 second DNS server address.
   *               - wifiConfig wifi tethering configuration
   *                  - ssid SSID network name.
   *                  - security open, wpa-psk or wpa2-psk.
   *                  - key password for wpa-psk or wpa2-psk.
   *               config should not be set when enabled is False.
   */
  Promise<any> setTetheringEnabled(boolean enabled,
                                   TetheringType type,
                                   optional TetheringConfiguration config);
};