Skip to content

Stay API Reference

shen yin edited this page Jan 31, 2022 · 8 revisions

This section is a brief description of Stay API, Each script is treated as running in a sandbox.

Tampermonkey API

Now Stay(since Stay²) supported GM_/GM. API as below.

GM_log(message)
Print a message on the Stay popup view console.

GM_setValue(key, value)
Permanently stores a value under a key.

GM.setValue(key, value)
Permanently stores a value under a key. (async)

GM_getValue(key)
Retrieves a stored value for a key.

GM.getValue(key)
Retrieves a stored value for a key. (async)

GM_deleteValue(key)
Deletes a value was previously set.

GM.deleteValue(key)
Deletes a value was previously set. (async)

GM_listValues()
Retrieves an array of stored key value pairs.

GM.listValues()
Retrieves an array of stored key and value pairs. (async)

GM.registerMenuCommand(caption, commandFunc, accessKey)
This method allows user scripts to add an item to the Stay settings menu.

GM_registerMenuCommand(caption, commandFunc, accessKey)
This method allows user scripts to add an item to the Stay settings menu.

GM_addStyle(css)
This method adds a string of CSS to the document.

Clone this wiki locally