Difference between revisions of "GM.setValue"

From GreaseSpot Wiki
Jump to navigationJump to search
m
m
Line 10: Line 10:
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''".
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]]
[[#Examples|Examples]] | [[#See_Also|See Also]] | [[#Notes|Notes]]  


== Syntax ==
== Syntax ==
Line 16: Line 16:
'''GM_setValue(''' ''name'', ''value'' ''')'''
'''GM_setValue(''' ''name'', ''value'' ''')'''


:Value: Function
:Returns: Nothing<sup>[[#Notes|[2]]]</sup>
:Returns: Nothing<sup>[[#Notes|[2]]]</sup>
:Compatibility: [[Version_history#0.3_beta|Greasemonkey 0.3b+]]
:Compatibility: [[Version_history#0.3_beta|Greasemonkey 0.3b+]]
Line 50: Line 51:
GM_setValue("foo", "bar");
GM_setValue("foo", "bar");
</pre></code>
</pre></code>
[[#Description|top]]
= See Also =
* [[GM_getValue]]


[[#Description|top]]
[[#Description|top]]
Line 57: Line 63:


<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.
[[#Description|top]]
= See Also =
* [[GM_getValue]]


[[#Description|top]]
[[#Description|top]]
[[Category:API_Reference|G]]
[[Category:API_Reference|G]]

Revision as of 00:41, 7 December 2007

Template:Underscore


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".

Examples | See Also | Notes

Syntax

GM_setValue( name, value )

Value: Function
Returns: Nothing[2]
Compatibility: Greasemonkey 0.3b+
Parameters
Properties
name
value
  • All properties are optional except name and value.

top

Properties


name

Value: String
Usage: name = "PropertyName";
  • Property name to retrieve or create.

top | back

value

Value: String, Integer or Boolean
Usage: value = 5;

top | back

Examples

GM_setValue("foo", "bar");

top

See Also

top

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.

top