Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(9860)

Unified Diff: chrome/common/extensions/api/settings_private.idl

Issue 1015623005: chrome.settingsPrivate: Basic stub implementation (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: Extracting and logging the parameters Created 5 years, 9 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: chrome/common/extensions/api/settings_private.idl
diff --git a/chrome/common/extensions/api/settings_private.idl b/chrome/common/extensions/api/settings_private.idl
new file mode 100644
index 0000000000000000000000000000000000000000..d360283e88e354c75c113ef453bbaefd3e7f07b9
--- /dev/null
+++ b/chrome/common/extensions/api/settings_private.idl
@@ -0,0 +1,74 @@
+// Copyright (c) 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.
+
+// Use the <code>chrome.settingsPrivate</code> API to get or set preferences
+// from the settings UI.
+namespace settingsPrivate {
+ // Type of a pref.
+ enum PrefType { BOOLEAN, NUMBER, STRING, URL };
+
+ // Source of a pref (device, user).
+ enum PrefSource { DEVICE, USER };
+
+ dictionary PrefObject {
+ // The key for the pref.
+ DOMString key;
+
+ // The type of the pref (e.g., boolean, string, etc.).
+ PrefType type;
+
+ // The current value of the pref.
+ any value;
+
+ // The source of the pref (e.g., device, user).
+ PrefSource source;
+ };
+
+ callback OnPrefSetCallback = void (boolean success);
+ callback GetAllPrefsCallback = void (PrefObject[] prefs);
+ callback GetPrefCallback = void (PrefObject pref);
+
+ interface Functions {
+ // Sets a boolean settings value.
+ //
+ // |name|: The name of the pref.
+ //
Ken Rockot(use gerrit already) 2015/03/23 19:53:39 nit: I don't think this vertical whitespace is nec
Oren Blasberg 2015/03/23 20:20:11 Done.
+ // |value|: The new value of the pref.
+ static void setBooleanPref(DOMString name, boolean value, optional OnPrefSetCallback callback);
Ken Rockot(use gerrit already) 2015/03/23 19:53:39 nit: Please fix line length here and elsewhere. Th
Oren Blasberg 2015/03/23 20:20:11 Done.
+
+ // Sets a number settings value.
+ //
+ // |name|: The name of the pref.
+ //
+ // |value|: The new value of the pref.
+ static void setNumericPref(DOMString name, double value, optional OnPrefSetCallback callback);
+
+ // Sets a string settings value.
+ //
+ // |name|: The name of the pref.
+ //
+ // |value|: The new value of the pref.
+ static void setStringPref(DOMString name, DOMString value, optional OnPrefSetCallback callback);
+
+ // Sets a URL settings value.
+ //
+ // |name|: The name of the pref.
+ //
+ // |value|: The new value of the pref.
+ static void setURLPref(DOMString name, DOMString value, optional OnPrefSetCallback callback);
+
+ // Gets an array of all the prefs.
+ static void getAllPrefs(GetAllPrefsCallback callback);
+
+ // Gets the value of a specific pref.
+ static void getPref(DOMString name, GetPrefCallback callback);
+ };
+
+ interface Events {
+ // Fired when a set of prefs has changed.
+ //
+ // |callback|: Callback fired with a list of prefs that changed.
+ static void onPrefsChanged(GetAllPrefsCallback callback);
+ };
+};

Powered by Google App Engine
This is Rietveld 408576698