GM.getValue: Difference between revisions
From GreaseSpot Wiki
Jump to navigationJump to search
m →Description: - Malformed external link/Fixed broken link |
Symmetry update with a bug reported |
||
| Line 1: | Line 1: | ||
{{underscore|title=GM_xmlhttpRequest}} | |||
__NOTOC__ | __NOTOC__ | ||
== Description == | |||
This [[API_reference|API]] method retrieves a value that is set with [[GM_setValue]]. | |||
Values are saved in the [http://developer.mozilla.org/en/docs/Code_snippets:Preferences Firefox preferences] back end and can be manually changed by typing <code>about:config</code> in the address bar and searching for the preference name "greasemonkey.scriptval.''script-namespace''/''script-name''". | |||
[[#Examples|Examples]] | [[#Notes|Notes]]| [[#See_Also|See Also]] | |||
== Syntax == | == Syntax == | ||
| Line 6: | Line 14: | ||
'''GM_getValue(''' ''name'', ''default'' ''')''' | '''GM_getValue(''' ''name'', ''default'' ''')''' | ||
== Description == | :Returns: String, Integer, Boolean or null<sup>[[#Notes|[1]]]</sup> | ||
:Compatibility: Greasemonkey 0.3b+ | |||
:{| border="1" cellpadding="5" | |||
|+ Parameters | |||
!|'''Properties''' | |||
|- | |||
| <code>[[#name |name]]</code> | |||
|- | |||
|<code>[[#default |default]]</code> | |||
|} | |||
:* All properties are optional except [[#name|name]]. | |||
[[#Description|top]] | |||
=== Properties === | |||
---- | |||
==== <code>name</code> ==== | |||
:Value: String | |||
:Usage: <code>name = "PropertyName";</code> | |||
:* Property name to retrieve. | |||
[[#Description|top]] | [[#Syntax|back]]'' | |||
==== <code>default</code> ==== | |||
:Value: String, Integer or Boolean | |||
:Usage: <code>default = 5;</code> | |||
If | :* If [[GM_getValue#name|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. | |||
[[#Description|top]] | [[#Syntax|back]] | |||
= Examples = | |||
<code><pre> | |||
alert(GM_getValue("foo")); | alert(GM_getValue("foo")); | ||
</pre></code> | |||
[[#Description|top]] | |||
= Notes = | |||
<sup>[1]</sup> This value should be <code>undefined</code> in prefmanager.js | |||
[[#Description|top]] | |||
= See Also = | |||
* [[GM_setValue]] | * [[GM_setValue]] | ||
[[Category: | [[#Description|top]] | ||
[[Category:API_Reference|G]] | |||
Revision as of 00:50, 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
