Difference between revisions of "GM.listValues"

From GreaseSpot Wiki
Jump to navigationJump to search
m (Whenver 8.1ish is released, this function is available currently in the trunk... created core structure doc... more explicit example could be modified and eventual link in with core API when released)
 
(Update for 4.0)
 
(26 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{underscore|title=GM_listValues}}
{{DISPLAYTITLE:GM_listValues}}
__NOTOC__


== Description ==
== Description ==


This [[API_reference|API]] method retrieves an array of preference names that start with the branches root.
This method retrieves an array of preference names that this script has stored.
See [[GM_setValue]] for details on the storage of these values.


Values are retrieved from the [http://developer.mozilla.org/en/docs/Code_snippets:Preferences Firefox preferences] back end and can be manually viewed by typing [[mozillazine:About:config|about:config]] in the address bar and searching for the preference name "greasemonkey.scriptval.''script-namespace''/''script-name''".
== Syntax ==


[[#Examples|Examples]] | [[#See_Also|See Also]] | [[#Notes|Notes]]
{{Function|GM.listValues|}}


== Syntax ==
Compatibility: [[Version_history#4.0_2|Greasemonkey 4.0+]]


'''GM_listValues()'''
=== Arguments ===


:Value: Function
None.
:Returns: String Array
:Compatibility: [[Version_history#8.1|Greasemonkey 8.1+]]


:{| cellpadding="5" style="border-style:solid; background:#FFFFE0;"
=== Returns ===
|+ Parameters
!style="background:#CC9900;"|'''Properties'''
|-
|}
:* There are currently no properties.


[[#top|top]]
A [[Promise]], rejected in case of error and otherwise resolved with an <code>Array</code> of <code>String</code>s for previously set values.


== Examples ==
== Examples ==
<code><pre>
alert(GM_listValues());
</pre></code>


[[#top|top]]
<pre class='sample'>
console.log(await GM.listValues());
</pre>


== See Also ==
== See Also ==
* [[GM_getValue]]
* [[GM_setValue]]
* [[GM_deleteValue]]
[[#top|top]]


== Notes ==
* [[GM.getValue]]
* [[GM.setValue]]
* [[GM.deleteValue]]


[[#top|top]]
[[Category:API_Reference|L]]
[[Category:API_Reference|L]]

Latest revision as of 09:29, 3 November 2017


Description

This method retrieves an array of preference names that this script has stored. See GM_setValue for details on the storage of these values.

Syntax

function GM.listValues( )

Compatibility: Greasemonkey 4.0+

Arguments

None.

Returns

A Promise, rejected in case of error and otherwise resolved with an Array of Strings for previously set values.

Examples

console.log(await GM.listValues());

See Also