Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 15744b1488c8e3a52899531aa0d04b93d572f683 / . / docs / epy / googleapiclient.discovery-module.html
blob: b81fb31b360127a6251bf25b15d28242c8cd2a6f [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<?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.discovery</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 Module&nbsp;discovery
42 </span>
43 </td>
44 <td>
45 <table cellpadding="0" cellspacing="0">
46 <!-- hide/show private -->
47 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
48 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
49 <tr><td align="right"><span class="options"
50 >[<a href="frames.html" target="_top">frames</a
51 >]&nbsp;|&nbsp;<a href="googleapiclient.discovery-module.html"
52 target="_top">no&nbsp;frames</a>]</span></td></tr>
53 </table>
54 </td>
55 </tr>
56</table>
57<!-- ==================== MODULE DESCRIPTION ==================== -->
58<h1 class="epydoc">Module discovery</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.discovery-pysrc.html">source&nbsp;code</a></span></p>
59<pre class="literalblock">
60Client for discovery based APIs.
61
62A client library for Google's discovery based APIs.
63
64</pre>
65
66<hr />
67<div class="fields"> <p><strong>Author:</strong>
68 jcgregorio@google.com (Joe Gregorio)
69 </p>
70</div><!-- ==================== CLASSES ==================== -->
71<a name="section-Classes"></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">Classes</span></td>
79 <td align="right" valign="top"
80 ><span class="options">[<a href="#section-Classes"
81 class="privatelink" onclick="toggle_private();"
82 >hide private</a>]</span></td>
83 </tr>
84 </table>
85 </td>
86</tr>
87<tr class="private">
88 <td width="15%" align="right" valign="top" class="summary">
89 <span class="summary-type">&nbsp;</span>
90 </td><td class="summary">
91 <a href="googleapiclient.discovery.ResourceMethodParameters-class.html" class="summary-name" onclick="show_private();">ResourceMethodParameters</a><br />
92 Represents the parameters associated with a method.
93 </td>
94 </tr>
95<tr class="private">
96 <td width="15%" align="right" valign="top" class="summary">
97 <span class="summary-type">&nbsp;</span>
98 </td><td class="summary">
99 <a href="googleapiclient.discovery.Resource-class.html" class="summary-name" onclick="show_private();">Resource</a><br />
100 A class for interacting with a resource.
101 </td>
102 </tr>
103</table>
104<!-- ==================== FUNCTIONS ==================== -->
105<a name="section-Functions"></a>
106<table class="summary" border="1" cellpadding="3"
107 cellspacing="0" width="100%" bgcolor="white">
108<tr bgcolor="#70b0f0" class="table-header">
109 <td colspan="2" class="table-header">
110 <table border="0" cellpadding="0" cellspacing="0" width="100%">
111 <tr valign="top">
112 <td align="left"><span class="table-header">Functions</span></td>
113 <td align="right" valign="top"
114 ><span class="options">[<a href="#section-Functions"
115 class="privatelink" onclick="toggle_private();"
116 >hide private</a>]</span></td>
117 </tr>
118 </table>
119 </td>
120</tr>
121<tr>
122 <td width="15%" align="right" valign="top" class="summary">
123 <span class="summary-type">&nbsp;</span>
124 </td><td class="summary">
125 <table width="100%" cellpadding="0" cellspacing="0" border="0">
126 <tr>
127 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#fix_method_name" class="summary-sig-name">fix_method_name</a>(<span class="summary-sig-arg">name</span>)</span><br />
128 Fix method names to avoid reserved word conflicts.</td>
129 <td align="right" valign="top">
130 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#fix_method_name">source&nbsp;code</a></span>
131
132 </td>
133 </tr>
134 </table>
135
136 </td>
137 </tr>
138<tr>
139 <td width="15%" align="right" valign="top" class="summary">
140 <span class="summary-type">&nbsp;</span>
141 </td><td class="summary">
142 <table width="100%" cellpadding="0" cellspacing="0" border="0">
143 <tr>
144 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#key2param" class="summary-sig-name">key2param</a>(<span class="summary-sig-arg">key</span>)</span><br />
145 Converts key names into parameter names.</td>
146 <td align="right" valign="top">
147 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#key2param">source&nbsp;code</a></span>
148
149 </td>
150 </tr>
151 </table>
152
153 </td>
154 </tr>
155<tr>
156 <td width="15%" align="right" valign="top" class="summary">
157 <span class="summary-type">&nbsp;</span>
158 </td><td class="summary">
159 <table width="100%" cellpadding="0" cellspacing="0" border="0">
160 <tr>
161 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#build" class="summary-sig-name">build</a>(<span class="summary-sig-arg">serviceName</span>,
162 <span class="summary-sig-arg">version</span>,
163 <span class="summary-sig-arg">http</span>=<span class="summary-sig-default">None</span>,
164 <span class="summary-sig-arg">discoveryServiceUrl</span>=<span class="summary-sig-default">DISCOVERY_URI</span>,
165 <span class="summary-sig-arg">developerKey</span>=<span class="summary-sig-default">None</span>,
166 <span class="summary-sig-arg">model</span>=<span class="summary-sig-default">None</span>,
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]167 <span class="summary-sig-arg">requestBuilder</span>=<span class="summary-sig-default">HttpRequest</span>,
168 <span class="summary-sig-arg">credentials</span>=<span class="summary-sig-default">None</span>)</span><br />
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]169 Construct a Resource for interacting with an API.</td>
170 <td align="right" valign="top">
171 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#build">source&nbsp;code</a></span>
172
173 </td>
174 </tr>
175 </table>
176
177 </td>
178 </tr>
179<tr>
180 <td width="15%" align="right" valign="top" class="summary">
181 <span class="summary-type">&nbsp;</span>
182 </td><td class="summary">
183 <table width="100%" cellpadding="0" cellspacing="0" border="0">
184 <tr>
185 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#build_from_document" class="summary-sig-name">build_from_document</a>(<span class="summary-sig-arg">service</span>,
186 <span class="summary-sig-arg">base</span>=<span class="summary-sig-default">None</span>,
187 <span class="summary-sig-arg">future</span>=<span class="summary-sig-default">None</span>,
188 <span class="summary-sig-arg">http</span>=<span class="summary-sig-default">None</span>,
189 <span class="summary-sig-arg">developerKey</span>=<span class="summary-sig-default">None</span>,
190 <span class="summary-sig-arg">model</span>=<span class="summary-sig-default">None</span>,
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]191 <span class="summary-sig-arg">requestBuilder</span>=<span class="summary-sig-default">HttpRequest</span>,
192 <span class="summary-sig-arg">credentials</span>=<span class="summary-sig-default">None</span>)</span><br />
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]193 Create a Resource for interacting with an API.</td>
194 <td align="right" valign="top">
195 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#build_from_document">source&nbsp;code</a></span>
196
197 </td>
198 </tr>
199 </table>
200
201 </td>
202 </tr>
203<tr class="private">
204 <td width="15%" align="right" valign="top" class="summary">
205 <span class="summary-type">&nbsp;</span>
206 </td><td class="summary">
207 <table width="100%" cellpadding="0" cellspacing="0" border="0">
208 <tr>
209 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#_cast" class="summary-sig-name" onclick="show_private();">_cast</a>(<span class="summary-sig-arg">value</span>,
210 <span class="summary-sig-arg">schema_type</span>)</span><br />
211 Convert value to a string based on JSON Schema type.</td>
212 <td align="right" valign="top">
213 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_cast">source&nbsp;code</a></span>
214
215 </td>
216 </tr>
217 </table>
218
219 </td>
220 </tr>
221<tr class="private">
222 <td width="15%" align="right" valign="top" class="summary">
223 <span class="summary-type">&nbsp;</span>
224 </td><td class="summary">
225 <table width="100%" cellpadding="0" cellspacing="0" border="0">
226 <tr>
227 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#_media_size_to_long" class="summary-sig-name" onclick="show_private();">_media_size_to_long</a>(<span class="summary-sig-arg">maxSize</span>)</span><br />
228 Convert a string media size, such as 10GB or 3TB into an integer.</td>
229 <td align="right" valign="top">
230 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_media_size_to_long">source&nbsp;code</a></span>
231
232 </td>
233 </tr>
234 </table>
235
236 </td>
237 </tr>
238<tr class="private">
239 <td width="15%" align="right" valign="top" class="summary">
240 <span class="summary-type">&nbsp;</span>
241 </td><td class="summary">
242 <table width="100%" cellpadding="0" cellspacing="0" border="0">
243 <tr>
244 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#_media_path_url_from_info" class="summary-sig-name" onclick="show_private();">_media_path_url_from_info</a>(<span class="summary-sig-arg">root_desc</span>,
245 <span class="summary-sig-arg">path_url</span>)</span><br />
246 Creates an absolute media path URL.</td>
247 <td align="right" valign="top">
248 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_media_path_url_from_info">source&nbsp;code</a></span>
249
250 </td>
251 </tr>
252 </table>
253
254 </td>
255 </tr>
256<tr class="private">
257 <td width="15%" align="right" valign="top" class="summary">
258 <span class="summary-type">&nbsp;</span>
259 </td><td class="summary">
260 <table width="100%" cellpadding="0" cellspacing="0" border="0">
261 <tr>
262 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#_fix_up_parameters" class="summary-sig-name" onclick="show_private();">_fix_up_parameters</a>(<span class="summary-sig-arg">method_desc</span>,
263 <span class="summary-sig-arg">root_desc</span>,
264 <span class="summary-sig-arg">http_method</span>)</span><br />
265 Updates parameters of an API method with values specific to this library.</td>
266 <td align="right" valign="top">
267 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_fix_up_parameters">source&nbsp;code</a></span>
268
269 </td>
270 </tr>
271 </table>
272
273 </td>
274 </tr>
275<tr class="private">
276 <td width="15%" align="right" valign="top" class="summary">
277 <span class="summary-type">&nbsp;</span>
278 </td><td class="summary">
279 <table width="100%" cellpadding="0" cellspacing="0" border="0">
280 <tr>
281 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#_fix_up_media_upload" class="summary-sig-name" onclick="show_private();">_fix_up_media_upload</a>(<span class="summary-sig-arg">method_desc</span>,
282 <span class="summary-sig-arg">root_desc</span>,
283 <span class="summary-sig-arg">path_url</span>,
284 <span class="summary-sig-arg">parameters</span>)</span><br />
285 Updates parameters of API by adding 'media_body' if supported by method.</td>
286 <td align="right" valign="top">
287 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_fix_up_media_upload">source&nbsp;code</a></span>
288
289 </td>
290 </tr>
291 </table>
292
293 </td>
294 </tr>
295<tr class="private">
296 <td width="15%" align="right" valign="top" class="summary">
297 <span class="summary-type">&nbsp;</span>
298 </td><td class="summary">
299 <table width="100%" cellpadding="0" cellspacing="0" border="0">
300 <tr>
301 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#_fix_up_method_description" class="summary-sig-name" onclick="show_private();">_fix_up_method_description</a>(<span class="summary-sig-arg">method_desc</span>,
302 <span class="summary-sig-arg">root_desc</span>)</span><br />
303 Updates a method description in a discovery document.</td>
304 <td align="right" valign="top">
305 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_fix_up_method_description">source&nbsp;code</a></span>
306
307 </td>
308 </tr>
309 </table>
310
311 </td>
312 </tr>
313<tr class="private">
314 <td width="15%" align="right" valign="top" class="summary">
315 <span class="summary-type">&nbsp;</span>
316 </td><td class="summary">
317 <table width="100%" cellpadding="0" cellspacing="0" border="0">
318 <tr>
319 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#createMethod" class="summary-sig-name" onclick="show_private();">createMethod</a>(<span class="summary-sig-arg">methodName</span>,
320 <span class="summary-sig-arg">methodDesc</span>,
321 <span class="summary-sig-arg">rootDesc</span>,
322 <span class="summary-sig-arg">schema</span>)</span><br />
323 Creates a method for attaching to a Resource.</td>
324 <td align="right" valign="top">
325 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#createMethod">source&nbsp;code</a></span>
326
327 </td>
328 </tr>
329 </table>
330
331 </td>
332 </tr>
333<tr class="private">
334 <td width="15%" align="right" valign="top" class="summary">
335 <span class="summary-type">&nbsp;</span>
336 </td><td class="summary">
337 <table width="100%" cellpadding="0" cellspacing="0" border="0">
338 <tr>
339 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#createNextMethod" class="summary-sig-name" onclick="show_private();">createNextMethod</a>(<span class="summary-sig-arg">methodName</span>)</span><br />
340 Creates any _next methods for attaching to a Resource.</td>
341 <td align="right" valign="top">
342 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#createNextMethod">source&nbsp;code</a></span>
343
344 </td>
345 </tr>
346 </table>
347
348 </td>
349 </tr>
350</table>
351<!-- ==================== VARIABLES ==================== -->
352<a name="section-Variables"></a>
353<table class="summary" border="1" cellpadding="3"
354 cellspacing="0" width="100%" bgcolor="white">
355<tr bgcolor="#70b0f0" class="table-header">
356 <td colspan="2" class="table-header">
357 <table border="0" cellpadding="0" cellspacing="0" width="100%">
358 <tr valign="top">
359 <td align="left"><span class="table-header">Variables</span></td>
360 <td align="right" valign="top"
361 ><span class="options">[<a href="#section-Variables"
362 class="privatelink" onclick="toggle_private();"
363 >hide private</a>]</span></td>
364 </tr>
365 </table>
366 </td>
367</tr>
368<tr class="private">
369 <td width="15%" align="right" valign="top" class="summary">
370 <span class="summary-type">&nbsp;</span>
371 </td><td class="summary">
372 <a name="logger"></a><span class="summary-name">logger</span> = <code title="logging.getLogger(__name__)">logging.getLogger(__name__)</code>
373 </td>
374 </tr>
375<tr class="private">
376 <td width="15%" align="right" valign="top" class="summary">
377 <span class="summary-type">&nbsp;</span>
378 </td><td class="summary">
379 <a name="URITEMPLATE"></a><span class="summary-name">URITEMPLATE</span> = <code title="re.compile('{[^}]*}')">re.compile('{[^}]*}')</code>
380 </td>
381 </tr>
382<tr class="private">
383 <td width="15%" align="right" valign="top" class="summary">
384 <span class="summary-type">&nbsp;</span>
385 </td><td class="summary">
386 <a name="VARNAME"></a><span class="summary-name">VARNAME</span> = <code title="re.compile('[a-zA-Z0-9_-]+')">re.compile('[a-zA-Z0-9_-]+')</code>
387 </td>
388 </tr>
389<tr class="private">
390 <td width="15%" align="right" valign="top" class="summary">
391 <span class="summary-type">&nbsp;</span>
392 </td><td class="summary">
393 <a href="googleapiclient.discovery-module.html#DISCOVERY_URI" class="summary-name" onclick="show_private();">DISCOVERY_URI</a> = <code title="'https://www.googleapis.com/discovery/v1/apis/' '{api}/{apiVersion}/re\
394st'">'https://www.googleapis.com/discovery/v1/apis/<code class="variable-ellipsis">...</code></code>
395 </td>
396 </tr>
397<tr class="private">
398 <td width="15%" align="right" valign="top" class="summary">
399 <span class="summary-type">&nbsp;</span>
400 </td><td class="summary">
401 <a name="DEFAULT_METHOD_DOC"></a><span class="summary-name">DEFAULT_METHOD_DOC</span> = <code title="'A description of how to use this function'">'A description of how to use this function'</code>
402 </td>
403 </tr>
404<tr class="private">
405 <td width="15%" align="right" valign="top" class="summary">
406 <span class="summary-type">&nbsp;</span>
407 </td><td class="summary">
408 <a name="HTTP_PAYLOAD_METHODS"></a><span class="summary-name">HTTP_PAYLOAD_METHODS</span> = <code title="frozenset(['PUT', 'POST', 'PATCH'])">frozenset(['PUT', 'POST', 'PATCH'])</code>
409 </td>
410 </tr>
411<tr class="private">
412 <td width="15%" align="right" valign="top" class="summary">
413 <span class="summary-type">&nbsp;</span>
414 </td><td class="summary">
415 <a name="_MEDIA_SIZE_BIT_SHIFTS"></a><span class="summary-name">_MEDIA_SIZE_BIT_SHIFTS</span> = <code title="{'KB': 10, 'MB': 20, 'GB': 30, 'TB': 40}">{'KB': 10, 'MB': 20, 'GB': 30, 'TB': 40}</code>
416 </td>
417 </tr>
418<tr class="private">
419 <td width="15%" align="right" valign="top" class="summary">
420 <span class="summary-type">&nbsp;</span>
421 </td><td class="summary">
422 <a href="googleapiclient.discovery-module.html#BODY_PARAMETER_DEFAULT_VALUE" class="summary-name" onclick="show_private();">BODY_PARAMETER_DEFAULT_VALUE</a> = <code title="{'description': 'The request body.', 'type': 'object', 'required': Tru\
423e,}">{'description': 'The request bo<code class="variable-ellipsis">...</code></code>
424 </td>
425 </tr>
426<tr class="private">
427 <td width="15%" align="right" valign="top" class="summary">
428 <span class="summary-type">&nbsp;</span>
429 </td><td class="summary">
430 <a href="googleapiclient.discovery-module.html#MEDIA_BODY_PARAMETER_DEFAULT_VALUE" class="summary-name" onclick="show_private();">MEDIA_BODY_PARAMETER_DEFAULT_VALUE</a> = <code title="{'description':('The filename of the media request body, or an instanc\
431e ' 'of a MediaUpload object.'), 'type': 'string', 'required': False,}">{'description':('The file<code class="variable-ellipsis">...</code></code>
432 </td>
433 </tr>
434<tr class="private">
435 <td width="15%" align="right" valign="top" class="summary">
436 <span class="summary-type">&nbsp;</span>
437 </td><td class="summary">
438 <a href="googleapiclient.discovery-module.html#STACK_QUERY_PARAMETERS" class="summary-name" onclick="show_private();">STACK_QUERY_PARAMETERS</a> = <code title="frozenset(['trace', 'pp', 'userip', 'strict'])">frozenset(['trace', 'pp', 'userip', '<code class="variable-ellipsis">...</code></code>
439 </td>
440 </tr>
441<tr class="private">
442 <td width="15%" align="right" valign="top" class="summary">
443 <span class="summary-type">&nbsp;</span>
444 </td><td class="summary">
445 <a href="googleapiclient.discovery-module.html#STACK_QUERY_PARAMETER_DEFAULT_VALUE" class="summary-name" onclick="show_private();">STACK_QUERY_PARAMETER_DEFAULT_VALUE</a> = <code title="{'type': 'string', 'location': 'query'}">{'type': 'string', 'loca<code class="variable-ellipsis">...</code></code>
446 </td>
447 </tr>
448<tr class="private">
449 <td width="15%" align="right" valign="top" class="summary">
450 <span class="summary-type">&nbsp;</span>
451 </td><td class="summary">
452 <a name="RESERVED_WORDS"></a><span class="summary-name">RESERVED_WORDS</span> = <code title="frozenset(['body'])">frozenset(['body'])</code>
453 </td>
454 </tr>
455</table>
456<!-- ==================== FUNCTION DETAILS ==================== -->
457<a name="section-FunctionDetails"></a>
458<table class="details" border="1" cellpadding="3"
459 cellspacing="0" width="100%" bgcolor="white">
460<tr bgcolor="#70b0f0" class="table-header">
461 <td colspan="2" class="table-header">
462 <table border="0" cellpadding="0" cellspacing="0" width="100%">
463 <tr valign="top">
464 <td align="left"><span class="table-header">Function Details</span></td>
465 <td align="right" valign="top"
466 ><span class="options">[<a href="#section-FunctionDetails"
467 class="privatelink" onclick="toggle_private();"
468 >hide private</a>]</span></td>
469 </tr>
470 </table>
471 </td>
472</tr>
473</table>
474<a name="fix_method_name"></a>
475<div>
476<table class="details" border="1" cellpadding="3"
477 cellspacing="0" width="100%" bgcolor="white">
478<tr><td>
479 <table width="100%" cellpadding="0" cellspacing="0" border="0">
480 <tr valign="top"><td>
481 <h3 class="epydoc"><span class="sig"><span class="sig-name">fix_method_name</span>(<span class="sig-arg">name</span>)</span>
482 </h3>
483 </td><td align="right" valign="top"
484 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#fix_method_name">source&nbsp;code</a></span>&nbsp;
485 </td>
486 </tr></table>
487
488 <pre class="literalblock">
489Fix method names to avoid reserved word conflicts.
490
491Args:
492 name: string, method name.
493
494Returns:
495 The name with a '_' prefixed if the name is a reserved word.
496
497</pre>
498 <dl class="fields">
499 </dl>
500</td></tr></table>
501</div>
502<a name="key2param"></a>
503<div>
504<table class="details" border="1" cellpadding="3"
505 cellspacing="0" width="100%" bgcolor="white">
506<tr><td>
507 <table width="100%" cellpadding="0" cellspacing="0" border="0">
508 <tr valign="top"><td>
509 <h3 class="epydoc"><span class="sig"><span class="sig-name">key2param</span>(<span class="sig-arg">key</span>)</span>
510 </h3>
511 </td><td align="right" valign="top"
512 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#key2param">source&nbsp;code</a></span>&nbsp;
513 </td>
514 </tr></table>
515
516 <pre class="literalblock">
517Converts key names into parameter names.
518
519For example, converting &quot;max-results&quot; -&gt; &quot;max_results&quot;
520
521Args:
522 key: string, the method key name.
523
524Returns:
525 A safe method name based on the key name.
526
527</pre>
528 <dl class="fields">
529 </dl>
530</td></tr></table>
531</div>
532<a name="build"></a>
533<div>
534<table class="details" border="1" cellpadding="3"
535 cellspacing="0" width="100%" bgcolor="white">
536<tr><td>
537 <table width="100%" cellpadding="0" cellspacing="0" border="0">
538 <tr valign="top"><td>
539 <h3 class="epydoc"><span class="sig"><span class="sig-name">build</span>(<span class="sig-arg">serviceName</span>,
540 <span class="sig-arg">version</span>,
541 <span class="sig-arg">http</span>=<span class="sig-default">None</span>,
542 <span class="sig-arg">discoveryServiceUrl</span>=<span class="sig-default">DISCOVERY_URI</span>,
543 <span class="sig-arg">developerKey</span>=<span class="sig-default">None</span>,
544 <span class="sig-arg">model</span>=<span class="sig-default">None</span>,
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]545 <span class="sig-arg">requestBuilder</span>=<span class="sig-default">HttpRequest</span>,
546 <span class="sig-arg">credentials</span>=<span class="sig-default">None</span>)</span>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]547 </h3>
548 </td><td align="right" valign="top"
549 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#build">source&nbsp;code</a></span>&nbsp;
550 </td>
551 </tr></table>
552
553 <pre class="literalblock">
554Construct a Resource for interacting with an API.
555
556Construct a Resource object for interacting with an API. The serviceName and
557version are the names from the Discovery service.
558
559Args:
560 serviceName: string, name of the service.
561 version: string, the version of the service.
562 http: httplib2.Http, An instance of httplib2.Http or something that acts
563 like it that HTTP requests will be made through.
564 discoveryServiceUrl: string, a URI Template that points to the location of
565 the discovery service. It should have two parameters {api} and
566 {apiVersion} that when filled in produce an absolute URI to the discovery
567 document for that service.
568 developerKey: string, key obtained from
569 https://code.google.com/apis/console.
570 model: googleapiclient.Model, converts to and from the wire format.
571 requestBuilder: googleapiclient.http.HttpRequest, encapsulator for an HTTP
572 request.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]573 credentials: oauth2client.Credentials, credentials to be used for
574 authentication.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]575
576Returns:
577 A Resource object with methods for interacting with the service.
578
579</pre>
580 <dl class="fields">
581 <dt>Decorators:</dt>
582 <dd><ul class="nomargin-top">
583 <li><code>@positional(2)</code></li>
584 </ul></dd>
585 </dl>
586</td></tr></table>
587</div>
588<a name="build_from_document"></a>
589<div>
590<table class="details" border="1" cellpadding="3"
591 cellspacing="0" width="100%" bgcolor="white">
592<tr><td>
593 <table width="100%" cellpadding="0" cellspacing="0" border="0">
594 <tr valign="top"><td>
595 <h3 class="epydoc"><span class="sig"><span class="sig-name">build_from_document</span>(<span class="sig-arg">service</span>,
596 <span class="sig-arg">base</span>=<span class="sig-default">None</span>,
597 <span class="sig-arg">future</span>=<span class="sig-default">None</span>,
598 <span class="sig-arg">http</span>=<span class="sig-default">None</span>,
599 <span class="sig-arg">developerKey</span>=<span class="sig-default">None</span>,
600 <span class="sig-arg">model</span>=<span class="sig-default">None</span>,
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]601 <span class="sig-arg">requestBuilder</span>=<span class="sig-default">HttpRequest</span>,
602 <span class="sig-arg">credentials</span>=<span class="sig-default">None</span>)</span>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]603 </h3>
604 </td><td align="right" valign="top"
605 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#build_from_document">source&nbsp;code</a></span>&nbsp;
606 </td>
607 </tr></table>
608
609 <pre class="literalblock">
610Create a Resource for interacting with an API.
611
612Same as `build()`, but constructs the Resource object from a discovery
613document that is it given, as opposed to retrieving one over HTTP.
614
615Args:
616 service: string or object, the JSON discovery document describing the API.
617 The value passed in may either be the JSON string or the deserialized
618 JSON.
619 base: string, base URI for all HTTP requests, usually the discovery URI.
620 This parameter is no longer used as rootUrl and servicePath are included
621 within the discovery document. (deprecated)
622 future: string, discovery document with future capabilities (deprecated).
623 http: httplib2.Http, An instance of httplib2.Http or something that acts
624 like it that HTTP requests will be made through.
625 developerKey: string, Key for controlling API usage, generated
626 from the API Console.
627 model: Model class instance that serializes and de-serializes requests and
628 responses.
629 requestBuilder: Takes an http request and packages it up to be executed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]630 credentials: object, credentials to be used for authentication.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]631
632Returns:
633 A Resource object with methods for interacting with the service.
634
635</pre>
636 <dl class="fields">
637 <dt>Decorators:</dt>
638 <dd><ul class="nomargin-top">
639 <li><code>@positional(1)</code></li>
640 </ul></dd>
641 </dl>
642</td></tr></table>
643</div>
644<a name="_cast"></a>
645<div class="private">
646<table class="details" border="1" cellpadding="3"
647 cellspacing="0" width="100%" bgcolor="white">
648<tr><td>
649 <table width="100%" cellpadding="0" cellspacing="0" border="0">
650 <tr valign="top"><td>
651 <h3 class="epydoc"><span class="sig"><span class="sig-name">_cast</span>(<span class="sig-arg">value</span>,
652 <span class="sig-arg">schema_type</span>)</span>
653 </h3>
654 </td><td align="right" valign="top"
655 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_cast">source&nbsp;code</a></span>&nbsp;
656 </td>
657 </tr></table>
658
659 <pre class="literalblock">
660Convert value to a string based on JSON Schema type.
661
662See http://tools.ietf.org/html/draft-zyp-json-schema-03 for more details on
663JSON Schema.
664
665Args:
666 value: any, the value to convert
667 schema_type: string, the type that value should be interpreted as
668
669Returns:
670 A string representation of 'value' based on the schema_type.
671
672</pre>
673 <dl class="fields">
674 </dl>
675</td></tr></table>
676</div>
677<a name="_media_size_to_long"></a>
678<div class="private">
679<table class="details" border="1" cellpadding="3"
680 cellspacing="0" width="100%" bgcolor="white">
681<tr><td>
682 <table width="100%" cellpadding="0" cellspacing="0" border="0">
683 <tr valign="top"><td>
684 <h3 class="epydoc"><span class="sig"><span class="sig-name">_media_size_to_long</span>(<span class="sig-arg">maxSize</span>)</span>
685 </h3>
686 </td><td align="right" valign="top"
687 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_media_size_to_long">source&nbsp;code</a></span>&nbsp;
688 </td>
689 </tr></table>
690
691 <pre class="literalblock">
692Convert a string media size, such as 10GB or 3TB into an integer.
693
694Args:
695 maxSize: string, size as a string, such as 2MB or 7GB.
696
697Returns:
698 The size as an integer value.
699
700</pre>
701 <dl class="fields">
702 </dl>
703</td></tr></table>
704</div>
705<a name="_media_path_url_from_info"></a>
706<div class="private">
707<table class="details" border="1" cellpadding="3"
708 cellspacing="0" width="100%" bgcolor="white">
709<tr><td>
710 <table width="100%" cellpadding="0" cellspacing="0" border="0">
711 <tr valign="top"><td>
712 <h3 class="epydoc"><span class="sig"><span class="sig-name">_media_path_url_from_info</span>(<span class="sig-arg">root_desc</span>,
713 <span class="sig-arg">path_url</span>)</span>
714 </h3>
715 </td><td align="right" valign="top"
716 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_media_path_url_from_info">source&nbsp;code</a></span>&nbsp;
717 </td>
718 </tr></table>
719
720 <pre class="literalblock">
721Creates an absolute media path URL.
722
723Constructed using the API root URI and service path from the discovery
724document and the relative path for the API method.
725
726Args:
727 root_desc: Dictionary; the entire original deserialized discovery document.
728 path_url: String; the relative URL for the API method. Relative to the API
729 root, which is specified in the discovery document.
730
731Returns:
732 String; the absolute URI for media upload for the API method.
733
734</pre>
735 <dl class="fields">
736 </dl>
737</td></tr></table>
738</div>
739<a name="_fix_up_parameters"></a>
740<div class="private">
741<table class="details" border="1" cellpadding="3"
742 cellspacing="0" width="100%" bgcolor="white">
743<tr><td>
744 <table width="100%" cellpadding="0" cellspacing="0" border="0">
745 <tr valign="top"><td>
746 <h3 class="epydoc"><span class="sig"><span class="sig-name">_fix_up_parameters</span>(<span class="sig-arg">method_desc</span>,
747 <span class="sig-arg">root_desc</span>,
748 <span class="sig-arg">http_method</span>)</span>
749 </h3>
750 </td><td align="right" valign="top"
751 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_fix_up_parameters">source&nbsp;code</a></span>&nbsp;
752 </td>
753 </tr></table>
754
755 <pre class="literalblock">
756Updates parameters of an API method with values specific to this library.
757
758Specifically, adds whatever global parameters are specified by the API to the
759parameters for the individual method. Also adds parameters which don't
760appear in the discovery document, but are available to all discovery based
761APIs (these are listed in STACK_QUERY_PARAMETERS).
762
763SIDE EFFECTS: This updates the parameters dictionary object in the method
764description.
765
766Args:
767 method_desc: Dictionary with metadata describing an API method. Value comes
768 from the dictionary of methods stored in the 'methods' key in the
769 deserialized discovery document.
770 root_desc: Dictionary; the entire original deserialized discovery document.
771 http_method: String; the HTTP method used to call the API method described
772 in method_desc.
773
774Returns:
775 The updated Dictionary stored in the 'parameters' key of the method
776 description dictionary.
777
778</pre>
779 <dl class="fields">
780 </dl>
781</td></tr></table>
782</div>
783<a name="_fix_up_media_upload"></a>
784<div class="private">
785<table class="details" border="1" cellpadding="3"
786 cellspacing="0" width="100%" bgcolor="white">
787<tr><td>
788 <table width="100%" cellpadding="0" cellspacing="0" border="0">
789 <tr valign="top"><td>
790 <h3 class="epydoc"><span class="sig"><span class="sig-name">_fix_up_media_upload</span>(<span class="sig-arg">method_desc</span>,
791 <span class="sig-arg">root_desc</span>,
792 <span class="sig-arg">path_url</span>,
793 <span class="sig-arg">parameters</span>)</span>
794 </h3>
795 </td><td align="right" valign="top"
796 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_fix_up_media_upload">source&nbsp;code</a></span>&nbsp;
797 </td>
798 </tr></table>
799
800 <pre class="literalblock">
801Updates parameters of API by adding 'media_body' if supported by method.
802
803SIDE EFFECTS: If the method supports media upload and has a required body,
804sets body to be optional (required=False) instead. Also, if there is a
805'mediaUpload' in the method description, adds 'media_upload' key to
806parameters.
807
808Args:
809 method_desc: Dictionary with metadata describing an API method. Value comes
810 from the dictionary of methods stored in the 'methods' key in the
811 deserialized discovery document.
812 root_desc: Dictionary; the entire original deserialized discovery document.
813 path_url: String; the relative URL for the API method. Relative to the API
814 root, which is specified in the discovery document.
815 parameters: A dictionary describing method parameters for method described
816 in method_desc.
817
818Returns:
819 Triple (accept, max_size, media_path_url) where:
820 - accept is a list of strings representing what content types are
821 accepted for media upload. Defaults to empty list if not in the
822 discovery document.
823 - max_size is a long representing the max size in bytes allowed for a
824 media upload. Defaults to 0L if not in the discovery document.
825 - media_path_url is a String; the absolute URI for media upload for the
826 API method. Constructed using the API root URI and service path from
827 the discovery document and the relative path for the API method. If
828 media upload is not supported, this is None.
829
830</pre>
831 <dl class="fields">
832 </dl>
833</td></tr></table>
834</div>
835<a name="_fix_up_method_description"></a>
836<div class="private">
837<table class="details" border="1" cellpadding="3"
838 cellspacing="0" width="100%" bgcolor="white">
839<tr><td>
840 <table width="100%" cellpadding="0" cellspacing="0" border="0">
841 <tr valign="top"><td>
842 <h3 class="epydoc"><span class="sig"><span class="sig-name">_fix_up_method_description</span>(<span class="sig-arg">method_desc</span>,
843 <span class="sig-arg">root_desc</span>)</span>
844 </h3>
845 </td><td align="right" valign="top"
846 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_fix_up_method_description">source&nbsp;code</a></span>&nbsp;
847 </td>
848 </tr></table>
849
850 <pre class="literalblock">
851Updates a method description in a discovery document.
852
853SIDE EFFECTS: Changes the parameters dictionary in the method description with
854extra parameters which are used locally.
855
856Args:
857 method_desc: Dictionary with metadata describing an API method. Value comes
858 from the dictionary of methods stored in the 'methods' key in the
859 deserialized discovery document.
860 root_desc: Dictionary; the entire original deserialized discovery document.
861
862Returns:
863 Tuple (path_url, http_method, method_id, accept, max_size, media_path_url)
864 where:
865 - path_url is a String; the relative URL for the API method. Relative to
866 the API root, which is specified in the discovery document.
867 - http_method is a String; the HTTP method used to call the API method
868 described in the method description.
869 - method_id is a String; the name of the RPC method associated with the
870 API method, and is in the method description in the 'id' key.
871 - accept is a list of strings representing what content types are
872 accepted for media upload. Defaults to empty list if not in the
873 discovery document.
874 - max_size is a long representing the max size in bytes allowed for a
875 media upload. Defaults to 0L if not in the discovery document.
876 - media_path_url is a String; the absolute URI for media upload for the
877 API method. Constructed using the API root URI and service path from
878 the discovery document and the relative path for the API method. If
879 media upload is not supported, this is None.
880
881</pre>
882 <dl class="fields">
883 </dl>
884</td></tr></table>
885</div>
886<a name="createMethod"></a>
887<div class="private">
888<table class="details" border="1" cellpadding="3"
889 cellspacing="0" width="100%" bgcolor="white">
890<tr><td>
891 <table width="100%" cellpadding="0" cellspacing="0" border="0">
892 <tr valign="top"><td>
893 <h3 class="epydoc"><span class="sig"><span class="sig-name">createMethod</span>(<span class="sig-arg">methodName</span>,
894 <span class="sig-arg">methodDesc</span>,
895 <span class="sig-arg">rootDesc</span>,
896 <span class="sig-arg">schema</span>)</span>
897 </h3>
898 </td><td align="right" valign="top"
899 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#createMethod">source&nbsp;code</a></span>&nbsp;
900 </td>
901 </tr></table>
902
903 <pre class="literalblock">
904Creates a method for attaching to a Resource.
905
906Args:
907 methodName: string, name of the method to use.
908 methodDesc: object, fragment of deserialized discovery document that
909 describes the method.
910 rootDesc: object, the entire deserialized discovery document.
911 schema: object, mapping of schema names to schema descriptions.
912
913</pre>
914 <dl class="fields">
915 </dl>
916</td></tr></table>
917</div>
918<a name="createNextMethod"></a>
919<div class="private">
920<table class="details" border="1" cellpadding="3"
921 cellspacing="0" width="100%" bgcolor="white">
922<tr><td>
923 <table width="100%" cellpadding="0" cellspacing="0" border="0">
924 <tr valign="top"><td>
925 <h3 class="epydoc"><span class="sig"><span class="sig-name">createNextMethod</span>(<span class="sig-arg">methodName</span>)</span>
926 </h3>
927 </td><td align="right" valign="top"
928 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#createNextMethod">source&nbsp;code</a></span>&nbsp;
929 </td>
930 </tr></table>
931
932 <pre class="literalblock">
933Creates any _next methods for attaching to a Resource.
934
935The _next methods allow for easy iteration through list() responses.
936
937Args:
938 methodName: string, name of the method to use.
939
940</pre>
941 <dl class="fields">
942 </dl>
943</td></tr></table>
944</div>
945<br />
946<!-- ==================== VARIABLES DETAILS ==================== -->
947<a name="section-VariablesDetails"></a>
948<table class="details" border="1" cellpadding="3"
949 cellspacing="0" width="100%" bgcolor="white">
950<tr bgcolor="#70b0f0" class="table-header">
951 <td colspan="2" class="table-header">
952 <table border="0" cellpadding="0" cellspacing="0" width="100%">
953 <tr valign="top">
954 <td align="left"><span class="table-header">Variables Details</span></td>
955 <td align="right" valign="top"
956 ><span class="options">[<a href="#section-VariablesDetails"
957 class="privatelink" onclick="toggle_private();"
958 >hide private</a>]</span></td>
959 </tr>
960 </table>
961 </td>
962</tr>
963</table>
964<a name="DISCOVERY_URI"></a>
965<div class="private">
966<table class="details" border="1" cellpadding="3"
967 cellspacing="0" width="100%" bgcolor="white">
968<tr><td>
969 <h3 class="epydoc">DISCOVERY_URI</h3>
970
971 <dl class="fields">
972 </dl>
973 <dl class="fields">
974 <dt>Value:</dt>
975 <dd><table><tr><td><pre class="variable">
976'https://www.googleapis.com/discovery/v1/apis/' '{api}/{apiVersion}/re<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
977st'
978</pre></td></tr></table>
979</dd>
980 </dl>
981</td></tr></table>
982</div>
983<a name="BODY_PARAMETER_DEFAULT_VALUE"></a>
984<div class="private">
985<table class="details" border="1" cellpadding="3"
986 cellspacing="0" width="100%" bgcolor="white">
987<tr><td>
988 <h3 class="epydoc">BODY_PARAMETER_DEFAULT_VALUE</h3>
989
990 <dl class="fields">
991 </dl>
992 <dl class="fields">
993 <dt>Value:</dt>
994 <dd><table><tr><td><pre class="variable">
995{'description': 'The request body.', 'type': 'object', 'required': Tru<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
996e,}
997</pre></td></tr></table>
998</dd>
999 </dl>
1000</td></tr></table>
1001</div>
1002<a name="MEDIA_BODY_PARAMETER_DEFAULT_VALUE"></a>
1003<div class="private">
1004<table class="details" border="1" cellpadding="3"
1005 cellspacing="0" width="100%" bgcolor="white">
1006<tr><td>
1007 <h3 class="epydoc">MEDIA_BODY_PARAMETER_DEFAULT_VALUE</h3>
1008
1009 <dl class="fields">
1010 </dl>
1011 <dl class="fields">
1012 <dt>Value:</dt>
1013 <dd><table><tr><td><pre class="variable">
1014{'description':('The filename of the media request body, or an instanc<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
1015e ' 'of a MediaUpload object.'), 'type': 'string', 'required': False,}
1016</pre></td></tr></table>
1017</dd>
1018 </dl>
1019</td></tr></table>
1020</div>
1021<a name="STACK_QUERY_PARAMETERS"></a>
1022<div class="private">
1023<table class="details" border="1" cellpadding="3"
1024 cellspacing="0" width="100%" bgcolor="white">
1025<tr><td>
1026 <h3 class="epydoc">STACK_QUERY_PARAMETERS</h3>
1027
1028 <dl class="fields">
1029 </dl>
1030 <dl class="fields">
1031 <dt>Value:</dt>
1032 <dd><table><tr><td><pre class="variable">
1033frozenset(['trace', 'pp', 'userip', 'strict'])
1034</pre></td></tr></table>
1035</dd>
1036 </dl>
1037</td></tr></table>
1038</div>
1039<a name="STACK_QUERY_PARAMETER_DEFAULT_VALUE"></a>
1040<div class="private">
1041<table class="details" border="1" cellpadding="3"
1042 cellspacing="0" width="100%" bgcolor="white">
1043<tr><td>
1044 <h3 class="epydoc">STACK_QUERY_PARAMETER_DEFAULT_VALUE</h3>
1045
1046 <dl class="fields">
1047 </dl>
1048 <dl class="fields">
1049 <dt>Value:</dt>
1050 <dd><table><tr><td><pre class="variable">
1051{'type': 'string', 'location': 'query'}
1052</pre></td></tr></table>
1053</dd>
1054 </dl>
1055</td></tr></table>
1056</div>
1057<br />
1058<!-- ==================== NAVIGATION BAR ==================== -->
1059<table class="navbar" border="0" width="100%" cellpadding="0"
1060 bgcolor="#a0c0ff" cellspacing="0">
1061 <tr valign="middle">
1062 <!-- Home link -->
1063 <th>&nbsp;&nbsp;&nbsp;<a
1064 href="googleapiclient-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
1065
1066 <!-- Tree link -->
1067 <th>&nbsp;&nbsp;&nbsp;<a
1068 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
1069
1070 <!-- Index link -->
1071 <th>&nbsp;&nbsp;&nbsp;<a
1072 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
1073
1074 <!-- Help link -->
1075 <th>&nbsp;&nbsp;&nbsp;<a
1076 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
1077
1078 <th class="navbar" width="100%"></th>
1079 </tr>
1080</table>
1081<table border="0" cellpadding="0" cellspacing="0" width="100%%">
1082 <tr>
1083 <td align="left" class="footer">
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]1084 Generated by Epydoc 3.0.1 on Wed Oct 15 10:24:19 2014
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1085 </td>
1086 <td align="right" class="footer">
1087 <a target="mainFrame" href="http://epydoc.sourceforge.net"
1088 >http://epydoc.sourceforge.net</a>
1089 </td>
1090 </tr>
1091</table>
1092
1093<script type="text/javascript">
1094 <!--
1095 // Private objects are initially displayed (because if
1096 // javascript is turned off then we want them to be
1097 // visible); but by default, we want to hide them. So hide
1098 // them unless we have a cookie that says to show them.
1099 checkCookie();
1100 // -->
1101</script>
1102</body>
1103</html>