class_plupload.QueueProgress.html 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
  2. <html>
  3. <head>
  4. <title>Class: plupload.QueueProgress</title>
  5. <meta name="generator" content="MoxieDoc" />
  6. <link rel="stylesheet" type="text/css" href="css/reset.css" />
  7. <link rel="stylesheet" type="text/css" href="css/grids.css" />
  8. <link rel="stylesheet" type="text/css" href="css/general.css" />
  9. <script type="text/javascript" src="http://www.google.com/jsapi"></script>
  10. <script type="text/javascript">
  11. google.load("jquery", "1.3");
  12. </script>
  13. <script type="text/javascript" src="js/jquery.treeview.min.js"></script>
  14. <script type="text/javascript" src="js/general.js"></script>
  15. </head>
  16. <body>
  17. <div class="classDetailsContent">
  18. <h1>plupload.QueueProgress</h1>
  19. <table class="classDetails">
  20. <tr>
  21. <td class="first">Namespace</td>
  22. <td class="last">plupload</td>
  23. </tr>
  24. <tr>
  25. <td class="first">Class</td>
  26. <td class="last">QueueProgress</td>
  27. </tr>
  28. </table>
  29. <div class="classDescription">Runtime class gets implemented by each upload runtime.
  30. </div>
  31. <div class="summaryLists">
  32. <h2>Public Properties</h2>
  33. <table class="Properties summary">
  34. <thead>
  35. <tr>
  36. <th>Property</th>
  37. <th>Defined By</th>
  38. </tr>
  39. </thead>
  40. <tbody>
  41. <tr>
  42. <td class="first">
  43. <div>
  44. <a class="memberName" href="class_plupload.QueueProgress.html#bytesPerSec">bytesPerSec</a> : Number</div>
  45. <div class="summary">Bytes uploaded per second.</div>
  46. </td>
  47. <td class="last">QueueProgress</td>
  48. </tr>
  49. <tr class="even">
  50. <td class="first">
  51. <div>
  52. <a class="memberName" href="class_plupload.QueueProgress.html#failed">failed</a> : Number</div>
  53. <div class="summary">Number of files failed to upload.</div>
  54. </td>
  55. <td class="last">QueueProgress</td>
  56. </tr>
  57. <tr>
  58. <td class="first">
  59. <div>
  60. <a class="memberName" href="class_plupload.QueueProgress.html#loaded">loaded</a> : Number</div>
  61. <div class="summary">Total bytes uploaded.</div>
  62. </td>
  63. <td class="last">QueueProgress</td>
  64. </tr>
  65. <tr class="even">
  66. <td class="first">
  67. <div>
  68. <a class="memberName" href="class_plupload.QueueProgress.html#percent">percent</a> : Number</div>
  69. <div class="summary">Total percent of the uploaded bytes.</div>
  70. </td>
  71. <td class="last">QueueProgress</td>
  72. </tr>
  73. <tr>
  74. <td class="first">
  75. <div>
  76. <a class="memberName" href="class_plupload.QueueProgress.html#queued">queued</a> : Number</div>
  77. <div class="summary">Number of files yet to be uploaded.</div>
  78. </td>
  79. <td class="last">QueueProgress</td>
  80. </tr>
  81. <tr class="even">
  82. <td class="first">
  83. <div>
  84. <a class="memberName" href="class_plupload.QueueProgress.html#size">size</a> : Number</div>
  85. <div class="summary">Total queue file size.</div>
  86. </td>
  87. <td class="last">QueueProgress</td>
  88. </tr>
  89. <tr>
  90. <td class="first">
  91. <div>
  92. <a class="memberName" href="class_plupload.QueueProgress.html#uploaded">uploaded</a> : Number</div>
  93. <div class="summary">Number of files uploaded.</div>
  94. </td>
  95. <td class="last">QueueProgress</td>
  96. </tr>
  97. </tbody>
  98. </table>
  99. <h2>Public Methods</h2>
  100. <table class="Methods summary">
  101. <thead>
  102. <tr>
  103. <th>Method</th>
  104. <th>Defined By</th>
  105. </tr>
  106. </thead>
  107. <tbody>
  108. <tr>
  109. <td class="first">
  110. <div>
  111. <a class="memberName" href="class_plupload.QueueProgress.html#QueueProgress">QueueProgress</a>()</div>
  112. <div class="summary">Constructs a queue progress.</div>
  113. </td>
  114. <td class="last">QueueProgress</td>
  115. </tr>
  116. <tr class="even">
  117. <td class="first">
  118. <div>
  119. <a class="memberName" href="class_plupload.QueueProgress.html#reset">reset</a>():void</div>
  120. <div class="summary">Resets the progress to it's initial values.</div>
  121. </td>
  122. <td class="last">QueueProgress</td>
  123. </tr>
  124. </tbody>
  125. </table>
  126. </div>
  127. <div class="detailsList">
  128. <div class="details">
  129. <h2>Property details</h2>
  130. <div class="memberDetails" id="bytesPerSec">
  131. <h3>bytesPerSec<span class="memberType">property</span>
  132. </h3>
  133. <code class="syntax">public bytesPerSec : Number</code>
  134. <div class="memberDescription">Bytes uploaded per second.
  135. </div>
  136. </div>
  137. <div class="memberDetails" id="failed">
  138. <h3>failed<span class="memberType">property</span>
  139. </h3>
  140. <code class="syntax">public failed : Number</code>
  141. <div class="memberDescription">Number of files failed to upload.
  142. </div>
  143. </div>
  144. <div class="memberDetails" id="loaded">
  145. <h3>loaded<span class="memberType">property</span>
  146. </h3>
  147. <code class="syntax">public loaded : Number</code>
  148. <div class="memberDescription">Total bytes uploaded.
  149. </div>
  150. </div>
  151. <div class="memberDetails" id="percent">
  152. <h3>percent<span class="memberType">property</span>
  153. </h3>
  154. <code class="syntax">public percent : Number</code>
  155. <div class="memberDescription">Total percent of the uploaded bytes.
  156. </div>
  157. </div>
  158. <div class="memberDetails" id="queued">
  159. <h3>queued<span class="memberType">property</span>
  160. </h3>
  161. <code class="syntax">public queued : Number</code>
  162. <div class="memberDescription">Number of files yet to be uploaded.
  163. </div>
  164. </div>
  165. <div class="memberDetails" id="size">
  166. <h3>size<span class="memberType">property</span>
  167. </h3>
  168. <code class="syntax">public size : Number</code>
  169. <div class="memberDescription">Total queue file size.
  170. </div>
  171. </div>
  172. <div class="memberDetails last" id="uploaded">
  173. <h3>uploaded<span class="memberType">property</span>
  174. </h3>
  175. <code class="syntax">public uploaded : Number</code>
  176. <div class="memberDescription">Number of files uploaded.
  177. </div>
  178. </div>
  179. </div>
  180. <div class="details">
  181. <h2>Method details</h2>
  182. <div class="memberDetails" id="QueueProgress">
  183. <h3>QueueProgress<span class="memberType">constructor</span>
  184. </h3>
  185. <code class="syntax">public
  186. function QueueProgress()</code>
  187. <div class="memberDescription">Constructs a queue progress.
  188. </div>
  189. </div>
  190. <div class="memberDetails last" id="reset">
  191. <h3>reset<span class="memberType">method</span>
  192. </h3>
  193. <code class="syntax">public
  194. function reset():void</code>
  195. <div class="memberDescription">Resets the progress to it's initial values.
  196. </div>
  197. </div>
  198. </div>
  199. </div>
  200. </div>
  201. </body>
  202. </html>