Add networkingPrivate.getThirdPartyVpnProviderList

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 140 matching lines @@
 
   dictionary OpenVPNProperties {
     DOMString? OTP;
     DOMString? Password;
     DOMString? UserAuthenticationType;
     DOMString? Username;
   };
 
   dictionary ThirdPartyVPNProperties {
     DOMString ExtensionID;
+    DOMString? Name;
   };
 
   dictionary VPNConfigProperties {
     boolean? AutoConnect;
     DOMString? Host;
     OpenVPNProperties? OpenVPN;
     ThirdPartyVPNProperties? ThirdPartyVPN;
     DOMString? Type;
   };
 
@@ skipping 113 matching lines @@
   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);
+  callback GetThirdPartyVPNProvidersCallback =
+      void(ThirdPartyVPNProperties[] 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,
                               GetPropertiesCallback callback);
 
@@ skipping 194 matching lines @@
     // the operation will fail. This will not lock the SIM; that is handled
     // automatically by the device. NOTE: If the SIM is locked, it must first be
     // unlocked with unlockCellularSim() before this can be called (otherwise it
     // will fail and chrome.runtime.lastError will be set to Error.SimLocked).
     // |networkGuid|: The GUID of the cellular network to set the SIM state of.
     // |simState|: The SIM state to set.
     // |callback|: Called when the operation has completed.
     static void setCellularSimState(DOMString networkGuid,
                                     CellularSimState simState,
                                     optional VoidCallback callback);
+
+    // Gets the list of third-party VPN providers. Each third-party VPN has
+    // an associated extension ID and a descriptive name. The list may be empty.
+    // |callback|: Called with the third-party VPN properties.
+    static void getThirdPartyVPNProviders(
+        GetThirdPartyVPNProvidersCallback callback);
   };
 
   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.
+    // Fired when the list of visible networks has changed.  Sends a complete
+    // list of GUIDs for all visible 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);
+
+    // Fired when the list of third-party VPN providers may have changed. Sends
+    // a complete list of third-party providers.
+    static void onThirdPartyVPNProvidersChanged(
+        ThirdPartyVPNProperties[] providers);
   };
 };