Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(911)

Unified Diff: sdk/lib/html/docs/html_docs.json

Issue 11471005: Add documentation for HttpRequest. (Closed) Base URL: http://dart.googlecode.com/svn/branches/bleeding_edge/dart/
Patch Set: Created 8 years ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « sdk/lib/html/dartium/html_dartium.dart ('k') | sdk/lib/html/scripts/htmldartgenerator.py » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: sdk/lib/html/docs/html_docs.json
===================================================================
--- sdk/lib/html/docs/html_docs.json (revision 15846)
+++ sdk/lib/html/docs/html_docs.json (working copy)
@@ -508,55 +508,55 @@
},
"Document.dart":
{
- " void set $dom_body(Element value) {":
+ " @Returns('_NodeList') @Creates('_NodeList')":
[
- " /// Moved to [HtmlDocument]."
+ " /// Deprecated: use query(\"#$elementId\") instead."
],
- " Window get window => _convertNativeToDart_Window(this._window);":
+ " Element $dom_createElement(String tagName) native \"createElement\";":
[
- " /// Returns the [Window] associated with the document."
+ " /// Deprecated: use new Element.tag(tagName) instead."
],
- " HeadElement get $dom_head => JS(\"HeadElement\", \"#.head\", this);":
+ " Element $dom_elementFromPoint(int x, int y) native \"elementFromPoint\";":
[
" /// Moved to [HtmlDocument]."
],
- " String get $dom_lastModified => JS(\"String\", \"#.lastModified\", this);":
+ " Element $dom_getElementById(String elementId) native \"getElementById\";":
[
- " /// Moved to [HtmlDocument]."
+ " /// Deprecated: use query(\"#$elementId\") instead."
],
- " String get $dom_referrer => JS(\"String\", \"#.referrer\", this);":
+ " Element $dom_querySelector(String selectors) native \"querySelector\";":
[
- " /// Moved to [HtmlDocument]."
+ " /// Deprecated: renamed to the shorter name [query]."
],
- " List<StyleSheet> get $dom_styleSheets => JS(\"_StyleSheetList\", \"#.styleSheets\", this);":
+ " Element get $dom_webkitFullscreenElement => JS(\"Element\", \"#.webkitFullscreenElement\", this);":
[
" /// Moved to [HtmlDocument]."
],
- " String get $dom_title => JS(\"String\", \"#.title\", this);":
+ " Element get $dom_webkitPointerLockElement => JS(\"Element\", \"#.webkitPointerLockElement\", this);":
[
" /// Moved to [HtmlDocument]."
],
- " void set $dom_title(String value) {":
+ " HeadElement get $dom_head => JS(\"HeadElement\", \"#.head\", this);":
[
" /// Moved to [HtmlDocument]."
],
- " Element get $dom_webkitFullscreenElement => JS(\"Element\", \"#.webkitFullscreenElement\", this);":
+ " List<StyleSheet> get $dom_styleSheets => JS(\"_StyleSheetList\", \"#.styleSheets\", this);":
[
" /// Moved to [HtmlDocument]."
],
- " bool get $dom_webkitFullscreenEnabled => JS(\"bool\", \"#.webkitFullscreenEnabled\", this);":
+ " Range $dom_caretRangeFromPoint(int x, int y) native \"caretRangeFromPoint\";":
[
- " /// Moved to [HtmlDocument]."
+ " /// Use the [Range] constructor instead."
],
- " bool get $dom_webkitHidden => JS(\"bool\", \"#.webkitHidden\", this);":
+ " String get $dom_lastModified => JS(\"String\", \"#.lastModified\", this);":
[
" /// Moved to [HtmlDocument]."
],
- " bool get $dom_webkitIsFullScreen => JS(\"bool\", \"#.webkitIsFullScreen\", this);":
+ " String get $dom_referrer => JS(\"String\", \"#.referrer\", this);":
[
" /// Moved to [HtmlDocument]."
],
- " Element get $dom_webkitPointerLockElement => JS(\"Element\", \"#.webkitPointerLockElement\", this);":
+ " String get $dom_title => JS(\"String\", \"#.title\", this);":
[
" /// Moved to [HtmlDocument]."
],
@@ -564,33 +564,25 @@
[
" /// Moved to [HtmlDocument]."
],
- " Range $dom_caretRangeFromPoint(int x, int y) native \"caretRangeFromPoint\";":
- [
- " /// Use the [Range] constructor instead."
- ],
- " Element $dom_createElement(String tagName) native \"createElement\";":
- [
- " /// Deprecated: use new Element.tag(tagName) instead."
- ],
" TouchList $dom_createTouchList() native \"createTouchList\";":
[
" /// Use the [TouchList] constructor isntead."
],
- " Element $dom_elementFromPoint(int x, int y) native \"elementFromPoint\";":
+ " Window get window => _convertNativeToDart_Window(this._window);":
[
- " /// Moved to [HtmlDocument]."
+ " /// Returns the [Window] associated with the document."
],
- " Element $dom_getElementById(String elementId) native \"getElementById\";":
+ " bool get $dom_webkitFullscreenEnabled => JS(\"bool\", \"#.webkitFullscreenEnabled\", this);":
[
- " /// Deprecated: use query(\"#$elementId\") instead."
+ " /// Moved to [HtmlDocument]."
],
- " @Returns('_NodeList') @Creates('_NodeList')":
+ " bool get $dom_webkitHidden => JS(\"bool\", \"#.webkitHidden\", this);":
[
- " /// Deprecated: use query(\"#$elementId\") instead."
+ " /// Moved to [HtmlDocument]."
],
- " Element $dom_querySelector(String selectors) native \"querySelector\";":
+ " bool get $dom_webkitIsFullScreen => JS(\"bool\", \"#.webkitIsFullScreen\", this);":
[
- " /// Deprecated: renamed to the shorter name [query]."
+ " /// Moved to [HtmlDocument]."
],
" void $dom_webkitCancelFullScreen() native \"webkitCancelFullScreen\";":
[
@@ -603,6 +595,14 @@
" void $dom_webkitExitPointerLock() native \"webkitExitPointerLock\";":
[
" /// Moved to [HtmlDocument]."
+ ],
+ " void set $dom_body(Element value) {":
+ [
+ " /// Moved to [HtmlDocument]."
+ ],
+ " void set $dom_title(String value) {":
+ [
+ " /// Moved to [HtmlDocument]."
]
},
"DocumentFragment.dart":
@@ -895,7 +895,162 @@
},
"HttpRequest.dart":
{
-
+ " @Creates('ArrayBuffer|Blob|Document|=Object|=List|String|num')":
+ [
+ " /**",
+ " * The data received as a reponse from the request.",
+ " *",
+ " * The data could be in the",
+ " * form of a [String], [ArrayBuffer], [Document], [Blob], or json (also a ",
+ " * [String]). `null` indicates request failure.",
+ " */"
+ ],
+ " HttpRequestEvents get on =>":
+ [
+ " /**",
+ " * Get the set of [HttpRequestEvents] that this request can respond to.",
+ " * Usually used when adding an EventListener, such as in",
+ " * `document.window.on.keyDown.add((e) => print('keydown happened'))`.",
+ " */"
+ ],
+ " String getAllResponseHeaders() native;":
+ [
+ " /**",
+ " * Retrieve all the response headers from a request.",
+ " * ",
+ " * `null` if no headers have been received. For multipart requests,",
+ " * `getAllResponseHeaders` will return the response headers for the current",
+ " * part of the request.",
+ " * ",
+ " * See also [HTTP response headers](http://en.wikipedia.org/wiki/List_of_HTTP_header_fields#Responses)",
+ " * for a list of common response headers.",
+ " */"
+ ],
+ " String getResponseHeader(String header) native;":
+ [
+ " /**",
+ " * Return the response header named `header`, or `null` if not found.",
+ " * ",
+ " * See also [HTTP response headers](http://en.wikipedia.org/wiki/List_of_HTTP_header_fields#Responses)",
+ " * for a list of common response headers.",
+ " */"
+ ],
+ " String responseType;":
+ [
+ " /**",
+ " * [String] telling the server the desired response format. ",
+ " *",
+ " * Default is `String`.",
+ " * Other options are one of 'arraybuffer', 'blob', 'document', 'json',",
+ " * 'text'. Some newer browsers will throw NS_ERROR_DOM_INVALID_ACCESS_ERR if",
+ " * `responseType` is set while performing a synchronous request.",
+ " *",
+ " * See also: [MDN responseType](https://developer.mozilla.org/en-US/docs/DOM/XMLHttpRequest#responseType)",
+ " */"
+ ],
+ " bool withCredentials;":
+ [
+ " /**",
+ " * True if cross-site requests should use credentials such as cookies",
+ " * or authorization headers; false otherwise. ",
+ " *",
+ " * This value is ignored for same-site requests.",
+ " */"
+ ],
+ " factory HttpRequest() => _HttpRequestFactoryProvider.createHttpRequest();":
+ [
+ " /**",
+ " * General constructor for any type of request (GET, POST, etc).",
+ " *",
+ " * This call is used in conjunction with [open]:",
+ " * ",
+ " * var request = new HttpRequest();",
+ " * request.open('GET', 'http://dartlang.org')",
+ " * request.on.load.add((event) => print('Request complete'));",
+ " * ",
+ " * is the (more verbose) equivalent of",
+ " * ",
+ " * var request = new HttpRequest.get('http://dartlang.org', (event) => print('Request complete'));",
+ " */"
+ ],
+ " final HttpRequestUpload upload;":
+ [
+ " /**",
+ " * [EventTarget] that can hold listeners to track the progress of the request.",
+ " * The events fired will be members of [HttpRequestUploadEvents].",
+ " */"
+ ],
+ " final String responseText;":
+ [
+ " /**",
+ " * The response in string form or `null` on failure.",
+ " */"
+ ],
+ " final String statusText;":
+ [
+ " /**",
+ " * The request response string (such as \"200 OK\").",
+ " * See also: [Http Status Codes](http://en.wikipedia.org/wiki/List_of_HTTP_status_codes)",
+ " */"
+ ],
+ " final int readyState;":
+ [
+ " /** @domName XMLHttpRequest.readyState */"
+ ],
+ " final int status;":
+ [
+ " /**",
+ " * The http result code from the request (200, 404, etc).",
+ " * See also: [Http Status Codes](http://en.wikipedia.org/wiki/List_of_HTTP_status_codes)",
+ " */"
+ ],
+ " void abort() native;":
+ [
+ " /**",
+ " * Stop the current request.",
+ " *",
+ " * The request can only be stopped if readyState is `HEADERS_RECIEVED` or ",
+ " * `LOADING`. If this method is not in the process of being sent, the method",
+ " * has no effect.",
+ " */"
+ ],
+ " void open(String method, String url, [bool async, String user, String password]) native;":
+ [
+ " /**",
+ " * Specify the desired `url`, and `method` to use in making the request.",
+ " * ",
+ " * By default the request is done asyncronously, with no user or password",
+ " * authentication information. If `async` is false, the request will be send",
+ " * synchronously.",
+ " * ",
+ " * Calling `open` again on a currently active request is equivalent to",
+ " * calling `abort`.",
+ " */"
+ ],
+ " void overrideMimeType(String override) native;":
+ [
+ " /**",
+ " * Specify a particular MIME type (such as `text/xml`) desired for the",
+ " * response.",
+ " * ",
+ " * This value must be set before the request has been sent. See also the list",
+ " * of [common MIME types](http://en.wikipedia.org/wiki/Internet_media_type#List_of_common_media_types)",
+ " */"
+ ],
+ " void send([data]) native;":
+ [
+ " /**",
+ " * Send the request with any given `data`.",
+ " *",
+ " * See also: ",
+ " * [send() docs](https://developer.mozilla.org/en-US/docs/DOM/XMLHttpRequest#send())",
+ " * from MDN.",
+ " */"
+ ],
+ " void setRequestHeader(String header, String value) native;":
+ [
+ " /** Sets HTTP `header` to `value`. */"
+ ]
},
"HttpRequestException.dart":
{
@@ -2001,4 +2156,4 @@
{
}
-}
+}
« no previous file with comments | « sdk/lib/html/dartium/html_dartium.dart ('k') | sdk/lib/html/scripts/htmldartgenerator.py » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698