aboutsummaryrefslogtreecommitdiff
path: root/tools/addon-sdk-1.3/packages/api-utils/docs/preferences-service.md
diff options
context:
space:
mode:
Diffstat (limited to 'tools/addon-sdk-1.3/packages/api-utils/docs/preferences-service.md')
-rw-r--r--tools/addon-sdk-1.3/packages/api-utils/docs/preferences-service.md51
1 files changed, 51 insertions, 0 deletions
diff --git a/tools/addon-sdk-1.3/packages/api-utils/docs/preferences-service.md b/tools/addon-sdk-1.3/packages/api-utils/docs/preferences-service.md
new file mode 100644
index 0000000..145f943
--- /dev/null
+++ b/tools/addon-sdk-1.3/packages/api-utils/docs/preferences-service.md
@@ -0,0 +1,51 @@
+<!-- contributed by Myk Melez [myk@mozilla.org] -->
+<!-- contributed by Daniel Aquino [mr.danielaquino@gmail.com] -->
+<!-- contributed by Atul Varma [atul@mozilla.com] -->
+<!-- edited by Noelle Murata [fiveinchpixie@gmail.com] -->
+
+The `preferences-service` module provides access to the
+application-wide preferences service singleton.
+
+
+<api name="set">
+@function
+Sets the application preference `name` to `value`.
+@param name {string} Preference name.
+@param value {string,number,bool} Preference value.
+</api>
+
+
+<api name="get">
+@function
+Gets the application preference `name`.
+@param name {string}
+@param defaultValue {string,number,bool} Preference value.
+@returns {string,number,bool} Preference value, returns a default value if no
+preference is set.
+</api>
+
+
+<api name="has">
+@function
+@param name {string} Preference name.
+@returns {bool} Returns whether or not the application preference `name` exists.
+</api>
+
+
+<api name="isSet">
+@function
+@param name {string} Preference name.
+@returns {bool}
+Returns whether or not the application preference `name` both exists
+and has been set to a non-default value by the user (or a program
+acting on the user's behalf).
+</api>
+
+
+<api name="reset">
+@function
+Clears a non-default, user-set value from the application preference
+`name`. If no user-set value is defined on `name`, the function
+does nothing.
+@param name {string} Preference name.
+</api>