Implement networkingPrivate.getDeviceStates

extensions/common/api/networking_private.idl

 // Copyright 2015 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 // The <code>chrome.networkingPrivate</code> API is used for configuring
 // network connections (Cellular, Ethernet, VPN, WiFi or WiMAX). This private
 // API is only valid if called from a browser or app associated with the
 // primary user. See the Open Network Configuration (ONC) documentation for
 // descriptions of properties: 
 // <a href="https://code.google.com/p/chromium/codesearch#chromium/src/components/onc/docs/onc_spec.html">
@@ skipping 22 matching lines @@
   };
 
   enum CaptivePortalStatus {
     Unknown, Offline, Online, Portal, ProxyAuthRequired
   };
 
   enum ConnectionStateType {
     Connected, Connecting, NotConnected
   };
 
+  enum DeviceStateType {
+    // Device is available but not initialized.
+    Uninitialized, 
+    // Device is intialized but not enabled.
+    Disabled, 
+    // Enabled state has been requested but has not completed.
+    Enabling,
+    // Device is enabled.
+    Enabled
+  };
+
   enum IPConfigType {
     DHCP, Static
   };
 
   enum NetworkType {
-    All, Bluetooth, Cellular, Ethernet, VPN, Wireless, WiFi, WiMAX
+    All, Cellular, Ethernet, VPN, Wireless, WiFi, WiMAX
   };
 
   dictionary APNProperties {
     DOMString? AccessPointName;
     DOMString? Language;
     DOMString? LocalizedName;
     DOMString? Name;
     DOMString? Password;
     DOMString? Username;
   };
 
   dictionary CellularConfigProperties {
     boolean? AutoConnect;
     APNProperties? APN;
 
     // Specifies which carrier to use for Cellular configurations that support
     // multiple carriers. May be set with $(ref:setProperties), but will be
     // ignored by $(ref:createConfiguration).
     DOMString? Carrier;
   };
 
   dictionary CellularStateProperties {
     ActivationStateType? ActivationState;
     DOMString? NetworkTechnology;
     DOMString? RoamingState;
     long? SignalStrength;
   };
 
+  dictionary DeviceStateProperties {
+    // Set if the device is enabled. True if the device is currently scanning.

[pneubeck (no reviews), 2015/04/09 09:41:22]

as mentioned in the test, this is not fully accurate

[stevenjb, 2015/04/09 16:20:25]

Acknowledged.

+    boolean? Scanning;
+
+    // The current state of the device.
+    DeviceStateType State;
+
+    // The network type associated with the device (Cellular, Ethernet, WiFi, or
+    // WiMAX).
+    NetworkType Type;
+  };
+
   dictionary EthernetStateProperties {
     DOMString Authentication;
   };
 
   dictionary IPConfigProperties {
     DOMString? Gateway;
     DOMString? IPAddress;
     DOMString[]? NameServers;
     long? RoutingPrefix;
     DOMString? Type;
@@ skipping 127 matching lines @@
 
   callback VoidCallback = void();
   callback BooleanCallback = void(boolean result);
   callback StringCallback = void(DOMString result);
   // TODO(stevenjb): Use NetworkProperties for |result| once defined.
   callback GetPropertiesCallback = void(object result);
   // TODO(stevenjb): Use ManagedNetworkProperties for |result| once defined.
   callback GetManagedPropertiesCallback = void(object result);
   callback GetStatePropertiesCallback = void(NetworkStateProperties result);
   callback GetNetworksCallback = void(NetworkStateProperties[] result);
+  callback GetDeviceStatesCallback = void(DeviceStateProperties[] result);
   callback GetEnabledNetworkTypesCallback = void(NetworkType[] result);
   callback CaptivePortalStatusCallback = void(CaptivePortalStatus result);
 
   // These functions all report failures via chrome.runtime.lastError.
   interface Functions {
     // Gets all the properties of the network with id networkGuid. Includes all
     // properties of the network (read-only and read/write values).
     // |networkGuid|: The GUID of the network to get properties for.
     // |callback|: Called with the network properties when received.
     static void getProperties(DOMString networkGuid,
@@ skipping 59 matching lines @@
     //     properties when received.
     static void getNetworks(NetworkFilter filter,
                             GetNetworksCallback callback);
 
     // Deprecated. Please use $(ref:networkingPrivate.getNetworks) with
     // filter.visible = true instead.
     [deprecated="Use getNetworks."] static void getVisibleNetworks(
         NetworkType networkType,
         GetNetworksCallback callback);
 
-    // Returns a list of the enabled network types. Note: this only returns
-    // discrete types that can be enabled or disabled: Cellular, Ethernet, WiFi,
-    // Wimax.
-    // |callback|: Called immediately with the enabled network types.
-    static void getEnabledNetworkTypes(GetEnabledNetworkTypesCallback callback);
+    // Deprecated. Please use $(ref:networkingPrivate.getDeviceStates) instead.
+    [deprecated="Use getDeviceStates."] static void getEnabledNetworkTypes(
+        GetEnabledNetworkTypesCallback callback);
 
-    // Enable the specified network type. Note, the type might represent
-    // multiple network types (e.g. 'Wireless').
+    // Returns a list of $(ref:networkingPrivate.DeviceStateProperties) objects.
+    // |callback|: Called with a list of devices and their state.
+    static void getDeviceStates(GetDeviceStatesCallback callback);
+
+    // Enables any devices matching the specified network type. Note, the type
+    // might represent multiple network types (e.g. 'Wireless').
     // |networkType|: The type of network to enable.
     static void enableNetworkType(NetworkType networkType);
 
-    // Disable the specified network type. See note for
+    // Disables any devices matching the specified network type. See note for
     // $(ref:networkingPrivate.enableNetworkType).
     // |networkType|: The type of network to disable.
     static void disableNetworkType(NetworkType networkType);
 
     // Requests that the networking subsystem scan for new networks and
     // update the list returned by $(ref:getVisibleNetworks). This is only a
     // request: the network subsystem can choose to ignore it.  If the list
     // is updated, then the $(ref:onNetworkListChanged) event will be fired.
     static void requestNetworkScan();
 
@@ skipping 82 matching lines @@
 
   interface Events {
     // Fired when the properties change on any of the networks.  Sends a list of
     // GUIDs for networks whose properties have changed.
     static void onNetworksChanged(DOMString[] changes);
 
     // Fired when the list of networks has changed.  Sends a complete list of
     // GUIDs for all the current networks.
     static void onNetworkListChanged(DOMString[] changes);
 
+    // Fired when the list of devices has changed or any device state properties
+    // have changed.
+    static void onDeviceStateListChanged();
+
     // Fired when a portal detection for a network completes. Sends the guid of
     // the network and the corresponding captive portal status.
     static void onPortalDetectionCompleted(DOMString networkGuid,
                                            CaptivePortalStatus status);
   };
 };