GM.getResourceText: Difference between revisions
From GreaseSpot Wiki
Jump to navigationJump to search
m (→Description: Need to expand on these descriptions, but that seems to be the intent.) |
m (Notated a concern about the resourceName variable... note I extrapolated this variable name from the developer group when I created this article... so I didn't do it ;D) |
||
| Line 29: | Line 29: | ||
==== <code>resourceName</code> ==== | ==== <code>resourceName</code> ==== | ||
:Value: String | :Value: String | ||
:Usage: <code>'''resourceName''' = "metadata-resource-name";</code> | :Usage: <code>'''resourceName''' = "metadata-resource-name<sup>[[#Notes|[1]]]</sup>";</code> | ||
:* This value is used to retrieve the [[Metadata_block |metadata block @resource]] name URI which will be retrieved, unformatted, and returned upon completion of this API method. | :* This value is used to retrieve the [[Metadata_block |metadata block @resource]] name URI which will be retrieved, unformatted, and returned upon completion of this API method. | ||
| Line 53: | Line 53: | ||
== Notes == | == Notes == | ||
[[Category:API_Reference|G]] | |||
<sup>[[#resourceName|[1]]]</sup> While the variable name described here has hyphens in it, it is assumed that it should be compatible with JavaScript variable naming conventions and XML/CSS naming conventions to help keep things consistent. | |||
[[#top|top]] | [[#top|top]] | ||
Revision as of 09:11, 11 December 2007
Description
This API method loads an external resource, such as an external JavaScript routine, and returns the string for use in the DOM.
Syntax
GM_getResourceText( resourceName )
- Value: Function
- Returns: String
- Compatibility: Greasemonkey 0.8.0+
Parameters Properties resourceName
- All properties are optional except resourceName.
Properties
resourceName
- Value: String
- Usage:
resourceName = "metadata-resource-name[1]";
- This value is used to retrieve the metadata block @resource name URI which will be retrieved, unformatted, and returned upon completion of this API method.
Examples
// ==UserScript==
// @name My Script
// @namespace http://www.example.com/gmscripts/
// @description Example GM_getResourceText
// @include http://www.example.com/*
// @resource prototype http://www.prototypejs.org/assets/2007/11/6/prototype.js
// ==/UserScript==
/* some code */
location.href = "javascript:void(" + GM_getResourceText("prototype") + ")";
Notes
[1] While the variable name described here has hyphens in it, it is assumed that it should be compatible with JavaScript variable naming conventions and XML/CSS naming conventions to help keep things consistent.
