class_plupload.File.html 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194
  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.File</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.File</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">File</td>
  27. </tr>
  28. </table>
  29. <div class="classDescription">File instance.
  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.File.html#id">id</a> : String</div>
  45. <div class="summary">File id this is a globally unique id for the specific file.</div>
  46. </td>
  47. <td class="last">File</td>
  48. </tr>
  49. <tr class="even">
  50. <td class="first">
  51. <div>
  52. <a class="memberName" href="class_plupload.File.html#loaded">loaded</a> : Number</div>
  53. <div class="summary">Number of bytes uploaded of the files total size.</div>
  54. </td>
  55. <td class="last">File</td>
  56. </tr>
  57. <tr>
  58. <td class="first">
  59. <div>
  60. <a class="memberName" href="class_plupload.File.html#name">name</a> : String</div>
  61. <div class="summary">File name for example "myfile.</div>
  62. </td>
  63. <td class="last">File</td>
  64. </tr>
  65. <tr class="even">
  66. <td class="first">
  67. <div>
  68. <a class="memberName" href="class_plupload.File.html#percent">percent</a> : Number</div>
  69. <div class="summary">Number of percentage uploaded of the file.</div>
  70. </td>
  71. <td class="last">File</td>
  72. </tr>
  73. <tr>
  74. <td class="first">
  75. <div>
  76. <a class="memberName" href="class_plupload.File.html#size">size</a> : Number</div>
  77. <div class="summary">File size in bytes.</div>
  78. </td>
  79. <td class="last">File</td>
  80. </tr>
  81. <tr class="even">
  82. <td class="first">
  83. <div>
  84. <a class="memberName" href="class_plupload.File.html#status">status</a> : Number</div>
  85. <div class="summary">Status constant matching the plupload states QUEUED, UPLOADING, FAILED, DONE.</div>
  86. </td>
  87. <td class="last">File</td>
  88. </tr>
  89. </tbody>
  90. </table>
  91. <h2>Public Methods</h2>
  92. <table class="Methods summary">
  93. <thead>
  94. <tr>
  95. <th>Method</th>
  96. <th>Defined By</th>
  97. </tr>
  98. </thead>
  99. <tbody>
  100. <tr>
  101. <td class="first">
  102. <div>
  103. <a class="memberName" href="class_plupload.File.html#File">File</a>(id:String, name:String, size:Number)</div>
  104. <div class="summary">Constructs a new file instance.</div>
  105. </td>
  106. <td class="last">File</td>
  107. </tr>
  108. </tbody>
  109. </table>
  110. </div>
  111. <div class="detailsList">
  112. <div class="details">
  113. <h2>Property details</h2>
  114. <div class="memberDetails" id="id">
  115. <h3>id<span class="memberType">property</span>
  116. </h3>
  117. <code class="syntax">public id : String</code>
  118. <div class="memberDescription">File id this is a globally unique id for the specific file.
  119. </div>
  120. </div>
  121. <div class="memberDetails" id="loaded">
  122. <h3>loaded<span class="memberType">property</span>
  123. </h3>
  124. <code class="syntax">public loaded : Number</code>
  125. <div class="memberDescription">Number of bytes uploaded of the files total size.
  126. </div>
  127. </div>
  128. <div class="memberDetails" id="name">
  129. <h3>name<span class="memberType">property</span>
  130. </h3>
  131. <code class="syntax">public name : String</code>
  132. <div class="memberDescription">File name for example "myfile.gif".
  133. </div>
  134. </div>
  135. <div class="memberDetails" id="percent">
  136. <h3>percent<span class="memberType">property</span>
  137. </h3>
  138. <code class="syntax">public percent : Number</code>
  139. <div class="memberDescription">Number of percentage uploaded of the file.
  140. </div>
  141. </div>
  142. <div class="memberDetails" id="size">
  143. <h3>size<span class="memberType">property</span>
  144. </h3>
  145. <code class="syntax">public size : Number</code>
  146. <div class="memberDescription">File size in bytes.
  147. </div>
  148. </div>
  149. <div class="memberDetails last" id="status">
  150. <h3>status<span class="memberType">property</span>
  151. </h3>
  152. <code class="syntax">public status : Number</code>
  153. <div class="memberDescription">Status constant matching the plupload states QUEUED, UPLOADING, FAILED, DONE.
  154. </div>
  155. <h4>See Also</h4>
  156. <ul class="see">
  157. <li>
  158. <a href="class_plupload.html">plupload</a>
  159. </li>
  160. </ul>
  161. </div>
  162. </div>
  163. <div class="details">
  164. <h2>Method details</h2>
  165. <div class="memberDetails last" id="File">
  166. <h3>File<span class="memberType">constructor</span>
  167. </h3>
  168. <code class="syntax">public
  169. function File(id:String, name:String, size:Number)</code>
  170. <div class="memberDescription">Constructs a new file instance.
  171. </div>
  172. <h4>Parameters</h4>
  173. <table class="params">
  174. <tr>
  175. <td class="first">id:String</td>
  176. <td class="last">Unique file id.</td>
  177. </tr>
  178. <tr>
  179. <td class="first">name:String</td>
  180. <td class="last">File name.</td>
  181. </tr>
  182. <tr>
  183. <td class="first">size:Number</td>
  184. <td class="last">File size in bytes.</td>
  185. </tr>
  186. </table>
  187. </div>
  188. </div>
  189. </div>
  190. </div>
  191. </body>
  192. </html>