blob: 1eadc9b49658b4ef98283a14484c1f01ff7d4e19 [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">
59<area shape="rect" href="apiclient.model.BaseModel-class.html" title="BaseModel" alt="" coords="8,61,93,88"/>
60<area shape="rect" href="apiclient.model.JsonModel-class.html" title="JsonModel" alt="" coords="9,117,92,144"/>
61<area shape="rect" href="apiclient.model.MediaModel-class.html" title="MediaModel" alt="" coords="5,173,96,200"/>
62<area shape="rect" href="apiclient.model.Model-class.html" title="Model" alt="" coords="23,5,79,32"/>
63</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>
113 <tr>
114 <td colspan="2" class="summary">
115 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.model.JsonModel-class.html">JsonModel</a></code></b>:
116 <code><a href="apiclient.model.JsonModel-class.html#__init__">__init__</a></code>,
117 <code><a href="apiclient.model.JsonModel-class.html#serialize">serialize</a></code>
118 </p>
119 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.model.BaseModel-class.html">BaseModel</a></code></b>:
120 <code><a href="apiclient.model.BaseModel-class.html#request">request</a></code>,
121 <code><a href="apiclient.model.BaseModel-class.html#response">response</a></code>
122 </p>
123 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.model.BaseModel-class.html">BaseModel</a></code></b> (private):
124 <code><a href="apiclient.model.BaseModel-class.html#_build_query" onclick="show_private();">_build_query</a></code>,
125 <code><a href="apiclient.model.BaseModel-class.html#_log_request" onclick="show_private();">_log_request</a></code>,
126 <code><a href="apiclient.model.BaseModel-class.html#_log_response" onclick="show_private();">_log_response</a></code>
127 </p></div>
128 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
129 <code>__delattr__</code>,
130 <code>__format__</code>,
131 <code>__getattribute__</code>,
132 <code>__hash__</code>,
133 <code>__new__</code>,
134 <code>__reduce__</code>,
135 <code>__reduce_ex__</code>,
136 <code>__repr__</code>,
137 <code>__setattr__</code>,
138 <code>__sizeof__</code>,
139 <code>__str__</code>,
140 <code>__subclasshook__</code>
141 </p>
142 </td>
143 </tr>
144</table>
145<!-- ==================== CLASS VARIABLES ==================== -->
146<a name="section-ClassVariables"></a>
147<table class="summary" border="1" cellpadding="3"
148 cellspacing="0" width="100%" bgcolor="white">
149<tr bgcolor="#70b0f0" class="table-header">
150 <td colspan="2" class="table-header">
151 <table border="0" cellpadding="0" cellspacing="0" width="100%">
152 <tr valign="top">
153 <td align="left"><span class="table-header">Class Variables</span></td>
154 <td align="right" valign="top"
155 ><span class="options">[<a href="#section-ClassVariables"
156 class="privatelink" onclick="toggle_private();"
157 >hide private</a>]</span></td>
158 </tr>
159 </table>
160 </td>
161</tr>
162<tr>
163 <td width="15%" align="right" valign="top" class="summary">
164 <span class="summary-type">&nbsp;</span>
165 </td><td class="summary">
166 <a name="accept"></a><span class="summary-name">accept</span> = <code title="'*/*'"><code class="variable-quote">'</code><code class="variable-string">*/*</code><code class="variable-quote">'</code></code>
167 </td>
168 </tr>
169<tr>
170 <td width="15%" align="right" valign="top" class="summary">
171 <span class="summary-type">&nbsp;</span>
172 </td><td class="summary">
173 <a name="content_type"></a><span class="summary-name">content_type</span> = <code title="'application/json'">'application/json'</code>
174 </td>
175 </tr>
176<tr>
177 <td width="15%" align="right" valign="top" class="summary">
178 <span class="summary-type">&nbsp;</span>
179 </td><td class="summary">
180 <a name="alt_param"></a><span class="summary-name">alt_param</span> = <code title="'media'"><code class="variable-quote">'</code><code class="variable-string">media</code><code class="variable-quote">'</code></code>
181 </td>
182 </tr>
183</table>
184<!-- ==================== PROPERTIES ==================== -->
185<a name="section-Properties"></a>
186<table class="summary" border="1" cellpadding="3"
187 cellspacing="0" width="100%" bgcolor="white">
188<tr bgcolor="#70b0f0" class="table-header">
189 <td colspan="2" class="table-header">
190 <table border="0" cellpadding="0" cellspacing="0" width="100%">
191 <tr valign="top">
192 <td align="left"><span class="table-header">Properties</span></td>
193 <td align="right" valign="top"
194 ><span class="options">[<a href="#section-Properties"
195 class="privatelink" onclick="toggle_private();"
196 >hide private</a>]</span></td>
197 </tr>
198 </table>
199 </td>
200</tr>
201<tr>
202 <td width="15%" align="right" valign="top" class="summary">
203 <span class="summary-type">&nbsp;</span>
204 </td><td class="summary">
205 <a href="apiclient.model.MediaModel-class.html#no_content_response" class="summary-name">no_content_response</a>
206 </td>
207 </tr>
208 <tr>
209 <td colspan="2" class="summary">
210 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
211 <code>__class__</code>
212 </p>
213 </td>
214 </tr>
215</table>
216<!-- ==================== METHOD DETAILS ==================== -->
217<a name="section-MethodDetails"></a>
218<table class="details" border="1" cellpadding="3"
219 cellspacing="0" width="100%" bgcolor="white">
220<tr bgcolor="#70b0f0" class="table-header">
221 <td colspan="2" class="table-header">
222 <table border="0" cellpadding="0" cellspacing="0" width="100%">
223 <tr valign="top">
224 <td align="left"><span class="table-header">Method Details</span></td>
225 <td align="right" valign="top"
226 ><span class="options">[<a href="#section-MethodDetails"
227 class="privatelink" onclick="toggle_private();"
228 >hide private</a>]</span></td>
229 </tr>
230 </table>
231 </td>
232</tr>
233</table>
234<a name="deserialize"></a>
235<div>
236<table class="details" border="1" cellpadding="3"
237 cellspacing="0" width="100%" bgcolor="white">
238<tr><td>
239 <table width="100%" cellpadding="0" cellspacing="0" border="0">
240 <tr valign="top"><td>
241 <h3 class="epydoc"><span class="sig"><span class="sig-name">deserialize</span>(<span class="sig-arg">self</span>,
242 <span class="sig-arg">content</span>)</span>
243 </h3>
244 </td><td align="right" valign="top"
245 ><span class="codelink"><a href="apiclient.model-pysrc.html#MediaModel.deserialize">source&nbsp;code</a></span>&nbsp;
246 </td>
247 </tr></table>
248
249 <pre class="literalblock">
250Perform the actual deserialization from response string to Python
251object.
252
253Args:
254 content: string, the body of the HTTP response
255
256Returns:
257 The body de-serialized as a Python object.
258
259</pre>
260 <dl class="fields">
261 <dt>Overrides:
262 <a href="apiclient.model.BaseModel-class.html#deserialize">BaseModel.deserialize</a>
263 <dd><em class="note">(inherited documentation)</em></dd>
264 </dt>
265 </dl>
266</td></tr></table>
267</div>
268<br />
269<!-- ==================== PROPERTY DETAILS ==================== -->
270<a name="section-PropertyDetails"></a>
271<table class="details" border="1" cellpadding="3"
272 cellspacing="0" width="100%" bgcolor="white">
273<tr bgcolor="#70b0f0" class="table-header">
274 <td colspan="2" class="table-header">
275 <table border="0" cellpadding="0" cellspacing="0" width="100%">
276 <tr valign="top">
277 <td align="left"><span class="table-header">Property Details</span></td>
278 <td align="right" valign="top"
279 ><span class="options">[<a href="#section-PropertyDetails"
280 class="privatelink" onclick="toggle_private();"
281 >hide private</a>]</span></td>
282 </tr>
283 </table>
284 </td>
285</tr>
286</table>
287<a name="no_content_response"></a>
288<div>
289<table class="details" border="1" cellpadding="3"
290 cellspacing="0" width="100%" bgcolor="white">
291<tr><td>
292 <h3 class="epydoc">no_content_response</h3>
293
294 <dl class="fields">
295 <dt>Get Method:</dt>
296 <dd class="value"><span class="summary-sig"><i>unreachable</i>.no_content_response(<span class="summary-sig-arg">self</span>)</span>
297 </dd>
298 </dl>
299</td></tr></table>
300</div>
301<br />
302<!-- ==================== NAVIGATION BAR ==================== -->
303<table class="navbar" border="0" width="100%" cellpadding="0"
304 bgcolor="#a0c0ff" cellspacing="0">
305 <tr valign="middle">
306
307 <!-- Tree link -->
308 <th>&nbsp;&nbsp;&nbsp;<a
309 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
310
311 <!-- Index link -->
312 <th>&nbsp;&nbsp;&nbsp;<a
313 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
314
315 <!-- Help link -->
316 <th>&nbsp;&nbsp;&nbsp;<a
317 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
318
319 <th class="navbar" width="100%"></th>
320 </tr>
321</table>
322<table border="0" cellpadding="0" cellspacing="0" width="100%%">
323 <tr>
324 <td align="left" class="footer">
325 Generated by Epydoc 3.0.1 on Fri Jun 15 13:13:24 2012
326 </td>
327 <td align="right" class="footer">
328 <a target="mainFrame" href="http://epydoc.sourceforge.net"
329 >http://epydoc.sourceforge.net</a>
330 </td>
331 </tr>
332</table>
333
334<script type="text/javascript">
335 <!--
336 // Private objects are initially displayed (because if
337 // javascript is turned off then we want them to be
338 // visible); but by default, we want to hide them. So hide
339 // them unless we have a cookie that says to show them.
340 checkCookie();
341 // -->
342</script>
343</body>
344</html>