dom/webidl/MozMobileConnectionInfo.webidl

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   3  * You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 enum MobileConnectionState {"notSearching", "searching", "denied", "registered"};
   6 enum MobileConnectionType {"gsm", "gprs", "edge", "umts", "hsdpa", "hsupa",
   7                            "hspa", "hspa+", "is95a", "is95b", "1xrtt", "evdo0",
   8                            "evdoa", "evdob", "ehrpd", "lte"};
   9
  10 [Pref="dom.mobileconnection.enabled"]
  11 interface MozMobileConnectionInfo
  12 {
  13   /**
  14    * State of the connection.
  15    */
  16   readonly attribute MobileConnectionState? state;
  17
  18   /**
  19    * Indicates whether the connection is ready.
  20    *
  21    * Note: The meaning of "connection ready" for data and voice are different.
  22    *       - Data: the "default" data connection is established or not.
  23    *       - Voice: voice is registered to network or not.
  24    */
  25   readonly attribute boolean connected;
  26
  27   /**
  28    * Indicates whether only emergency calls are possible.
  29    *
  30    * This flag is only relevant to voice connections and when 'connected' is
  31    * false.
  32    */
  33   readonly attribute boolean emergencyCallsOnly;
  34
  35   /**
  36    * Indicates whether the connection is going through a foreign operator
  37    * (roaming) or not.
  38    */
  39   readonly attribute boolean roaming;
  40
  41   /**
  42    * Network operator information.
  43    */
  44   readonly attribute MozMobileNetworkInfo? network;
  45
  46   /**
  47    * Type of connection.
  48    */
  49   readonly attribute MobileConnectionType? type;
  50
  51   /**
  52    * Signal strength in dBm, or null if no service is available.
  53    */
  54   readonly attribute long? signalStrength;
  55
  56   /**
  57    * Signal strength, represented linearly as a number between 0 (weakest
  58    * signal) and 100 (full signal).
  59    */
  60   readonly attribute unsigned short? relSignalStrength;
  61
  62   /**
  63    * Cell location information.
  64    */
  65   readonly attribute MozMobileCellInfo? cell;
  66 };