GM.setValue: Difference between revisions
From GreaseSpot Wiki
Jump to navigationJump to search
about:config |
Symmetry update with a bug reported |
||
| Line 1: | Line 1: | ||
{{underscore|title=GM_setValue}} | |||
__NOTOC__ | __NOTOC__ | ||
== Description == | |||
This [[API_reference|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.<sup>[[#Notes|[1]]]</sup> | |||
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 16: | ||
'''GM_setValue(''' ''name'', ''value'' ''')''' | '''GM_setValue(''' ''name'', ''value'' ''')''' | ||
= Description = | :Returns: Nothing<sup>[[#Notes|[2]]]</sup> | ||
:Compatibility: Greasemonkey 0.3b+ | |||
:{| border="1" cellpadding="5" | |||
|+ Parameters | |||
!|'''Properties''' | |||
|- | |||
| <code>[[#name |name]]</code> | |||
|- | |||
|<code>[[#value |value]]</code> | |||
|} | |||
:* All properties are optional except [[#name|name]] and [[#value|value]]. | |||
[[#Description|top]] | |||
=== Properties === | |||
---- | |||
==== <code>name</code> ==== | |||
:Value: String | |||
:Usage: <code>name = "PropertyName";</code> | |||
:* Property name to retrieve or create. | |||
[[#Description|top]] | [[#Syntax|back]]'' | |||
==== <code>value</code> ==== | |||
:Value: String, Integer or Boolean | |||
:Usage: <code>value = 5;</code> | |||
[[#Description|top]] | [[#Syntax|back]] | |||
= Examples = | |||
<code><pre> | |||
GM_setValue("foo", "bar"); | |||
</pre></code> | |||
[[#Description|top]] | |||
= Notes = | |||
<sup>[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>[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 do not have any <code>return</code> statements. | |||
[[#Description|top]] | |||
= See Also = | |||
* [[GM_getValue]] | * [[GM_getValue]] | ||
[[#Description|top]] | |||
[[Category: | [[Category:API_Reference|G]] | ||
Revision as of 01:43, 7 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 )
- 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");
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 do not have any return statements.
