blob: a2f5f791fd3d0d0ad019e824d2066a5b69b95902 [file] [log] [blame]
Joe Gregorioebd0b842012-06-15 14:14:17 -04001<?xml version="1.0" encoding="ascii"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6 <title>apiclient.http.MediaDownloadProgress</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
9</head>
10
11<body bgcolor="white" text="black" link="blue" vlink="#204080"
12 alink="#204080">
13<!-- ==================== NAVIGATION BAR ==================== -->
14<table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
16 <tr valign="middle">
17
18 <!-- Tree link -->
19 <th>&nbsp;&nbsp;&nbsp;<a
20 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
21
22 <!-- Index link -->
23 <th>&nbsp;&nbsp;&nbsp;<a
24 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
25
26 <!-- Help link -->
27 <th>&nbsp;&nbsp;&nbsp;<a
28 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
29
30 <th class="navbar" width="100%"></th>
31 </tr>
32</table>
33<table width="100%" cellpadding="0" cellspacing="0">
34 <tr valign="top">
35 <td width="100%">
36 <span class="breadcrumbs">
37 <a href="apiclient-module.html">Package&nbsp;apiclient</a> ::
38 <a href="apiclient.http-module.html">Module&nbsp;http</a> ::
39 Class&nbsp;MediaDownloadProgress
40 </span>
41 </td>
42 <td>
43 <table cellpadding="0" cellspacing="0">
44 <!-- hide/show private -->
45 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
46 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
47 <tr><td align="right"><span class="options"
48 >[<a href="frames.html" target="_top">frames</a
49 >]&nbsp;|&nbsp;<a href="apiclient.http.MediaDownloadProgress-class.html"
50 target="_top">no&nbsp;frames</a>]</span></td></tr>
51 </table>
52 </td>
53 </tr>
54</table>
55<!-- ==================== CLASS DESCRIPTION ==================== -->
56<h1 class="epydoc">Class MediaDownloadProgress</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.http-pysrc.html#MediaDownloadProgress">source&nbsp;code</a></span></p>
57<center>
58<center> <map id="class_hierarchy_for_mediadownl" name="class_hierarchy_for_mediadownl">
59<area shape="rect" href="apiclient.http.MediaDownloadProgress-class.html" title="MediaDownloadProgress" alt="" coords="5,5,168,32"/>
60</map>
61 <img src="class_hierarchy_for_mediadownl.gif" alt='' usemap="#class_hierarchy_for_mediadownl" ismap="ismap" class="graph-without-title" />
62</center>
63</center>
64<hr />
65<pre class="literalblock">
66Status of a resumable download.
67
68</pre>
69
70<!-- ==================== INSTANCE METHODS ==================== -->
71<a name="section-InstanceMethods"></a>
72<table class="summary" border="1" cellpadding="3"
73 cellspacing="0" width="100%" bgcolor="white">
74<tr bgcolor="#70b0f0" class="table-header">
75 <td colspan="2" class="table-header">
76 <table border="0" cellpadding="0" cellspacing="0" width="100%">
77 <tr valign="top">
78 <td align="left"><span class="table-header">Instance Methods</span></td>
79 <td align="right" valign="top"
80 ><span class="options">[<a href="#section-InstanceMethods"
81 class="privatelink" onclick="toggle_private();"
82 >hide private</a>]</span></td>
83 </tr>
84 </table>
85 </td>
86</tr>
87<tr>
88 <td width="15%" align="right" valign="top" class="summary">
89 <span class="summary-type">&nbsp;</span>
90 </td><td class="summary">
91 <table width="100%" cellpadding="0" cellspacing="0" border="0">
92 <tr>
93 <td><span class="summary-sig"><a href="apiclient.http.MediaDownloadProgress-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
94 <span class="summary-sig-arg">resumable_progress</span>,
95 <span class="summary-sig-arg">total_size</span>)</span><br />
96 Constructor.</td>
97 <td align="right" valign="top">
98 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaDownloadProgress.__init__">source&nbsp;code</a></span>
99
100 </td>
101 </tr>
102 </table>
103
104 </td>
105 </tr>
106<tr>
107 <td width="15%" align="right" valign="top" class="summary">
108 <span class="summary-type">&nbsp;</span>
109 </td><td class="summary">
110 <table width="100%" cellpadding="0" cellspacing="0" border="0">
111 <tr>
112 <td><span class="summary-sig"><a href="apiclient.http.MediaDownloadProgress-class.html#progress" class="summary-sig-name">progress</a>(<span class="summary-sig-arg">self</span>)</span><br />
113 Percent of download completed, as a float.</td>
114 <td align="right" valign="top">
115 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaDownloadProgress.progress">source&nbsp;code</a></span>
116
117 </td>
118 </tr>
119 </table>
120
121 </td>
122 </tr>
123 <tr>
124 <td colspan="2" class="summary">
125 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
126 <code>__delattr__</code>,
127 <code>__format__</code>,
128 <code>__getattribute__</code>,
129 <code>__hash__</code>,
130 <code>__new__</code>,
131 <code>__reduce__</code>,
132 <code>__reduce_ex__</code>,
133 <code>__repr__</code>,
134 <code>__setattr__</code>,
135 <code>__sizeof__</code>,
136 <code>__str__</code>,
137 <code>__subclasshook__</code>
138 </p>
139 </td>
140 </tr>
141</table>
142<!-- ==================== PROPERTIES ==================== -->
143<a name="section-Properties"></a>
144<table class="summary" border="1" cellpadding="3"
145 cellspacing="0" width="100%" bgcolor="white">
146<tr bgcolor="#70b0f0" class="table-header">
147 <td colspan="2" class="table-header">
148 <table border="0" cellpadding="0" cellspacing="0" width="100%">
149 <tr valign="top">
150 <td align="left"><span class="table-header">Properties</span></td>
151 <td align="right" valign="top"
152 ><span class="options">[<a href="#section-Properties"
153 class="privatelink" onclick="toggle_private();"
154 >hide private</a>]</span></td>
155 </tr>
156 </table>
157 </td>
158</tr>
159 <tr>
160 <td colspan="2" class="summary">
161 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
162 <code>__class__</code>
163 </p>
164 </td>
165 </tr>
166</table>
167<!-- ==================== METHOD DETAILS ==================== -->
168<a name="section-MethodDetails"></a>
169<table class="details" border="1" cellpadding="3"
170 cellspacing="0" width="100%" bgcolor="white">
171<tr bgcolor="#70b0f0" class="table-header">
172 <td colspan="2" class="table-header">
173 <table border="0" cellpadding="0" cellspacing="0" width="100%">
174 <tr valign="top">
175 <td align="left"><span class="table-header">Method Details</span></td>
176 <td align="right" valign="top"
177 ><span class="options">[<a href="#section-MethodDetails"
178 class="privatelink" onclick="toggle_private();"
179 >hide private</a>]</span></td>
180 </tr>
181 </table>
182 </td>
183</tr>
184</table>
185<a name="__init__"></a>
186<div>
187<table class="details" border="1" cellpadding="3"
188 cellspacing="0" width="100%" bgcolor="white">
189<tr><td>
190 <table width="100%" cellpadding="0" cellspacing="0" border="0">
191 <tr valign="top"><td>
192 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
193 <span class="sig-arg">resumable_progress</span>,
194 <span class="sig-arg">total_size</span>)</span>
195 <br /><em class="fname">(Constructor)</em>
196 </h3>
197 </td><td align="right" valign="top"
198 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaDownloadProgress.__init__">source&nbsp;code</a></span>&nbsp;
199 </td>
200 </tr></table>
201
202 <pre class="literalblock">
203Constructor.
204
205Args:
206 resumable_progress: int, bytes received so far.
207 total_size: int, total bytes in complete download.
208
209</pre>
210 <dl class="fields">
211 <dt>Overrides:
212 object.__init__
213 </dt>
214 </dl>
215</td></tr></table>
216</div>
217<a name="progress"></a>
218<div>
219<table class="details" border="1" cellpadding="3"
220 cellspacing="0" width="100%" bgcolor="white">
221<tr><td>
222 <table width="100%" cellpadding="0" cellspacing="0" border="0">
223 <tr valign="top"><td>
224 <h3 class="epydoc"><span class="sig"><span class="sig-name">progress</span>(<span class="sig-arg">self</span>)</span>
225 </h3>
226 </td><td align="right" valign="top"
227 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaDownloadProgress.progress">source&nbsp;code</a></span>&nbsp;
228 </td>
229 </tr></table>
230
231 <pre class="literalblock">
232Percent of download completed, as a float.
233
234Returns:
235 the percentage complete as a float, returning 0.0 if the total size of
236 the download is unknown.
237
238</pre>
239 <dl class="fields">
240 </dl>
241</td></tr></table>
242</div>
243<br />
244<!-- ==================== NAVIGATION BAR ==================== -->
245<table class="navbar" border="0" width="100%" cellpadding="0"
246 bgcolor="#a0c0ff" cellspacing="0">
247 <tr valign="middle">
248
249 <!-- Tree link -->
250 <th>&nbsp;&nbsp;&nbsp;<a
251 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
252
253 <!-- Index link -->
254 <th>&nbsp;&nbsp;&nbsp;<a
255 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
256
257 <!-- Help link -->
258 <th>&nbsp;&nbsp;&nbsp;<a
259 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
260
261 <th class="navbar" width="100%"></th>
262 </tr>
263</table>
264<table border="0" cellpadding="0" cellspacing="0" width="100%%">
265 <tr>
266 <td align="left" class="footer">
Joe Gregorio0cd347a2012-08-30 08:22:27 -0400267 Generated by Epydoc 3.0.1 on Thu Aug 30 07:12:43 2012
Joe Gregorioebd0b842012-06-15 14:14:17 -0400268 </td>
269 <td align="right" class="footer">
270 <a target="mainFrame" href="http://epydoc.sourceforge.net"
271 >http://epydoc.sourceforge.net</a>
272 </td>
273 </tr>
274</table>
275
276<script type="text/javascript">
277 <!--
278 // Private objects are initially displayed (because if
279 // javascript is turned off then we want them to be
280 // visible); but by default, we want to hide them. So hide
281 // them unless we have a cookie that says to show them.
282 checkCookie();
283 // -->
284</script>
285</body>
286</html>