Add NetworkingPrivateDelegate class

chrome/browser/extensions/api/networking_private/networking_private_delegate.h

+// Copyright 2013 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.
+
+#ifndef CHROME_BROWSER_EXTENSIONS_API_NETWORKING_PRIVATE_NETWORKING_PRIVATE_DELEGATE_H_
+#define CHROME_BROWSER_EXTENSIONS_API_NETWORKING_PRIVATE_NETWORKING_PRIVATE_DELEGATE_H_
+
+#include <string>
+
+#include "base/callback.h"
+#include "base/memory/scoped_ptr.h"
+#include "base/values.h"
+
+namespace content {
+class BrowserContext;
+}
+
+namespace extensions {
+
+// Base class for platform dependent networkingPrivate API implementations.
+class NetworkingPrivateDelegate {
+ public:
+  typedef base::Callback<void(scoped_ptr<base::DictionaryValue>)>
+      DictionaryCallback;
+  typedef base::Callback<void()> VoidCallback;
+  typedef base::Callback<void(bool)> BoolCallback;
+  typedef base::Callback<void(const std::string&)> StringCallback;
+  typedef base::Callback<void(scoped_ptr<base::ListValue>)> NetworkListCallback;
+  typedef base::Callback<void(const std::string&)> FailureCallback;
+
+  static NetworkingPrivateDelegate* GetForBrowserContext(
+      content::BrowserContext* browser_context);
+
+  // Asynchronous methods
+  virtual void GetProperties(const std::string& guid,

[pneubeck (no reviews), 2014/07/14 21:33:58]

None of the functions explain what the results should be.
E.g. a String result could be many things, but in some cases means GUID.
similarly for DictionaryValue, sometimes means ONC network configuration.

Having semantic callback definitions would give better documentation, e.g. an
GuidCallback, or an NetworkConfigCallback.

Alternatively, each function should have an explanation of the expected results.

[stevenjb, 2014/07/15 00:33:40]

It doesn't seem especially valuable to repeat the documentation in the json
file, but I added a reference to that file above.

+                             const DictionaryCallback& success_callback,
+                             const FailureCallback& failure_callback) = 0;
+  virtual void GetManagedProperties(
+      const std::string& guid,
+      const DictionaryCallback& success_callback,
+      const FailureCallback& failure_callback) = 0;
+  virtual void GetState(const std::string& guid,
+                        const DictionaryCallback& success_callback,
+                        const FailureCallback& failure_callback) = 0;
+  virtual void SetProperties(const std::string& guid,
+                             scoped_ptr<base::DictionaryValue> properties,
+                             const VoidCallback& success_callback,
+                             const FailureCallback& failure_callback) = 0;
+  virtual void CreateNetwork(bool shared,
+                             scoped_ptr<base::DictionaryValue> properties,
+                             const StringCallback& success_callback,
+                             const FailureCallback& failure_callback) = 0;
+  virtual void GetNetworks(const std::string& network_type,
+                           bool configured_only,
+                           bool visible_only,
+                           int limit,
+                           const NetworkListCallback& success_callback,
+                           const FailureCallback& failure_callback) = 0;
+  virtual void StartConnect(const std::string& guid,
+                            const VoidCallback& success_callback,
+                            const FailureCallback& failure_callback) = 0;
+  virtual void StartDisconnect(const std::string& guid,
+                               const VoidCallback& success_callback,
+                               const FailureCallback& failure_callback) = 0;
+  virtual void VerifyDestination(
+      scoped_ptr<base::DictionaryValue> verification_properties,
+      const BoolCallback& success_callback,
+      const FailureCallback& failure_callback) = 0;
+  virtual void VerifyAndEncryptCredentials(
+      const std::string& guid,
+      scoped_ptr<base::DictionaryValue> verification_properties,
+      const StringCallback& success_callback,
+      const FailureCallback& failure_callback) = 0;
+  virtual void VerifyAndEncryptData(
+      scoped_ptr<base::DictionaryValue> verification_properties,
+      const std::string& data,
+      const StringCallback& success_callback,
+      const FailureCallback& failure_callback) = 0;
+  virtual void SetWifiTDLSEnabledState(
+      const std::string& ip_or_mac_address,
+      bool enabled,
+      const StringCallback& success_callback,
+      const FailureCallback& failure_callback) = 0;
+  virtual void GetWifiTDLSStatus(
+      const std::string& ip_or_mac_address,
+      const StringCallback& success_callback,
+      const FailureCallback& failure_callback) = 0;
+  virtual void GetCaptivePortalStatus(
+      const std::string& guid,
+      const StringCallback& success_callback,
+      const FailureCallback& failure_callback) = 0;
+
+  // Synchronous methods
+  virtual scoped_ptr<base::ListValue> GetEnabledNetworkTypes() = 0;
+  virtual bool EnableNetworkType(const std::string& type) = 0;
+  virtual bool DisableNetworkType(const std::string& type) = 0;
+  virtual bool RequestScan() = 0;
+
+ protected:
+  virtual ~NetworkingPrivateDelegate() {}
+};
+
+}  // namespace extensions
+
+#endif  // CHROME_BROWSER_EXTENSIONS_API_NETWORKING_PRIVATE_NETWORKING_PRIVATE_DELEGATE_H_