GM.getValue: Difference between revisions
From GreaseSpot Wiki
Jump to navigationJump to search
m (→Notes) |
mNo edit summary |
||
| Line 28: | Line 28: | ||
:* All properties are optional except [[#name|name]]. | :* All properties are optional except [[#name|name]]. | ||
[[# | [[#top|top]] | ||
=== Properties === | === Properties === | ||
---- | ---- | ||
| Line 37: | Line 37: | ||
:* Property name to retrieve. | :* Property name to retrieve. | ||
[[# | [[#top|top]] | [[#Syntax|back]]'' | ||
==== <code>default</code> ==== | ==== <code>default</code> ==== | ||
| Line 46: | Line 46: | ||
: Note: Using this property does not call [[GM_setValue]] and is by design. | : Note: Using this property does not call [[GM_setValue]] and is by design. | ||
[[# | [[#top|top]] | [[#Syntax|back]] | ||
== Examples == | == Examples == | ||
| Line 53: | Line 53: | ||
</pre></code> | </pre></code> | ||
[[# | [[#top|top]] | ||
== See Also == | == See Also == | ||
* [[GM_setValue]] | * [[GM_setValue]] | ||
[[# | [[#top|top]] | ||
== Notes == | == Notes == | ||
<sup>[[GM_getValue#Syntax|[1]]]</sup> The <code>null</code> value should be <code>undefined</code> in prefmanager.js | <sup>[[GM_getValue#Syntax|[1]]]</sup> The <code>null</code> value should be <code>undefined</code> in prefmanager.js | ||
[[# | [[#top|top]] | ||
[[Category:API_Reference|G]] | [[Category:API_Reference|G]] | ||
Revision as of 09:19, 8 December 2007
Description
This API method retrieves a value that is set with GM_setValue.
Values are saved in the Firefox preferences back end and can be manually changed by typing about:config in the address bar and searching for the preference name "greasemonkey.scriptval.script-namespace/script-name".
Syntax
GM_getValue( name, default )
- Value: Function
- Returns: String, Integer, Boolean or null[1]
- Compatibility: Greasemonkey 0.3b+
- All properties are optional except name.
Properties
name
- Value: String
- Usage:
name = "PropertyName";
- Property name to retrieve.
default
- Value: String, Integer or Boolean
- Usage:
default = 5;
- If name is not found, then use this property to return a default value.
- Note: Using this property does not call GM_setValue and is by design.
Examples
alert(GM_getValue("foo"));
See Also
Notes
[1] The null value should be undefined in prefmanager.js
