GM.getValue: Difference between revisions
From GreaseSpot Wiki
Jump to navigationJump to search
m (→Syntax) |
mNo edit summary |
||
| Line 48: | Line 48: | ||
[[#Description|top]] | [[#Syntax|back]] | [[#Description|top]] | [[#Syntax|back]] | ||
= Examples = | == Examples == | ||
<code><pre> | <code><pre> | ||
alert(GM_getValue("foo")); | alert(GM_getValue("foo")); | ||
| Line 55: | Line 55: | ||
[[#Description|top]] | [[#Description|top]] | ||
= See Also = | == See Also == | ||
* [[GM_setValue]] | * [[GM_setValue]] | ||
[[#Description|top]] | [[#Description|top]] | ||
= Notes = | == Notes == | ||
<sup>[1]</sup> This value should be <code>undefined</code> in prefmanager.js | <sup>[1]</sup> This value should be <code>undefined</code> in prefmanager.js | ||
[[#Description|top]] | [[#Description|top]] | ||
[[Category:API_Reference|G]] | [[Category:API_Reference|G]] | ||
Revision as of 05:48, 7 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] This value should be undefined in prefmanager.js
