Difference between revisions of "Greasemonkey Manual:API"

From GreaseSpot Wiki
Jump to navigationJump to search
(names with dots, remove methods not in 4.0)
(GM.notification)
Line 20: Line 20:


=== Other ===
=== Other ===
; [[GM.notification]] : Opens a notification dialog.
; [[GM.openInTab]] : Opens a given URL in a new tab.
; [[GM.openInTab]] : Opens a given URL in a new tab.
; [[GM.setClipboard]] : Sets the contents of the clipboard.
; [[GM.setClipboard]] : Sets the contents of the clipboard.

Revision as of 12:17, 18 April 2018

Book.png
Greasemonkey Manual
Using Greasemonkey
Installing Scripts
Monkey Menu
Getting Help
User Script Authoring
Editing
Environment
API

This section of the manual will be short and sweet. As mentioned elsewhere, Greasemonkey provides several methods in its API to enhance the power of user scripts. They are listed here, with a brief description, but each separate method has its own page with more in-depth information, please continue reading there!

Headers

Metadata Block
Information about the script such as its name or version is encoded into comments by the script author.
GM.info
Exposes this information (plus a bit more) to the user script.

Values

GM.deleteValue
Deletes a value from chrome that was previously set.
GM.getValue
Retrieves stored values, see GM.setValue below.
GM.listValues
Retrieves an array of stored values' keys.
GM.setValue
Permanently stores a value under a key, later available via GM.getValue.

Resources

GM.getResourceUrl
Provides a URL for loading a @resource, such as an image, into the page.

Other

GM.notification
Opens a notification dialog.
GM.openInTab
Opens a given URL in a new tab.
GM.setClipboard
Sets the contents of the clipboard.
GM.xmlHttpRequest
A variant of XMLHttpRequest, this method allows skipping use the same-origin policy, enabling complex mashups.
unsafeWindow
This object provides access to the raw JavaScript window scope of the content page. It is most commonly used to access JavaScript variables on the page.