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