GM.xmlHttpRequest: Difference between revisions
m →GET request: removal of markup since this wiki doesn't support it... sf |
m display title fix |
||
| Line 1: | Line 1: | ||
{{ | {{DISPLAYTITLE:GM_xmlhttpRequest}} | ||
== Description == | == Description == | ||
| Line 228: | Line 226: | ||
[[#top|top]] | [[#top|top]] | ||
[[Category:API_Reference|X]] | [[Category:API_Reference|X]] | ||
Revision as of 13:56, 30 October 2009
Description
This API method provides access to the chrome-privileged XMLHttpRequest object. This means that it is possible to issue requests to domains other than that of the current page.
Additional reference may be found at:
Syntax
GM_xmlhttpRequest( details )
- Value: Function
- Returns: undefined, response Object
- Compatibility: Greasemonkey 0.2.5+
details Object Properties Event Handler Callbacks methodonloadurlonreadystatechangeheadersonerroroverrideMimeTypedata
Properties
method
- Value: String
- Usage:
details.method = "GET"';
url
- Value: String
- Usage:
details.url = "http://www.greasespot.net/";
- Must be an absolute URL.
headers
- Value: Object
- Usage:
details.headers = {"User-Agent":"Mozilla/5.0"};
- The
headersproperty is an object which is typically used to override the default browser generated headers, also known as atoms. It should contain the atom-value pairs of the headers to send.[2]
- The
overrideMimeType
- Value: String
- Compatibility: Greasemonkey 0.6.8+
- Usage:
details.overrideMimeType = "text/html; charset=ISO-8859-1";
- While each character set name may have multiple aliases defined, there may be a preferred name which can be found at IANA
data
- Value: String
- Usage:
details.data = null; /* some code */ if (details.data) { /* some code */ }- [1]
- Note that if the
datafield contains form-encoded data, you must also set the header'Content-Type': 'application/x-www-form-urlencoded'in theheadersfield.
Event Handler Callbacks
onload
- Usage:
details.onload = function (response) { /* some code */ }; - Returns: undefined, response Object
onreadystatechange
- Usage:
details.onreadystatechange = function (response) { /* some code */ }; - Returns: undefined, response Object
onerror
- Usage:
details.onerror = function (response) { /* some code */ }; - Returns: undefined, response Object
response Object Properties statusreadyStateresponseTextfinalUrlstatusTextresponseHeaders
- Note: there is no
responseXMLproperty, contrary to what people used to XMLHttpRequest might expect. This is due to security restrictions imposed on the XMLDocument created in the privileged GM core context. One can easily create its own XMLDocument out ofresponseTextusing a DOMParser (see examples below).
- Note: there is no
Properties
status
- Value: Number
- Usage:
if (response.status == 200) { /* some code */ }
statusText
- Value: String
- Usage:
if (response.statusText == "OK") { /* some code */ }
readyState
- Value: Number
- Usage:
if (response.readyState == 4) { /* some code */ }
responseText
- Value: String
- Usage:
alert(response.responseText);
responseHeaders
- Value: String
- Usage:
if (response.responseHeaders) { /* some code */ }
- The
responseHeadersis the string representation of response headers returned byXMLHTTPRequest.getAllResponseHeaders().
- The
finalUrl
- Value: String
- Compatibility: Greasemonkey 0.8.0+
- Usage:
if (response.finalUrl) { /* some code */ }
Examples
GET request | POST request | HEAD request
Core
GET request
POST request
When making a POST request, most sites require the Content-Type header to be included as such:
HEAD request
Sometimes responseText may be unnecessary, in which case a "HEAD" request is more advisable.
Template:Core samp
Notes
[1]Some users have reported problems with international character sets. See these mailing list threads
- http://www.mozdev.org/pipermail/greasemonkey/2006-June/008785.html
- http://www.mozdev.org/pipermail/greasemonkey/2006-April/008064.html
Resolved: Greasemonkey exposed the overrideMimeType method to allow changing of the desired charset.
[2]Some header atoms may not actually work through GM_xmlhttpRequest. The Referer atom is one that is known to be recognized but appears to be content filtered by the browser. This may be due to security restrictions to keep user scripts from doing unsafe things.
