Difference between revisions of "GM.setValue"

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__
{{underscore|title=GM_setValue}}
 
== 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.


Allows user script authors to persist simple values locally.
[[#Description|top]] | [[#Syntax|back]]''
Strings, booleans, and integers are the only allowed data types.


Values are stored in the [http://developer.mozilla.org/en/docs/Code_snippets:Preferences Firefox preferences] back end and can be changed by typing <code>about:config</code> in the address bar and searching for the preference name "greasemonkey.scriptval.''script-namespace''/''script-name''.
==== <code>value</code> ====
This places limitations on the size of an individual value, and the number of values.
:Value: String, Integer or Boolean
(This statement may not be accurate.  Please see [http://groups.google.com/group/greasemonkey-users/t/ca5a0dfac5c5998b this mailing list thread] for details.)
:Usage: <code>value = 5;</code>


== Examples ==
[[#Description|top]] | [[#Syntax|back]]


alert(GM_setValue("foo", "bar"));
= Examples =
<code><pre>
GM_setValue("foo", "bar");
</pre></code>


== See also ==
[[#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:API Reference|S]]
[[Category:API_Reference|G]]

Revision as of 20:43, 6 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 | Notes | See Also

Syntax

GM_setValue( name, value )

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

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.

top

See Also

top