UnityEngine.UnityWebRequestModule.xml 46 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947
  1. <?xml version="1.0" encoding="utf-8" standalone="yes"?>
  2. <doc>
  3. <members>
  4. <assembly>
  5. <name>UnityEngine.UnityWebRequestModule</name>
  6. </assembly>
  7. <member name="T:UnityEngine.Networking.CertificateHandler">
  8. <summary>
  9. <para>Responsible for rejecting or accepting certificates received on https requests.</para>
  10. </summary>
  11. </member>
  12. <member name="M:UnityEngine.Networking.CertificateHandler.Dispose">
  13. <summary>
  14. <para>Signals that this [CertificateHandler] is no longer being used, and should clean up any resources it is using.</para>
  15. </summary>
  16. </member>
  17. <member name="M:UnityEngine.Networking.CertificateHandler.ValidateCertificate(System.Byte[])">
  18. <summary>
  19. <para>Callback, invoked for each leaf certificate sent by the remote server.</para>
  20. </summary>
  21. <param name="certificateData">Certificate data in PEM or DER format. If certificate data contains multiple certificates, the first one is the leaf certificate.</param>
  22. <returns>
  23. <para>true if the certificate should be accepted, false if not.</para>
  24. </returns>
  25. </member>
  26. <member name="T:UnityEngine.Networking.DownloadHandler">
  27. <summary>
  28. <para>Manage and process HTTP response body data received from a remote server.</para>
  29. </summary>
  30. </member>
  31. <member name="P:UnityEngine.Networking.DownloadHandler.data">
  32. <summary>
  33. <para>Returns the raw bytes downloaded from the remote server, or null. (Read Only)</para>
  34. </summary>
  35. </member>
  36. <member name="P:UnityEngine.Networking.DownloadHandler.isDone">
  37. <summary>
  38. <para>Returns true if this DownloadHandler has been informed by its parent UnityWebRequest that all data has been received, and this DownloadHandler has completed any necessary post-download processing. (Read Only)</para>
  39. </summary>
  40. </member>
  41. <member name="P:UnityEngine.Networking.DownloadHandler.text">
  42. <summary>
  43. <para>Convenience property. Returns the bytes from data interpreted as a UTF8 string. (Read Only)</para>
  44. </summary>
  45. </member>
  46. <member name="M:UnityEngine.Networking.DownloadHandler.CompleteContent">
  47. <summary>
  48. <para>Callback, invoked when all data has been received from the remote server.</para>
  49. </summary>
  50. </member>
  51. <member name="M:UnityEngine.Networking.DownloadHandler.Dispose">
  52. <summary>
  53. <para>Signals that this [DownloadHandler] is no longer being used, and should clean up any resources it is using.</para>
  54. </summary>
  55. </member>
  56. <member name="M:UnityEngine.Networking.DownloadHandler.GetData">
  57. <summary>
  58. <para>Callback, invoked when the data property is accessed.</para>
  59. </summary>
  60. <returns>
  61. <para>Byte array to return as the value of the data property.</para>
  62. </returns>
  63. </member>
  64. <member name="M:UnityEngine.Networking.DownloadHandler.GetProgress">
  65. <summary>
  66. <para>Callback, invoked when UnityWebRequest.downloadProgress is accessed.</para>
  67. </summary>
  68. <returns>
  69. <para>The return value for UnityWebRequest.downloadProgress.</para>
  70. </returns>
  71. </member>
  72. <member name="M:UnityEngine.Networking.DownloadHandler.GetText">
  73. <summary>
  74. <para>Callback, invoked when the text property is accessed.</para>
  75. </summary>
  76. <returns>
  77. <para>String to return as the return value of the text property.</para>
  78. </returns>
  79. </member>
  80. <member name="M:UnityEngine.Networking.DownloadHandler.ReceiveContentLength(System.Int32)">
  81. <summary>
  82. <para>Callback, invoked with a Content-Length header is received.</para>
  83. </summary>
  84. <param name="contentLength">The value of the received Content-Length header.</param>
  85. </member>
  86. <member name="M:UnityEngine.Networking.DownloadHandler.ReceiveData(System.Byte[],System.Int32)">
  87. <summary>
  88. <para>Callback, invoked as data is received from the remote server.</para>
  89. </summary>
  90. <param name="data">A buffer containing unprocessed data, received from the remote server.</param>
  91. <param name="dataLength">The number of bytes in data which are new.</param>
  92. <returns>
  93. <para>True if the download should continue, false to abort.</para>
  94. </returns>
  95. </member>
  96. <member name="T:UnityEngine.Networking.DownloadHandlerBuffer">
  97. <summary>
  98. <para>A general-purpose DownloadHandler implementation which stores received data in a native byte buffer.</para>
  99. </summary>
  100. </member>
  101. <member name="M:UnityEngine.Networking.DownloadHandlerBuffer.#ctor">
  102. <summary>
  103. <para>Default constructor.</para>
  104. </summary>
  105. </member>
  106. <member name="M:UnityEngine.Networking.DownloadHandlerBuffer.GetContent(UnityEngine.Networking.UnityWebRequest)">
  107. <summary>
  108. <para>Returns a copy of the native-memory buffer interpreted as a UTF8 string.</para>
  109. </summary>
  110. <param name="www">A finished UnityWebRequest object with DownloadHandlerBuffer attached.</param>
  111. <returns>
  112. <para>The same as DownloadHandlerBuffer.text</para>
  113. </returns>
  114. </member>
  115. <member name="M:UnityEngine.Networking.DownloadHandlerBuffer.GetData">
  116. <summary>
  117. <para>Returns a copy of the contents of the native-memory data buffer as a byte array.</para>
  118. </summary>
  119. <returns>
  120. <para>A copy of the data which has been downloaded.</para>
  121. </returns>
  122. </member>
  123. <member name="T:UnityEngine.Networking.DownloadHandlerFile">
  124. <summary>
  125. <para>Download handler for saving the downloaded data to file.</para>
  126. </summary>
  127. </member>
  128. <member name="P:UnityEngine.Networking.DownloadHandlerFile.removeFileOnAbort">
  129. <summary>
  130. <para>Should the created file be removed if download is aborted (manually or due to an error). Default: false.</para>
  131. </summary>
  132. </member>
  133. <member name="M:UnityEngine.Networking.DownloadHandlerFile.#ctor(System.String)">
  134. <summary>
  135. <para>Creates a new instance and a file on disk where downloaded data will be written to.</para>
  136. </summary>
  137. <param name="path">Path to file to be written.</param>
  138. </member>
  139. <member name="T:UnityEngine.Networking.DownloadHandlerScript">
  140. <summary>
  141. <para>An abstract base class for user-created scripting-driven DownloadHandler implementations.</para>
  142. </summary>
  143. </member>
  144. <member name="M:UnityEngine.Networking.DownloadHandlerScript.#ctor">
  145. <summary>
  146. <para>Create a DownloadHandlerScript which allocates new buffers when passing data to callbacks.</para>
  147. </summary>
  148. </member>
  149. <member name="M:UnityEngine.Networking.DownloadHandlerScript.#ctor(System.Byte[])">
  150. <summary>
  151. <para>Create a DownloadHandlerScript which reuses a preallocated buffer to pass data to callbacks.</para>
  152. </summary>
  153. <param name="preallocatedBuffer">A byte buffer into which data will be copied, for use by DownloadHandler.ReceiveData.</param>
  154. </member>
  155. <member name="?:UnityEngine.Networking.IMultipartFormSection">
  156. <summary>
  157. <para>An interface for composition of data into multipart forms.</para>
  158. </summary>
  159. </member>
  160. <member name="P:UnityEngine.Networking.IMultipartFormSection.contentType">
  161. <summary>
  162. <para>Returns the value to use in the Content-Type header for this form section.</para>
  163. </summary>
  164. <returns>
  165. <para>The value to use in the Content-Type header, or null.</para>
  166. </returns>
  167. </member>
  168. <member name="P:UnityEngine.Networking.IMultipartFormSection.fileName">
  169. <summary>
  170. <para>Returns a string denoting the desired filename of this section on the destination server.</para>
  171. </summary>
  172. <returns>
  173. <para>The desired file name of this section, or null if this is not a file section.</para>
  174. </returns>
  175. </member>
  176. <member name="P:UnityEngine.Networking.IMultipartFormSection.sectionData">
  177. <summary>
  178. <para>Returns the raw binary data contained in this section. Must not return null or a zero-length array.</para>
  179. </summary>
  180. <returns>
  181. <para>The raw binary data contained in this section. Must not be null or empty.</para>
  182. </returns>
  183. </member>
  184. <member name="P:UnityEngine.Networking.IMultipartFormSection.sectionName">
  185. <summary>
  186. <para>Returns the name of this section, if any.</para>
  187. </summary>
  188. <returns>
  189. <para>The section's name, or null.</para>
  190. </returns>
  191. </member>
  192. <member name="T:UnityEngine.Networking.MultipartFormDataSection">
  193. <summary>
  194. <para>A helper object for form sections containing generic, non-file data.</para>
  195. </summary>
  196. </member>
  197. <member name="P:UnityEngine.Networking.MultipartFormDataSection.contentType">
  198. <summary>
  199. <para>Returns the value to use in this section's Content-Type header.</para>
  200. </summary>
  201. <returns>
  202. <para>The Content-Type header for this section, or null.</para>
  203. </returns>
  204. </member>
  205. <member name="P:UnityEngine.Networking.MultipartFormDataSection.fileName">
  206. <summary>
  207. <para>Returns a string denoting the desired filename of this section on the destination server.</para>
  208. </summary>
  209. <returns>
  210. <para>The desired file name of this section, or null if this is not a file section.</para>
  211. </returns>
  212. </member>
  213. <member name="P:UnityEngine.Networking.MultipartFormDataSection.sectionData">
  214. <summary>
  215. <para>Returns the raw binary data contained in this section. Will not return null or a zero-length array.</para>
  216. </summary>
  217. <returns>
  218. <para>The raw binary data contained in this section. Will not be null or empty.</para>
  219. </returns>
  220. </member>
  221. <member name="P:UnityEngine.Networking.MultipartFormDataSection.sectionName">
  222. <summary>
  223. <para>Returns the name of this section, if any.</para>
  224. </summary>
  225. <returns>
  226. <para>The section's name, or null.</para>
  227. </returns>
  228. </member>
  229. <member name="M:UnityEngine.Networking.MultipartFormDataSection.#ctor(System.Byte[])">
  230. <summary>
  231. <para>Raw data section, unnamed and no Content-Type header.</para>
  232. </summary>
  233. <param name="data">Data payload of this section.</param>
  234. </member>
  235. <member name="M:UnityEngine.Networking.MultipartFormDataSection.#ctor(System.String,System.Byte[])">
  236. <summary>
  237. <para>Raw data section with a section name, no Content-Type header.</para>
  238. </summary>
  239. <param name="name">Section name.</param>
  240. <param name="data">Data payload of this section.</param>
  241. </member>
  242. <member name="M:UnityEngine.Networking.MultipartFormDataSection.#ctor(System.String,System.Byte[],System.String)">
  243. <summary>
  244. <para>A raw data section with a section name and a Content-Type header.</para>
  245. </summary>
  246. <param name="name">Section name.</param>
  247. <param name="data">Data payload of this section.</param>
  248. <param name="contentType">The value for this section's Content-Type header.</param>
  249. </member>
  250. <member name="M:UnityEngine.Networking.MultipartFormDataSection.#ctor(System.String,System.String,System.Text.Encoding,System.String)">
  251. <summary>
  252. <para>A named raw data section whose payload is derived from a string, with a Content-Type header.</para>
  253. </summary>
  254. <param name="name">Section name.</param>
  255. <param name="data">String data payload for this section.</param>
  256. <param name="contentType">The value for this section's Content-Type header.</param>
  257. <param name="encoding">An encoding to marshal data to or from raw bytes.</param>
  258. </member>
  259. <member name="M:UnityEngine.Networking.MultipartFormDataSection.#ctor(System.String,System.String,System.String)">
  260. <summary>
  261. <para>A named raw data section whose payload is derived from a UTF8 string, with a Content-Type header.</para>
  262. </summary>
  263. <param name="name">Section name.</param>
  264. <param name="data">String data payload for this section.</param>
  265. <param name="contentType">C.</param>
  266. </member>
  267. <member name="M:UnityEngine.Networking.MultipartFormDataSection.#ctor(System.String,System.String)">
  268. <summary>
  269. <para>A names raw data section whose payload is derived from a UTF8 string, with a default Content-Type.</para>
  270. </summary>
  271. <param name="name">Section name.</param>
  272. <param name="data">String data payload for this section.</param>
  273. </member>
  274. <member name="M:UnityEngine.Networking.MultipartFormDataSection.#ctor(System.String)">
  275. <summary>
  276. <para>An anonymous raw data section whose payload is derived from a UTF8 string, with a default Content-Type.</para>
  277. </summary>
  278. <param name="data">String data payload for this section.</param>
  279. </member>
  280. <member name="T:UnityEngine.Networking.MultipartFormFileSection">
  281. <summary>
  282. <para>A helper object for adding file uploads to multipart forms via the [IMultipartFormSection] API.</para>
  283. </summary>
  284. </member>
  285. <member name="P:UnityEngine.Networking.MultipartFormFileSection.contentType">
  286. <summary>
  287. <para>Returns the value of the section's Content-Type header.</para>
  288. </summary>
  289. <returns>
  290. <para>The Content-Type header for this section, or null.</para>
  291. </returns>
  292. </member>
  293. <member name="P:UnityEngine.Networking.MultipartFormFileSection.fileName">
  294. <summary>
  295. <para>Returns a string denoting the desired filename of this section on the destination server.</para>
  296. </summary>
  297. <returns>
  298. <para>The desired file name of this section, or null if this is not a file section.</para>
  299. </returns>
  300. </member>
  301. <member name="P:UnityEngine.Networking.MultipartFormFileSection.sectionData">
  302. <summary>
  303. <para>Returns the raw binary data contained in this section. Will not return null or a zero-length array.</para>
  304. </summary>
  305. <returns>
  306. <para>The raw binary data contained in this section. Will not be null or empty.</para>
  307. </returns>
  308. </member>
  309. <member name="P:UnityEngine.Networking.MultipartFormFileSection.sectionName">
  310. <summary>
  311. <para>Returns the name of this section, if any.</para>
  312. </summary>
  313. <returns>
  314. <para>The section's name, or null.</para>
  315. </returns>
  316. </member>
  317. <member name="M:UnityEngine.Networking.MultipartFormFileSection.#ctor(System.String,System.Byte[],System.String,System.String)">
  318. <summary>
  319. <para>Contains a named file section based on the raw bytes from data, with a custom Content-Type and file name.</para>
  320. </summary>
  321. <param name="name">Name of this form section.</param>
  322. <param name="data">Raw contents of the file to upload.</param>
  323. <param name="fileName">Name of the file uploaded by this form section.</param>
  324. <param name="contentType">The value for this section's Content-Type header.</param>
  325. </member>
  326. <member name="M:UnityEngine.Networking.MultipartFormFileSection.#ctor(System.Byte[])">
  327. <summary>
  328. <para>Contains an anonymous file section based on the raw bytes from data, assigns a default Content-Type and file name.</para>
  329. </summary>
  330. <param name="data">Raw contents of the file to upload.</param>
  331. </member>
  332. <member name="M:UnityEngine.Networking.MultipartFormFileSection.#ctor(System.String,System.Byte[])">
  333. <summary>
  334. <para>Contains an anonymous file section based on the raw bytes from data with a specific file name. Assigns a default Content-Type.</para>
  335. </summary>
  336. <param name="data">Raw contents of the file to upload.</param>
  337. <param name="fileName">Name of the file uploaded by this form section.</param>
  338. </member>
  339. <member name="M:UnityEngine.Networking.MultipartFormFileSection.#ctor(System.String,System.String,System.Text.Encoding,System.String)">
  340. <summary>
  341. <para>Contains a named file section with data drawn from data, as marshaled by dataEncoding. Assigns a specific file name from fileName and a default Content-Type.</para>
  342. </summary>
  343. <param name="name">Name of this form section.</param>
  344. <param name="data">Contents of the file to upload.</param>
  345. <param name="dataEncoding">A string encoding.</param>
  346. <param name="fileName">Name of the file uploaded by this form section.</param>
  347. </member>
  348. <member name="M:UnityEngine.Networking.MultipartFormFileSection.#ctor(System.String,System.Text.Encoding,System.String)">
  349. <summary>
  350. <para>An anonymous file section with data drawn from data, as marshaled by dataEncoding. Assigns a specific file name from fileName and a default Content-Type.</para>
  351. </summary>
  352. <param name="data">Contents of the file to upload.</param>
  353. <param name="dataEncoding">A string encoding.</param>
  354. <param name="fileName">Name of the file uploaded by this form section.</param>
  355. </member>
  356. <member name="M:UnityEngine.Networking.MultipartFormFileSection.#ctor(System.String,System.String)">
  357. <summary>
  358. <para>An anonymous file section with data drawn from the UTF8 string data. Assigns a specific file name from fileName and a default Content-Type.</para>
  359. </summary>
  360. <param name="data">Contents of the file to upload.</param>
  361. <param name="fileName">Name of the file uploaded by this form section.</param>
  362. </member>
  363. <member name="T:UnityEngine.Networking.UnityWebRequest">
  364. <summary>
  365. <para>The UnityWebRequest object is used to communicate with web servers.</para>
  366. </summary>
  367. </member>
  368. <member name="P:UnityEngine.Networking.UnityWebRequest.certificateHandler">
  369. <summary>
  370. <para>Holds a reference to a CertificateHandler object, which manages certificate validation for this UnityWebRequest.</para>
  371. </summary>
  372. </member>
  373. <member name="P:UnityEngine.Networking.UnityWebRequest.chunkedTransfer">
  374. <summary>
  375. <para>Indicates whether the UnityWebRequest system should employ the HTTP/1.1 chunked-transfer encoding method.</para>
  376. </summary>
  377. </member>
  378. <member name="P:UnityEngine.Networking.UnityWebRequest.disposeCertificateHandlerOnDispose">
  379. <summary>
  380. <para>If true, any CertificateHandler attached to this UnityWebRequest will have CertificateHandler.Dispose called automatically when UnityWebRequest.Dispose is called.</para>
  381. </summary>
  382. </member>
  383. <member name="P:UnityEngine.Networking.UnityWebRequest.disposeDownloadHandlerOnDispose">
  384. <summary>
  385. <para>If true, any DownloadHandler attached to this UnityWebRequest will have DownloadHandler.Dispose called automatically when UnityWebRequest.Dispose is called.</para>
  386. </summary>
  387. </member>
  388. <member name="P:UnityEngine.Networking.UnityWebRequest.disposeUploadHandlerOnDispose">
  389. <summary>
  390. <para>If true, any UploadHandler attached to this UnityWebRequest will have UploadHandler.Dispose called automatically when UnityWebRequest.Dispose is called.</para>
  391. </summary>
  392. </member>
  393. <member name="P:UnityEngine.Networking.UnityWebRequest.downloadedBytes">
  394. <summary>
  395. <para>Returns the number of bytes of body data the system has downloaded from the remote server. (Read Only)</para>
  396. </summary>
  397. </member>
  398. <member name="P:UnityEngine.Networking.UnityWebRequest.downloadHandler">
  399. <summary>
  400. <para>Holds a reference to a DownloadHandler object, which manages body data received from the remote server by this UnityWebRequest.</para>
  401. </summary>
  402. </member>
  403. <member name="P:UnityEngine.Networking.UnityWebRequest.downloadProgress">
  404. <summary>
  405. <para>Returns a floating-point value between 0.0 and 1.0, indicating the progress of downloading body data from the server. (Read Only)</para>
  406. </summary>
  407. </member>
  408. <member name="P:UnityEngine.Networking.UnityWebRequest.error">
  409. <summary>
  410. <para>A human-readable string describing any system errors encountered by this UnityWebRequest object while handling HTTP requests or responses. (Read Only)</para>
  411. </summary>
  412. </member>
  413. <member name="P:UnityEngine.Networking.UnityWebRequest.isDone">
  414. <summary>
  415. <para>Returns true after the UnityWebRequest has finished communicating with the remote server. (Read Only)</para>
  416. </summary>
  417. </member>
  418. <member name="P:UnityEngine.Networking.UnityWebRequest.isHttpError">
  419. <summary>
  420. <para>Returns true after this UnityWebRequest receives an HTTP response code indicating an error. (Read Only)</para>
  421. </summary>
  422. </member>
  423. <member name="P:UnityEngine.Networking.UnityWebRequest.isModifiable">
  424. <summary>
  425. <para>Returns true while a UnityWebRequest’s configuration properties can be altered. (Read Only)</para>
  426. </summary>
  427. </member>
  428. <member name="P:UnityEngine.Networking.UnityWebRequest.isNetworkError">
  429. <summary>
  430. <para>Returns true after this UnityWebRequest encounters a system error. (Read Only)</para>
  431. </summary>
  432. </member>
  433. <member name="F:UnityEngine.Networking.UnityWebRequest.kHttpVerbCREATE">
  434. <summary>
  435. <para>The string "CREATE", commonly used as the verb for an HTTP CREATE request.</para>
  436. </summary>
  437. </member>
  438. <member name="F:UnityEngine.Networking.UnityWebRequest.kHttpVerbDELETE">
  439. <summary>
  440. <para>The string "DELETE", commonly used as the verb for an HTTP DELETE request.</para>
  441. </summary>
  442. </member>
  443. <member name="F:UnityEngine.Networking.UnityWebRequest.kHttpVerbGET">
  444. <summary>
  445. <para>The string "GET", commonly used as the verb for an HTTP GET request.</para>
  446. </summary>
  447. </member>
  448. <member name="F:UnityEngine.Networking.UnityWebRequest.kHttpVerbHEAD">
  449. <summary>
  450. <para>The string "HEAD", commonly used as the verb for an HTTP HEAD request.</para>
  451. </summary>
  452. </member>
  453. <member name="F:UnityEngine.Networking.UnityWebRequest.kHttpVerbPOST">
  454. <summary>
  455. <para>The string "POST", commonly used as the verb for an HTTP POST request.</para>
  456. </summary>
  457. </member>
  458. <member name="F:UnityEngine.Networking.UnityWebRequest.kHttpVerbPUT">
  459. <summary>
  460. <para>The string "PUT", commonly used as the verb for an HTTP PUT request.</para>
  461. </summary>
  462. </member>
  463. <member name="P:UnityEngine.Networking.UnityWebRequest.method">
  464. <summary>
  465. <para>Defines the HTTP verb used by this UnityWebRequest, such as GET or POST.</para>
  466. </summary>
  467. </member>
  468. <member name="P:UnityEngine.Networking.UnityWebRequest.redirectLimit">
  469. <summary>
  470. <para>Indicates the number of redirects which this UnityWebRequest will follow before halting with a “Redirect Limit Exceeded” system error.</para>
  471. </summary>
  472. </member>
  473. <member name="P:UnityEngine.Networking.UnityWebRequest.responseCode">
  474. <summary>
  475. <para>The numeric HTTP response code returned by the server, such as 200, 404 or 500. (Read Only)</para>
  476. </summary>
  477. </member>
  478. <member name="P:UnityEngine.Networking.UnityWebRequest.timeout">
  479. <summary>
  480. <para>Sets UnityWebRequest to attempt to abort after the number of seconds in timeout have passed.</para>
  481. </summary>
  482. </member>
  483. <member name="P:UnityEngine.Networking.UnityWebRequest.uploadedBytes">
  484. <summary>
  485. <para>Returns the number of bytes of body data the system has uploaded to the remote server. (Read Only)</para>
  486. </summary>
  487. </member>
  488. <member name="P:UnityEngine.Networking.UnityWebRequest.uploadHandler">
  489. <summary>
  490. <para>Holds a reference to the UploadHandler object which manages body data to be uploaded to the remote server.</para>
  491. </summary>
  492. </member>
  493. <member name="P:UnityEngine.Networking.UnityWebRequest.uploadProgress">
  494. <summary>
  495. <para>Returns a floating-point value between 0.0 and 1.0, indicating the progress of uploading body data to the server.</para>
  496. </summary>
  497. </member>
  498. <member name="P:UnityEngine.Networking.UnityWebRequest.uri">
  499. <summary>
  500. <para>Defines the target URI for the UnityWebRequest to communicate with.</para>
  501. </summary>
  502. </member>
  503. <member name="P:UnityEngine.Networking.UnityWebRequest.url">
  504. <summary>
  505. <para>Defines the target URL for the UnityWebRequest to communicate with.</para>
  506. </summary>
  507. </member>
  508. <member name="P:UnityEngine.Networking.UnityWebRequest.useHttpContinue">
  509. <summary>
  510. <para>Determines whether this UnityWebRequest will include Expect: 100-Continue in its outgoing request headers. (Default: true).</para>
  511. </summary>
  512. </member>
  513. <member name="M:UnityEngine.Networking.UnityWebRequest.Abort">
  514. <summary>
  515. <para>If in progress, halts the UnityWebRequest as soon as possible.</para>
  516. </summary>
  517. </member>
  518. <member name="M:UnityEngine.Networking.UnityWebRequest.#ctor">
  519. <summary>
  520. <para>Creates a UnityWebRequest with the default options and no attached DownloadHandler or UploadHandler. Default method is GET.</para>
  521. </summary>
  522. <param name="url">The target URL with which this UnityWebRequest will communicate. Also accessible via the url property.</param>
  523. </member>
  524. <member name="M:UnityEngine.Networking.UnityWebRequest.#ctor(System.String)">
  525. <summary>
  526. <para>Creates a UnityWebRequest with the default options and no attached DownloadHandler or UploadHandler. Default method is GET.</para>
  527. </summary>
  528. <param name="url">The target URL with which this UnityWebRequest will communicate. Also accessible via the url property.</param>
  529. </member>
  530. <member name="M:UnityEngine.Networking.UnityWebRequest.Delete(System.String)">
  531. <summary>
  532. <para>Creates a UnityWebRequest configured for HTTP DELETE.</para>
  533. </summary>
  534. <param name="uri">The URI to which a DELETE request should be sent.</param>
  535. <returns>
  536. <para>A UnityWebRequest configured to send an HTTP DELETE request.</para>
  537. </returns>
  538. </member>
  539. <member name="M:UnityEngine.Networking.UnityWebRequest.Dispose">
  540. <summary>
  541. <para>Signals that this [UnityWebRequest] is no longer being used, and should clean up any resources it is using.</para>
  542. </summary>
  543. </member>
  544. <member name="M:UnityEngine.Networking.UnityWebRequest.EscapeURL(System.String)">
  545. <summary>
  546. <para>Escapes characters in a string to ensure they are URL-friendly.</para>
  547. </summary>
  548. <param name="s">A string with characters to be escaped.</param>
  549. <param name="e">The text encoding to use.</param>
  550. </member>
  551. <member name="M:UnityEngine.Networking.UnityWebRequest.EscapeURL(System.String,System.Text.Encoding)">
  552. <summary>
  553. <para>Escapes characters in a string to ensure they are URL-friendly.</para>
  554. </summary>
  555. <param name="s">A string with characters to be escaped.</param>
  556. <param name="e">The text encoding to use.</param>
  557. </member>
  558. <member name="M:UnityEngine.Networking.UnityWebRequest.GenerateBoundary">
  559. <summary>
  560. <para>Generate a random 40-byte array for use as a multipart form boundary.</para>
  561. </summary>
  562. <returns>
  563. <para>40 random bytes, guaranteed to contain only printable ASCII values.</para>
  564. </returns>
  565. </member>
  566. <member name="M:UnityEngine.Networking.UnityWebRequest.Get(System.String)">
  567. <summary>
  568. <para>Creates a UnityWebRequest configured for HTTP GET.</para>
  569. </summary>
  570. <param name="uri">The URI of the resource to retrieve via HTTP GET.</param>
  571. <returns>
  572. <para>A UnityWebRequest object configured to retrieve data from uri.</para>
  573. </returns>
  574. </member>
  575. <member name="M:UnityEngine.Networking.UnityWebRequest.GetAssetBundle(System.String,System.UInt32)">
  576. <summary>
  577. <para>Deprecated. Replaced by UnityWebRequestAssetBundle.GetAssetBundle.</para>
  578. </summary>
  579. <param name="uri"></param>
  580. <param name="crc"></param>
  581. <param name="version"></param>
  582. <param name="hash"></param>
  583. <param name="cachedAssetBundle"></param>
  584. </member>
  585. <member name="M:UnityEngine.Networking.UnityWebRequest.GetAssetBundle(System.String,System.UInt32,System.UInt32)">
  586. <summary>
  587. <para>Deprecated. Replaced by UnityWebRequestAssetBundle.GetAssetBundle.</para>
  588. </summary>
  589. <param name="uri"></param>
  590. <param name="crc"></param>
  591. <param name="version"></param>
  592. <param name="hash"></param>
  593. <param name="cachedAssetBundle"></param>
  594. </member>
  595. <member name="M:UnityEngine.Networking.UnityWebRequest.GetAssetBundle(System.String,UnityEngine.Hash128,System.UInt32)">
  596. <summary>
  597. <para>Deprecated. Replaced by UnityWebRequestAssetBundle.GetAssetBundle.</para>
  598. </summary>
  599. <param name="uri"></param>
  600. <param name="crc"></param>
  601. <param name="version"></param>
  602. <param name="hash"></param>
  603. <param name="cachedAssetBundle"></param>
  604. </member>
  605. <member name="M:UnityEngine.Networking.UnityWebRequest.GetAssetBundle(System.String,UnityEngine.CachedAssetBundle,System.UInt32)">
  606. <summary>
  607. <para>Deprecated. Replaced by UnityWebRequestAssetBundle.GetAssetBundle.</para>
  608. </summary>
  609. <param name="uri"></param>
  610. <param name="crc"></param>
  611. <param name="version"></param>
  612. <param name="hash"></param>
  613. <param name="cachedAssetBundle"></param>
  614. </member>
  615. <member name="M:UnityEngine.Networking.UnityWebRequest.GetAudioClip(System.String,UnityEngine.AudioType)">
  616. <summary>
  617. <para>OBSOLETE. Use UnityWebRequestMultimedia.GetAudioClip().</para>
  618. </summary>
  619. <param name="uri"></param>
  620. <param name="audioType"></param>
  621. </member>
  622. <member name="M:UnityEngine.Networking.UnityWebRequest.GetRequestHeader(System.String)">
  623. <summary>
  624. <para>Retrieves the value of a custom request header.</para>
  625. </summary>
  626. <param name="name">Name of the custom request header. Case-insensitive.</param>
  627. <returns>
  628. <para>The value of the custom request header. If no custom header with a matching name has been set, returns an empty string.</para>
  629. </returns>
  630. </member>
  631. <member name="M:UnityEngine.Networking.UnityWebRequest.GetResponseHeader(System.String)">
  632. <summary>
  633. <para>Retrieves the value of a response header from the latest HTTP response received.</para>
  634. </summary>
  635. <param name="name">The name of the HTTP header to retrieve. Case-insensitive.</param>
  636. <returns>
  637. <para>The value of the HTTP header from the latest HTTP response. If no header with a matching name has been received, or no responses have been received, returns null.</para>
  638. </returns>
  639. </member>
  640. <member name="M:UnityEngine.Networking.UnityWebRequest.GetResponseHeaders">
  641. <summary>
  642. <para>Retrieves a dictionary containing all the response headers received by this UnityWebRequest in the latest HTTP response.</para>
  643. </summary>
  644. <returns>
  645. <para>A dictionary containing all the response headers received in the latest HTTP response. If no responses have been received, returns null.</para>
  646. </returns>
  647. </member>
  648. <member name="M:UnityEngine.Networking.UnityWebRequest.GetTexture(System.String)">
  649. <summary>
  650. <para>Creates a UnityWebRequest intended to download an image via HTTP GET and create a Texture based on the retrieved data.</para>
  651. </summary>
  652. <param name="uri">The URI of the image to download.</param>
  653. <param name="nonReadable">If true, the texture's raw data will not be accessible to script. This can conserve memory. Default: false.</param>
  654. <returns>
  655. <para>A UnityWebRequest properly configured to download an image and convert it to a Texture.</para>
  656. </returns>
  657. </member>
  658. <member name="M:UnityEngine.Networking.UnityWebRequest.GetTexture(System.String,System.Boolean)">
  659. <summary>
  660. <para>Creates a UnityWebRequest intended to download an image via HTTP GET and create a Texture based on the retrieved data.</para>
  661. </summary>
  662. <param name="uri">The URI of the image to download.</param>
  663. <param name="nonReadable">If true, the texture's raw data will not be accessible to script. This can conserve memory. Default: false.</param>
  664. <returns>
  665. <para>A UnityWebRequest properly configured to download an image and convert it to a Texture.</para>
  666. </returns>
  667. </member>
  668. <member name="M:UnityEngine.Networking.UnityWebRequest.Head(System.String)">
  669. <summary>
  670. <para>Creates a UnityWebRequest configured to send a HTTP HEAD request.</para>
  671. </summary>
  672. <param name="uri">The URI to which to send a HTTP HEAD request.</param>
  673. <returns>
  674. <para>A UnityWebRequest configured to transmit a HTTP HEAD request.</para>
  675. </returns>
  676. </member>
  677. <member name="M:UnityEngine.Networking.UnityWebRequest.Post(System.String,System.String)">
  678. <summary>
  679. <para>Creates a UnityWebRequest configured to send form data to a server via HTTP POST.</para>
  680. </summary>
  681. <param name="uri">The target URI to which form data will be transmitted.</param>
  682. <param name="postData">Form body data. Will be URLEncoded prior to transmission.</param>
  683. <returns>
  684. <para>A UnityWebRequest configured to send form data to uri via POST.</para>
  685. </returns>
  686. </member>
  687. <member name="M:UnityEngine.Networking.UnityWebRequest.Post(System.String,UnityEngine.WWWForm)">
  688. <summary>
  689. <para>Create a UnityWebRequest configured to send form data to a server via HTTP POST.</para>
  690. </summary>
  691. <param name="uri">The target URI to which form data will be transmitted.</param>
  692. <param name="formData">Form fields or files encapsulated in a WWWForm object, for formatting and transmission to the remote server.</param>
  693. <returns>
  694. <para>A UnityWebRequest configured to send form data to uri via POST.</para>
  695. </returns>
  696. </member>
  697. <member name="M:UnityEngine.Networking.UnityWebRequest.Post(System.String,System.Collections.Generic.List`1&lt;UnityEngine.Networking.IMultipartFormSection&gt;)">
  698. <summary>
  699. <para>Create a UnityWebRequest configured to send form data to a server via HTTP POST.</para>
  700. </summary>
  701. <param name="uri">The target URI to which form data will be transmitted.</param>
  702. <param name="multipartFormSections">A list of form fields or files to be formatted and transmitted to the remote server.</param>
  703. <param name="boundary">A unique boundary string, which will be used when separating form fields in a multipart form. If not supplied, a boundary will be generated for you.</param>
  704. <returns>
  705. <para>A UnityWebRequest configured to send form data to uri via POST.</para>
  706. </returns>
  707. </member>
  708. <member name="M:UnityEngine.Networking.UnityWebRequest.Post(System.String,System.Collections.Generic.List`1&lt;UnityEngine.Networking.IMultipartFormSection&gt;,System.Byte[])">
  709. <summary>
  710. <para>Create a UnityWebRequest configured to send form data to a server via HTTP POST.</para>
  711. </summary>
  712. <param name="uri">The target URI to which form data will be transmitted.</param>
  713. <param name="multipartFormSections">A list of form fields or files to be formatted and transmitted to the remote server.</param>
  714. <param name="boundary">A unique boundary string, which will be used when separating form fields in a multipart form. If not supplied, a boundary will be generated for you.</param>
  715. <returns>
  716. <para>A UnityWebRequest configured to send form data to uri via POST.</para>
  717. </returns>
  718. </member>
  719. <member name="M:UnityEngine.Networking.UnityWebRequest.Post(System.String,System.Collections.Generic.Dictionary`2&lt;System.String,System.String&gt;)">
  720. <summary>
  721. <para>Create a UnityWebRequest configured to send form data to a server via HTTP POST.</para>
  722. </summary>
  723. <param name="uri">The target URI to which form data will be transmitted.</param>
  724. <param name="formFields">Strings indicating the keys and values of form fields. Will be automatically formatted into a URL-encoded form body.</param>
  725. <returns>
  726. <para>A UnityWebRequest configured to send form data to uri via POST.</para>
  727. </returns>
  728. </member>
  729. <member name="M:UnityEngine.Networking.UnityWebRequest.Put(System.String,System.Byte[])">
  730. <summary>
  731. <para>Creates a UnityWebRequest configured to upload raw data to a remote server via HTTP PUT.</para>
  732. </summary>
  733. <param name="uri">The URI to which the data will be sent.</param>
  734. <param name="bodyData">The data to transmit to the remote server.
  735. If a string, the string will be converted to raw bytes via &lt;a href="http:msdn.microsoft.comen-uslibrarysystem.text.encoding.utf8"&gt;System.Text.Encoding.UTF8&lt;a&gt;.</param>
  736. <returns>
  737. <para>A UnityWebRequest configured to transmit bodyData to uri via HTTP PUT.</para>
  738. </returns>
  739. </member>
  740. <member name="M:UnityEngine.Networking.UnityWebRequest.Put(System.String,System.String)">
  741. <summary>
  742. <para>Creates a UnityWebRequest configured to upload raw data to a remote server via HTTP PUT.</para>
  743. </summary>
  744. <param name="uri">The URI to which the data will be sent.</param>
  745. <param name="bodyData">The data to transmit to the remote server.
  746. If a string, the string will be converted to raw bytes via &lt;a href="http:msdn.microsoft.comen-uslibrarysystem.text.encoding.utf8"&gt;System.Text.Encoding.UTF8&lt;a&gt;.</param>
  747. <returns>
  748. <para>A UnityWebRequest configured to transmit bodyData to uri via HTTP PUT.</para>
  749. </returns>
  750. </member>
  751. <member name="M:UnityEngine.Networking.UnityWebRequest.Send">
  752. <summary>
  753. <para>Begin communicating with the remote server.</para>
  754. </summary>
  755. <returns>
  756. <para>An AsyncOperation indicating the progress/completion state of the UnityWebRequest. Yield this object to wait until the UnityWebRequest is done.</para>
  757. </returns>
  758. </member>
  759. <member name="M:UnityEngine.Networking.UnityWebRequest.SendWebRequest">
  760. <summary>
  761. <para>Begin communicating with the remote server.
  762. After calling this method, the UnityWebRequest will perform DNS resolution (if necessary), transmit an HTTP request to the remote server at the target URL and process the server’s response.
  763. This method can only be called once on any given UnityWebRequest object. Once this method is called, you cannot change any of the UnityWebRequest’s properties.
  764. This method returns a WebRequestAsyncOperation object. Yielding the WebRequestAsyncOperation inside a coroutine will cause the coroutine to pause until the UnityWebRequest encounters a system error or finishes communicating.</para>
  765. </summary>
  766. </member>
  767. <member name="M:UnityEngine.Networking.UnityWebRequest.SerializeFormSections(System.Collections.Generic.List`1&lt;UnityEngine.Networking.IMultipartFormSection&gt;,System.Byte[])">
  768. <summary>
  769. <para>Converts a List of IMultipartFormSection objects into a byte array containing raw multipart form data.</para>
  770. </summary>
  771. <param name="multipartFormSections">A List of IMultipartFormSection objects.</param>
  772. <param name="boundary">A unique boundary string to separate the form sections.</param>
  773. <returns>
  774. <para>A byte array of raw multipart form data.</para>
  775. </returns>
  776. </member>
  777. <member name="M:UnityEngine.Networking.UnityWebRequest.SerializeSimpleForm(System.Collections.Generic.Dictionary`2&lt;System.String,System.String&gt;)">
  778. <summary>
  779. <para>Serialize a dictionary of strings into a byte array containing URL-encoded UTF8 characters.</para>
  780. </summary>
  781. <param name="formFields">A dictionary containing the form keys and values to serialize.</param>
  782. <returns>
  783. <para>A byte array containing the serialized form. The form's keys and values have been URL-encoded.</para>
  784. </returns>
  785. </member>
  786. <member name="M:UnityEngine.Networking.UnityWebRequest.SetRequestHeader(System.String,System.String)">
  787. <summary>
  788. <para>Set a HTTP request header to a custom value.</para>
  789. </summary>
  790. <param name="name">The key of the header to be set. Case-sensitive.</param>
  791. <param name="value">The header's intended value.</param>
  792. </member>
  793. <member name="M:UnityEngine.Networking.UnityWebRequest.UnEscapeURL(System.String)">
  794. <summary>
  795. <para>Converts URL-friendly escape sequences back to normal text.</para>
  796. </summary>
  797. <param name="s">A string containing escaped characters.</param>
  798. <param name="e">The text encoding to use.</param>
  799. </member>
  800. <member name="M:UnityEngine.Networking.UnityWebRequest.UnEscapeURL(System.String,System.Text.Encoding)">
  801. <summary>
  802. <para>Converts URL-friendly escape sequences back to normal text.</para>
  803. </summary>
  804. <param name="s">A string containing escaped characters.</param>
  805. <param name="e">The text encoding to use.</param>
  806. </member>
  807. <member name="T:UnityEngine.Networking.UnityWebRequestAsyncOperation">
  808. <summary>
  809. <para>Asynchronous operation object returned from UnityWebRequest.SendWebRequest().
  810. You can yield until it continues, register an event handler with AsyncOperation.completed, or manually check whether it's done (AsyncOperation.isDone) or progress (AsyncOperation.progress).</para>
  811. </summary>
  812. </member>
  813. <member name="P:UnityEngine.Networking.UnityWebRequestAsyncOperation.webRequest">
  814. <summary>
  815. <para>Returns the associated UnityWebRequest that created the operation.</para>
  816. </summary>
  817. </member>
  818. <member name="T:UnityEngine.Networking.UploadHandler">
  819. <summary>
  820. <para>Helper object for UnityWebRequests. Manages the buffering and transmission of body data during HTTP requests.</para>
  821. </summary>
  822. </member>
  823. <member name="P:UnityEngine.Networking.UploadHandler.contentType">
  824. <summary>
  825. <para>Determines the default Content-Type header which will be transmitted with the outbound HTTP request.</para>
  826. </summary>
  827. </member>
  828. <member name="P:UnityEngine.Networking.UploadHandler.data">
  829. <summary>
  830. <para>The raw data which will be transmitted to the remote server as body data. (Read Only)</para>
  831. </summary>
  832. </member>
  833. <member name="P:UnityEngine.Networking.UploadHandler.progress">
  834. <summary>
  835. <para>Returns the proportion of data uploaded to the remote server compared to the total amount of data to upload. (Read Only)</para>
  836. </summary>
  837. </member>
  838. <member name="M:UnityEngine.Networking.UploadHandler.Dispose">
  839. <summary>
  840. <para>Signals that this [UploadHandler] is no longer being used, and should clean up any resources it is using.</para>
  841. </summary>
  842. </member>
  843. <member name="T:UnityEngine.Networking.UploadHandlerFile">
  844. <summary>
  845. <para>A specialized UploadHandler that reads data from a given file and sends raw bytes to the server as the request body.</para>
  846. </summary>
  847. </member>
  848. <member name="M:UnityEngine.Networking.UploadHandlerFile.#ctor(System.String)">
  849. <summary>
  850. <para>Create a new upload handler to send data from the given file to the server.</para>
  851. </summary>
  852. <param name="filePath">A file containing data to send.</param>
  853. </member>
  854. <member name="T:UnityEngine.Networking.UploadHandlerRaw">
  855. <summary>
  856. <para>A general-purpose UploadHandler subclass, using a native-code memory buffer.</para>
  857. </summary>
  858. </member>
  859. <member name="M:UnityEngine.Networking.UploadHandlerRaw.#ctor(System.Byte[])">
  860. <summary>
  861. <para>General constructor. Contents of the input argument are copied into a native buffer.</para>
  862. </summary>
  863. <param name="data">Raw data to transmit to the remote server.</param>
  864. </member>
  865. <member name="A:UnityEngine.UnityWebRequestModule">
  866. <summary>
  867. <para>The UnityWebRequest module lets you communicate with http services.</para>
  868. </summary>
  869. </member>
  870. <member name="T:UnityEngine.WWWForm">
  871. <summary>
  872. <para>Helper class to generate form data to post to web servers using the UnityWebRequest or WWW classes.</para>
  873. </summary>
  874. </member>
  875. <member name="P:UnityEngine.WWWForm.data">
  876. <summary>
  877. <para>(Read Only) The raw data to pass as the POST request body when sending the form.</para>
  878. </summary>
  879. </member>
  880. <member name="P:UnityEngine.WWWForm.headers">
  881. <summary>
  882. <para>(Read Only) Returns the correct request headers for posting the form using the WWW class.</para>
  883. </summary>
  884. </member>
  885. <member name="M:UnityEngine.WWWForm.AddBinaryData(System.String,System.Byte[])">
  886. <summary>
  887. <para>Add binary data to the form.</para>
  888. </summary>
  889. <param name="fieldName"></param>
  890. <param name="contents"></param>
  891. <param name="fileName"></param>
  892. <param name="mimeType"></param>
  893. </member>
  894. <member name="M:UnityEngine.WWWForm.AddBinaryData(System.String,System.Byte[],System.String)">
  895. <summary>
  896. <para>Add binary data to the form.</para>
  897. </summary>
  898. <param name="fieldName"></param>
  899. <param name="contents"></param>
  900. <param name="fileName"></param>
  901. <param name="mimeType"></param>
  902. </member>
  903. <member name="M:UnityEngine.WWWForm.AddBinaryData(System.String,System.Byte[],System.String,System.String)">
  904. <summary>
  905. <para>Add binary data to the form.</para>
  906. </summary>
  907. <param name="fieldName"></param>
  908. <param name="contents"></param>
  909. <param name="fileName"></param>
  910. <param name="mimeType"></param>
  911. </member>
  912. <member name="M:UnityEngine.WWWForm.AddField(System.String,System.String)">
  913. <summary>
  914. <para>Add a simple field to the form.</para>
  915. </summary>
  916. <param name="fieldName"></param>
  917. <param name="value"></param>
  918. <param name="e"></param>
  919. </member>
  920. <member name="M:UnityEngine.WWWForm.AddField(System.String,System.String,System.Text.Encoding)">
  921. <summary>
  922. <para>Add a simple field to the form.</para>
  923. </summary>
  924. <param name="fieldName"></param>
  925. <param name="value"></param>
  926. <param name="e"></param>
  927. </member>
  928. <member name="M:UnityEngine.WWWForm.AddField(System.String,System.Int32)">
  929. <summary>
  930. <para>Adds a simple field to the form.</para>
  931. </summary>
  932. <param name="fieldName"></param>
  933. <param name="i"></param>
  934. </member>
  935. <member name="M:UnityEngine.WWWForm.#ctor">
  936. <summary>
  937. <para>Creates an empty WWWForm object.</para>
  938. </summary>
  939. </member>
  940. </members>
  941. </doc>