GM.setValue: Difference between revisions
mNo edit summary |
|||
| Line 30: | Line 30: | ||
:* All properties are optional except [[#name|name]] and [[#value|value]]. | :* All properties are optional except [[#name|name]] and [[#value|value]]. | ||
[[# | [[#top|top]] | ||
=== Properties === | === Properties === | ||
---- | ---- | ||
| Line 39: | Line 39: | ||
:* Property name to retrieve or create. | :* Property name to retrieve or create. | ||
[[# | [[#top|top]] | [[#Syntax|back]]'' | ||
==== <code>value</code> ==== | ==== <code>value</code> ==== | ||
| Line 45: | Line 45: | ||
:Usage: <code>'''value''' = 5;</code> | :Usage: <code>'''value''' = 5;</code> | ||
[[# | [[#top|top]] | [[#Syntax|back]] | ||
== Examples == | == Examples == | ||
| Line 52: | Line 52: | ||
</pre></code> | </pre></code> | ||
[[# | [[#top|top]] | ||
== See Also == | == See Also == | ||
* [[GM_getValue]] | * [[GM_getValue]] | ||
[[# | [[#top|top]] | ||
== Notes == | == Notes == | ||
<sup>[[GM_setValue# | <sup>[[GM_setValue#top|[1]]]</sup> This statement may not be accurate. Please see [http://groups.google.com/group/greasemonkey-users/t/ca5a0dfac5c5998b this mailing list thread] for details. | ||
<sup>[[GM_setValue#Syntax|[2]]]</sup> The previous incarnation of this article had an example of <code>alert(GM_setValue("foo", "bar"));</code>. Currently miscapis.js and prefmanager.js does not have any <code>return</code> statements. | <sup>[[GM_setValue#Syntax|[2]]]</sup> The previous incarnation of this article had an example of <code>alert(GM_setValue("foo", "bar"));</code>. Currently miscapis.js and prefmanager.js does not have any <code>return</code> statements. | ||
[[# | [[#top|top]] | ||
[[Category:API_Reference|G]] | [[Category:API_Reference|G]] | ||
Revision as of 09:18, 8 December 2007
Description
This API method allows user script authors to persist simple values locally.
Strings, booleans, and integers are currently the only allowed data types. This places limitations on the size of an individual value, and the number of values.[1]
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_setValue( name, value )
- Value: Function
- Returns: Nothing[2]
- Compatibility: Greasemonkey 0.3b+
Properties
name
- Value: String
- Usage:
name = "PropertyName";
- Property name to retrieve or create.
value
- Value: String, Integer or Boolean
- Usage:
value = 5;
Examples
GM_setValue("foo", "bar");
See Also
Notes
[1] This statement may not be accurate. Please see this mailing list thread for details.
[2] The previous incarnation of this article had an example of alert(GM_setValue("foo", "bar"));. Currently miscapis.js and prefmanager.js does not have any return statements.
