GM.getValue: Difference between revisions
From GreaseSpot Wiki
Jump to navigationJump to search
m →Syntax |
|||
| Line 15: | Line 15: | ||
:Returns: String, Integer, Boolean or null<sup>[[#Notes|[1]]]</sup> | :Returns: String, Integer, Boolean or null<sup>[[#Notes|[1]]]</sup> | ||
:Compatibility: Greasemonkey 0.3b+ | :Compatibility: [[Version_history#0.3_beta|Greasemonkey 0.3b+]] | ||
:{| border="1" cellpadding="5" | :{| border="1" cellpadding="5" | ||
Revision as of 02:46, 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 )
- 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"));
Notes
[1] This value should be undefined in prefmanager.js
