blob: 7dfa0b4a00504248f2055d9a2e87592b7e80ff5c [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.model.MediaModel</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.model-module.html">Module&nbsp;model</a> ::
39 Class&nbsp;MediaModel
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.model.MediaModel-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 MediaModel</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.model-pysrc.html#MediaModel">source&nbsp;code</a></span></p>
57<center>
58<center> <map id="class_hierarchy_for_mediamodel" name="class_hierarchy_for_mediamodel">
Joe Gregoriof4839b02012-09-06 13:47:24 -040059<area shape="rect" href="apiclient.model.BaseModel-class.html" title="BaseModel" alt="" coords="5,5,91,32"/>
60<area shape="rect" href="apiclient.model.JsonModel-class.html" title="JsonModel" alt="" coords="115,5,197,32"/>
61<area shape="rect" href="apiclient.model.MediaModel-class.html" title="MediaModel" alt="" coords="221,5,312,32"/>
62<area shape="rect" href="apiclient.model.Model-class.html" title="Model" alt="" coords="336,5,392,32"/>
Joe Gregorioebd0b842012-06-15 14:14:17 -040063</map>
64 <img src="class_hierarchy_for_mediamodel.gif" alt='' usemap="#class_hierarchy_for_mediamodel" ismap="ismap" class="graph-without-title" />
65</center>
66</center>
67<hr />
68<pre class="literalblock">
69Model class for requests that return Media.
70
71Serializes and de-serializes between JSON and the Python
72object representation of HTTP request, and returns the raw bytes
73of the response body.
74
75</pre>
76
77<!-- ==================== INSTANCE METHODS ==================== -->
78<a name="section-InstanceMethods"></a>
79<table class="summary" border="1" cellpadding="3"
80 cellspacing="0" width="100%" bgcolor="white">
81<tr bgcolor="#70b0f0" class="table-header">
82 <td colspan="2" class="table-header">
83 <table border="0" cellpadding="0" cellspacing="0" width="100%">
84 <tr valign="top">
85 <td align="left"><span class="table-header">Instance Methods</span></td>
86 <td align="right" valign="top"
87 ><span class="options">[<a href="#section-InstanceMethods"
88 class="privatelink" onclick="toggle_private();"
89 >hide private</a>]</span></td>
90 </tr>
91 </table>
92 </td>
93</tr>
94<tr>
95 <td width="15%" align="right" valign="top" class="summary">
96 <span class="summary-type">&nbsp;</span>
97 </td><td class="summary">
98 <table width="100%" cellpadding="0" cellspacing="0" border="0">
99 <tr>
100 <td><span class="summary-sig"><a href="apiclient.model.MediaModel-class.html#deserialize" class="summary-sig-name">deserialize</a>(<span class="summary-sig-arg">self</span>,
101 <span class="summary-sig-arg">content</span>)</span><br />
102 Perform the actual deserialization from response string to Python
103object.</td>
104 <td align="right" valign="top">
105 <span class="codelink"><a href="apiclient.model-pysrc.html#MediaModel.deserialize">source&nbsp;code</a></span>
106
107 </td>
108 </tr>
109 </table>
110
111 </td>
112 </tr>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400113<tr>
114 <td width="15%" align="right" valign="top" class="summary">
115 <span class="summary-type">&nbsp;</span>
116 </td><td class="summary">
117 <table width="100%" cellpadding="0" cellspacing="0" border="0">
118 <tr>
119 <td><span class="summary-sig"><a href="apiclient.model.MediaModel-class.html#no_content_response" class="summary-sig-name">no_content_response</a>(<span class="summary-sig-arg">self</span>)</span></td>
120 <td align="right" valign="top">
121 <span class="codelink"><a href="apiclient.model-pysrc.html#MediaModel.no_content_response">source&nbsp;code</a></span>
122
123 </td>
124 </tr>
125 </table>
126
127 </td>
128 </tr>
Joe Gregorioebd0b842012-06-15 14:14:17 -0400129 <tr>
130 <td colspan="2" class="summary">
131 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.model.JsonModel-class.html">JsonModel</a></code></b>:
132 <code><a href="apiclient.model.JsonModel-class.html#__init__">__init__</a></code>,
133 <code><a href="apiclient.model.JsonModel-class.html#serialize">serialize</a></code>
134 </p>
135 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.model.BaseModel-class.html">BaseModel</a></code></b>:
136 <code><a href="apiclient.model.BaseModel-class.html#request">request</a></code>,
137 <code><a href="apiclient.model.BaseModel-class.html#response">response</a></code>
138 </p>
139 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.model.BaseModel-class.html">BaseModel</a></code></b> (private):
140 <code><a href="apiclient.model.BaseModel-class.html#_build_query" onclick="show_private();">_build_query</a></code>,
141 <code><a href="apiclient.model.BaseModel-class.html#_log_request" onclick="show_private();">_log_request</a></code>,
142 <code><a href="apiclient.model.BaseModel-class.html#_log_response" onclick="show_private();">_log_response</a></code>
143 </p></div>
144 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
145 <code>__delattr__</code>,
146 <code>__format__</code>,
147 <code>__getattribute__</code>,
148 <code>__hash__</code>,
149 <code>__new__</code>,
150 <code>__reduce__</code>,
151 <code>__reduce_ex__</code>,
152 <code>__repr__</code>,
153 <code>__setattr__</code>,
154 <code>__sizeof__</code>,
155 <code>__str__</code>,
156 <code>__subclasshook__</code>
157 </p>
158 </td>
159 </tr>
160</table>
161<!-- ==================== CLASS VARIABLES ==================== -->
162<a name="section-ClassVariables"></a>
163<table class="summary" border="1" cellpadding="3"
164 cellspacing="0" width="100%" bgcolor="white">
165<tr bgcolor="#70b0f0" class="table-header">
166 <td colspan="2" class="table-header">
167 <table border="0" cellpadding="0" cellspacing="0" width="100%">
168 <tr valign="top">
169 <td align="left"><span class="table-header">Class Variables</span></td>
170 <td align="right" valign="top"
171 ><span class="options">[<a href="#section-ClassVariables"
172 class="privatelink" onclick="toggle_private();"
173 >hide private</a>]</span></td>
174 </tr>
175 </table>
176 </td>
177</tr>
178<tr>
179 <td width="15%" align="right" valign="top" class="summary">
180 <span class="summary-type">&nbsp;</span>
181 </td><td class="summary">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400182 <a name="accept"></a><span class="summary-name">accept</span> = <code title="'*/*'">'*/*'</code>
Joe Gregorioebd0b842012-06-15 14:14:17 -0400183 </td>
184 </tr>
185<tr>
186 <td width="15%" align="right" valign="top" class="summary">
187 <span class="summary-type">&nbsp;</span>
188 </td><td class="summary">
189 <a name="content_type"></a><span class="summary-name">content_type</span> = <code title="'application/json'">'application/json'</code>
190 </td>
191 </tr>
192<tr>
193 <td width="15%" align="right" valign="top" class="summary">
194 <span class="summary-type">&nbsp;</span>
195 </td><td class="summary">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400196 <a name="alt_param"></a><span class="summary-name">alt_param</span> = <code title="'media'">'media'</code>
Joe Gregorioebd0b842012-06-15 14:14:17 -0400197 </td>
198 </tr>
199</table>
200<!-- ==================== PROPERTIES ==================== -->
201<a name="section-Properties"></a>
202<table class="summary" border="1" cellpadding="3"
203 cellspacing="0" width="100%" bgcolor="white">
204<tr bgcolor="#70b0f0" class="table-header">
205 <td colspan="2" class="table-header">
206 <table border="0" cellpadding="0" cellspacing="0" width="100%">
207 <tr valign="top">
208 <td align="left"><span class="table-header">Properties</span></td>
209 <td align="right" valign="top"
210 ><span class="options">[<a href="#section-Properties"
211 class="privatelink" onclick="toggle_private();"
212 >hide private</a>]</span></td>
213 </tr>
214 </table>
215 </td>
216</tr>
Joe Gregorioebd0b842012-06-15 14:14:17 -0400217 <tr>
218 <td colspan="2" class="summary">
219 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
220 <code>__class__</code>
221 </p>
222 </td>
223 </tr>
224</table>
225<!-- ==================== METHOD DETAILS ==================== -->
226<a name="section-MethodDetails"></a>
227<table class="details" border="1" cellpadding="3"
228 cellspacing="0" width="100%" bgcolor="white">
229<tr bgcolor="#70b0f0" class="table-header">
230 <td colspan="2" class="table-header">
231 <table border="0" cellpadding="0" cellspacing="0" width="100%">
232 <tr valign="top">
233 <td align="left"><span class="table-header">Method Details</span></td>
234 <td align="right" valign="top"
235 ><span class="options">[<a href="#section-MethodDetails"
236 class="privatelink" onclick="toggle_private();"
237 >hide private</a>]</span></td>
238 </tr>
239 </table>
240 </td>
241</tr>
242</table>
243<a name="deserialize"></a>
244<div>
245<table class="details" border="1" cellpadding="3"
246 cellspacing="0" width="100%" bgcolor="white">
247<tr><td>
248 <table width="100%" cellpadding="0" cellspacing="0" border="0">
249 <tr valign="top"><td>
250 <h3 class="epydoc"><span class="sig"><span class="sig-name">deserialize</span>(<span class="sig-arg">self</span>,
251 <span class="sig-arg">content</span>)</span>
252 </h3>
253 </td><td align="right" valign="top"
254 ><span class="codelink"><a href="apiclient.model-pysrc.html#MediaModel.deserialize">source&nbsp;code</a></span>&nbsp;
255 </td>
256 </tr></table>
257
258 <pre class="literalblock">
259Perform the actual deserialization from response string to Python
260object.
261
262Args:
263 content: string, the body of the HTTP response
264
265Returns:
266 The body de-serialized as a Python object.
267
268</pre>
269 <dl class="fields">
270 <dt>Overrides:
271 <a href="apiclient.model.BaseModel-class.html#deserialize">BaseModel.deserialize</a>
272 <dd><em class="note">(inherited documentation)</em></dd>
273 </dt>
274 </dl>
275</td></tr></table>
276</div>
Joe Gregorioebd0b842012-06-15 14:14:17 -0400277<a name="no_content_response"></a>
278<div>
279<table class="details" border="1" cellpadding="3"
280 cellspacing="0" width="100%" bgcolor="white">
281<tr><td>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400282 <table width="100%" cellpadding="0" cellspacing="0" border="0">
283 <tr valign="top"><td>
284 <h3 class="epydoc"><span class="sig"><span class="sig-name">no_content_response</span>(<span class="sig-arg">self</span>)</span>
285 </h3>
286 </td><td align="right" valign="top"
287 ><span class="codelink"><a href="apiclient.model-pysrc.html#MediaModel.no_content_response">source&nbsp;code</a></span>&nbsp;
288 </td>
289 </tr></table>
290
Joe Gregorioebd0b842012-06-15 14:14:17 -0400291
292 <dl class="fields">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400293 <dt>Decorators:</dt>
294 <dd><ul class="nomargin-top">
295 <li><code>@property</code></li>
296 </ul></dd>
297 <dt>Overrides:
298 <a href="apiclient.model.BaseModel-class.html#no_content_response">no_content_response</a>
299 </dt>
Joe Gregorioebd0b842012-06-15 14:14:17 -0400300 </dl>
301</td></tr></table>
302</div>
303<br />
304<!-- ==================== NAVIGATION BAR ==================== -->
305<table class="navbar" border="0" width="100%" cellpadding="0"
306 bgcolor="#a0c0ff" cellspacing="0">
307 <tr valign="middle">
308
309 <!-- Tree link -->
310 <th>&nbsp;&nbsp;&nbsp;<a
311 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
312
313 <!-- Index link -->
314 <th>&nbsp;&nbsp;&nbsp;<a
315 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
316
317 <!-- Help link -->
318 <th>&nbsp;&nbsp;&nbsp;<a
319 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
320
321 <th class="navbar" width="100%"></th>
322 </tr>
323</table>
324<table border="0" cellpadding="0" cellspacing="0" width="100%%">
325 <tr>
326 <td align="left" class="footer">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400327 Generated by Epydoc 3.0.1 on Thu Sep 6 13:36:13 2012
Joe Gregorioebd0b842012-06-15 14:14:17 -0400328 </td>
329 <td align="right" class="footer">
330 <a target="mainFrame" href="http://epydoc.sourceforge.net"
331 >http://epydoc.sourceforge.net</a>
332 </td>
333 </tr>
334</table>
335
336<script type="text/javascript">
337 <!--
338 // Private objects are initially displayed (because if
339 // javascript is turned off then we want them to be
340 // visible); but by default, we want to hide them. So hide
341 // them unless we have a cookie that says to show them.
342 checkCookie();
343 // -->
344</script>
345</body>
346</html>