xhr.html 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172
  1. <!DOCTYPE HTML>
  2. <html>
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0, user-scalable=no">
  6. <meta name="HandheldFriendly" content="true">
  7. <meta name="MobileOptimized" content="320">
  8. <title>XHR Document</title>
  9. <link rel="stylesheet" type="text/css" href="res/doc.css" charset="utf-8">
  10. <link rel="stylesheet" type="text/css" href="res/prettify.sons.css" charset="utf-8">
  11. <script type="text/javascript" src="res/doc.js" charset="utf-8"></script><script type="text/javascript" src="res/prettify.js" charset="utf-8"></script>
  12. </head>
  13. <body><div id="content" class="content">
  14. <h1><a name="plus.net">net</a></h1>
  15. <p>XMLHttpRequest模块管理网络请求,与标准HTML中的XMLHttpRequest用途一致,差别在于前者可以进行跨域访问。通过plus.net可获取网络请求管理对象。</p>
  16. <h2>对象:</h2>
  17. <ul>
  18. <li>
  19. <a href="#plus.net.XMLHttpRequest">XMLHttpRequest</a>: 跨域网络请求对象</li>
  20. <li>
  21. <a href="#plus.net.ProgressEvent">ProgressEvent</a>: HTTP请求进度事件</li>
  22. </ul>
  23. <h2>回调方法:</h2>
  24. <ul>
  25. <li>
  26. <a href="#plus.net.XhrStateChangeCallback">XhrStateChangeCallback</a>: 网络请求状态变化的回调函数</li>
  27. <li>
  28. <a href="#plus.net.XhrProgressEventCallback">XhrProgressEventCallback</a>: 网络请求进度事件的回调函数</li>
  29. </ul>
  30. <h2>权限:</h2>
  31. <p>5+功能模块(permissions)</p>
  32. <pre class="prettyprint linenums">
  33. {
  34. // ...
  35. "permissions":{
  36. // ...
  37. "XMLHttpRequest": {
  38. "description": "跨域网络连接"
  39. }
  40. }
  41. }
  42. </pre>
  43. <h1><a name="plus.net.XMLHttpRequest">XMLHttpRequest</a></h1>
  44. <p>跨域网络请求对象</p>
  45. <h2>构造:</h2>
  46. <ul><li>
  47. <a href="#plus.net.XMLHttpRequest.XMLHttpRequest()">XMLHttpRequest()</a>: 创建一个XMLHttpRequest 对象,对象创建时不触发任何时间和网络请求,需和open,send方法配合使用。</li></ul>
  48. <h2>属性:</h2>
  49. <ul>
  50. <li>
  51. <a href="#plus.net.XMLHttpRequest.readyState">readyState</a>: HTTP 请求的状态</li>
  52. <li>
  53. <a href="#plus.net.XMLHttpRequest.response">response</a>: 请求从服务器接收到的响应数据</li>
  54. <li>
  55. <a href="#plus.net.XMLHttpRequest.responseText">responseText</a>: 请求从服务器接收到的响应数据(字符串数据)</li>
  56. <li>
  57. <a href="#plus.net.XMLHttpRequest.responseType">responseType</a>: 请求响应数据response的类型</li>
  58. <li>
  59. <a href="#plus.net.XMLHttpRequest.responseXML">responseXML</a>: 请求响应的Document对象</li>
  60. <li>
  61. <a href="#plus.net.XMLHttpRequest.status">status</a>: 服务器返回的HTTP状态代码</li>
  62. <li>
  63. <a href="#plus.net.XMLHttpRequest.statusText">statusText</a>: 服务器返回的HTTP状态描述</li>
  64. <li>
  65. <a href="#plus.net.XMLHttpRequest.timeout">timeout</a>: 请求服务器的超时时间,单位为毫秒(ms)</li>
  66. <li>
  67. <a href="#plus.net.XMLHttpRequest.withCredentials">withCredentials</a>: 是否支持跨域请求</li>
  68. </ul>
  69. <h2>方法:</h2>
  70. <ul>
  71. <li>
  72. <a href="#plus.net.XMLHttpRequest.abort">abort</a>: 取消当前响应,关闭连接并且结束任何未决的网络活动</li>
  73. <li>
  74. <a href="#plus.net.XMLHttpRequest.getAllResponseHeaders">getAllResponseHeaders</a>: 获取HTTP响应头部信息</li>
  75. <li>
  76. <a href="#plus.net.XMLHttpRequest.getResponseHeader">getResponseHeader</a>: 获取指定的HTTP响应头部的值</li>
  77. <li>
  78. <a href="#plus.net.XMLHttpRequest.open">open</a>: 初始化HTTP请求参数,例如URL和HTTP方法,但是并不发送请求</li>
  79. <li>
  80. <a href="#plus.net.XMLHttpRequest.overrideMimeType">overrideMimeType</a>: 重写服务器返回的MIME类型</li>
  81. <li>
  82. <a href="#plus.net.XMLHttpRequest.send">send</a>: 发送HTTP请求</li>
  83. <li>
  84. <a href="#plus.net.XMLHttpRequest.setRequestHeader">setRequestHeader</a>: 指定一个HTTP请求的Header</li>
  85. </ul>
  86. <h2>事件:</h2>
  87. <ul>
  88. <li>
  89. <a href="#plus.net.XMLHttpRequest.onreadystatechange">onreadystatechange</a>: 网络请求状态发生变化事件</li>
  90. <li>
  91. <a href="#plus.net.XMLHttpRequest.onloadstart">onloadstart</a>: 网络请求开始事件</li>
  92. <li>
  93. <a href="#plus.net.XMLHttpRequest.onprogress">onprogress</a>: 网络请求传输数据事件</li>
  94. <li>
  95. <a href="#plus.net.XMLHttpRequest.onabort">onabort</a>: 网络请求取消事件</li>
  96. <li>
  97. <a href="#plus.net.XMLHttpRequest.onerror">onerror</a>: 网络请求错误事件</li>
  98. <li>
  99. <a href="#plus.net.XMLHttpRequest.onload">onload</a>: 网络请求成功事件</li>
  100. <li>
  101. <a href="#plus.net.XMLHttpRequest.ontimeout">ontimeout</a>: 网络请求超时事件</li>
  102. <li>
  103. <a href="#plus.net.XMLHttpRequest.onloadend">onloadend</a>: 网络请求结束事件</li>
  104. </ul>
  105. <h1><a name="plus.net.ProgressEvent">ProgressEvent</a></h1>
  106. <p>HTTP请求进度事件</p>
  107. <pre class="prettyprint linenums">
  108. interface ProgressEvent : Event {
  109. readonly attribute XMLHttpRequest target;
  110. readonly attribute Boolean lengthComputable;
  111. readonly attribute Number loaded;
  112. readonly attribute Number total;
  113. };
  114. </pre>
  115. <h2>属性:</h2>
  116. <ul>
  117. <li>target: <em>(<a href="#plus.net.XMLHttpRequest">XMLHttpRequest</a>
  118. 类型
  119. )</em>事件的目标对象<br><p>
  120. 通知HTTP请求进度事件的XMLHttpRequest对象。
  121. </p>
  122. </li>
  123. <li>lengthComputable: <em>(<font class="type">Number</font>
  124. 类型
  125. )</em>进度信息是否可计算<br><p>
  126. HTTP请求进度信息是否有效,如果HTTP请求头中包含Content-Length头信息则为true,否则为false。
  127. </p>
  128. </li>
  129. <li>loaded: <em>(<font class="type">XMLHttpRequest</font>
  130. 类型
  131. )</em>当前已经接收到的数据长度<br><p>
  132. HTTP请求接收到的数据长度,单位为字节。
  133. </p>
  134. </li>
  135. <li>total: <em>(<font class="type">XMLHttpRequest</font>
  136. 类型
  137. )</em>总数据长度<br><p>
  138. HTTP请求返回的总数据长度,单位为字节。
  139. 如果无法获取则设置为0。
  140. </p>
  141. </li>
  142. </ul>
  143. <h1><a name="plus.net.XhrStateChangeCallback">XhrStateChangeCallback</a></h1>
  144. <p>网络请求状态变化的回调函数</p>
  145. <pre class="prettyprint linenums">
  146. void onSuccess() {
  147. // State changed code.
  148. }
  149. </pre>
  150. <h2>参数:</h2>
  151. <p>无</p>
  152. <h2>返回值:</h2>
  153. <font class="type">void</font>
  154. : 无<h1><a name="plus.net.XhrProgressEventCallback">XhrProgressEventCallback</a></h1>
  155. <p>网络请求进度事件的回调函数</p>
  156. <pre class="prettyprint linenums">
  157. void onProgressEvent( ProgressEvent event ) {
  158. // Progress changed code.
  159. }
  160. </pre>
  161. <h2>参数:</h2>
  162. <ul><li>event:
  163. <em>(
  164. <a href="#plus.net.ProgressEvent">ProgressEvent</a>
  165. )
  166. 必选 </em>HTTP请求进度事件<br>
  167. </li></ul>
  168. <h2>返回值:</h2>
  169. <font class="type">void</font>
  170. : 无<br><br>
  171. </div></body>
  172. </html>