Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 2b781287174b9335b6a77f14f87f2c28e6cfad8e / . / docs / dyn / books.v1.mylibrary.bookshelves.html
blob: d1050ca1c5616e2c336a328e20ed29987b24a266 [file] [log] [blame]
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]1
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: class Resource</title>
4</head><body bgcolor="#f0f0f8">
5<p>
6<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
7<tr bgcolor="#ffc8d8">
8<td colspan=3 valign=bottom>&nbsp;<br>
9<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
10
11<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
12<td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
13<tr><td>&nbsp;</td>
14<td width="100%">Methods defined here:<br>
15<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
16
17<dl><dt><a name="Resource-addVolume"><strong>addVolume</strong></a> = method(self, **kwargs)</dt><dd><tt>Adds&nbsp;a&nbsp;volume&nbsp;to&nbsp;a&nbsp;bookshelf.<br>
18&nbsp;<br>
19Args:<br>
20&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
21&nbsp;&nbsp;source:&nbsp;string,&nbsp;String&nbsp;to&nbsp;identify&nbsp;the&nbsp;originator&nbsp;of&nbsp;this&nbsp;request.<br>
Joe Gregorio02503852011-08-31 09:07:55 -0400[diff] [blame]22&nbsp;&nbsp;country:&nbsp;string,&nbsp;ISO-3166-1&nbsp;code&nbsp;to&nbsp;override&nbsp;the&nbsp;IP-based&nbsp;location.<br>
23&nbsp;&nbsp;volumeId:&nbsp;string,&nbsp;Id&nbsp;of&nbsp;volume&nbsp;to&nbsp;add.&nbsp;(required)<br>
24&nbsp;&nbsp;shelf:&nbsp;string,&nbsp;Id&nbsp;of&nbsp;bookshelf&nbsp;to&nbsp;which&nbsp;to&nbsp;add&nbsp;a&nbsp;volume.&nbsp;(required)</tt></dd></dl>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]25
26<dl><dt><a name="Resource-clearVolumes"><strong>clearVolumes</strong></a> = method(self, **kwargs)</dt><dd><tt>Clears&nbsp;all&nbsp;volumes&nbsp;from&nbsp;a&nbsp;bookshelf.<br>
27&nbsp;<br>
28Args:<br>
29&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
30&nbsp;&nbsp;source:&nbsp;string,&nbsp;String&nbsp;to&nbsp;identify&nbsp;the&nbsp;originator&nbsp;of&nbsp;this&nbsp;request.<br>
Joe Gregorio02503852011-08-31 09:07:55 -0400[diff] [blame]31&nbsp;&nbsp;country:&nbsp;string,&nbsp;ISO-3166-1&nbsp;code&nbsp;to&nbsp;override&nbsp;the&nbsp;IP-based&nbsp;location.<br>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]32&nbsp;&nbsp;shelf:&nbsp;string,&nbsp;Id&nbsp;of&nbsp;bookshelf&nbsp;from&nbsp;which&nbsp;to&nbsp;remove&nbsp;a&nbsp;volume.&nbsp;(required)</tt></dd></dl>
33
34<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves&nbsp;a&nbsp;specific&nbsp;bookshelf&nbsp;belonging&nbsp;to&nbsp;the&nbsp;authenticated&nbsp;user.<br>
35&nbsp;<br>
36Args:<br>
Joe Gregorio02503852011-08-31 09:07:55 -0400[diff] [blame]37&nbsp;&nbsp;source:&nbsp;string,&nbsp;String&nbsp;to&nbsp;identify&nbsp;the&nbsp;originator&nbsp;of&nbsp;this&nbsp;request.<br>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]38&nbsp;&nbsp;shelf:&nbsp;string,&nbsp;Id&nbsp;of&nbsp;bookshelf&nbsp;to&nbsp;retrieve.&nbsp;(required)<br>
Joe Gregorio02503852011-08-31 09:07:55 -0400[diff] [blame]39&nbsp;&nbsp;country:&nbsp;string,&nbsp;ISO-3166-1&nbsp;code&nbsp;to&nbsp;override&nbsp;the&nbsp;IP-based&nbsp;location.</tt></dd></dl>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]40
41<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves&nbsp;a&nbsp;list&nbsp;of&nbsp;bookshelves&nbsp;belonging&nbsp;to&nbsp;the&nbsp;authenticated&nbsp;user.<br>
42&nbsp;<br>
43Args:<br>
Joe Gregorio02503852011-08-31 09:07:55 -0400[diff] [blame]44&nbsp;&nbsp;country:&nbsp;string,&nbsp;ISO-3166-1&nbsp;code&nbsp;to&nbsp;override&nbsp;the&nbsp;IP-based&nbsp;location.<br>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]45&nbsp;&nbsp;source:&nbsp;string,&nbsp;String&nbsp;to&nbsp;identify&nbsp;the&nbsp;originator&nbsp;of&nbsp;this&nbsp;request.</tt></dd></dl>
46
47<dl><dt><a name="Resource-removeVolume"><strong>removeVolume</strong></a> = method(self, **kwargs)</dt><dd><tt>Removes&nbsp;a&nbsp;volume&nbsp;from&nbsp;a&nbsp;bookshelf.<br>
48&nbsp;<br>
49Args:<br>
50&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
51&nbsp;&nbsp;source:&nbsp;string,&nbsp;String&nbsp;to&nbsp;identify&nbsp;the&nbsp;originator&nbsp;of&nbsp;this&nbsp;request.<br>
Joe Gregorio02503852011-08-31 09:07:55 -0400[diff] [blame]52&nbsp;&nbsp;country:&nbsp;string,&nbsp;ISO-3166-1&nbsp;code&nbsp;to&nbsp;override&nbsp;the&nbsp;IP-based&nbsp;location.<br>
53&nbsp;&nbsp;volumeId:&nbsp;string,&nbsp;Id&nbsp;of&nbsp;volume&nbsp;to&nbsp;remove.&nbsp;(required)<br>
54&nbsp;&nbsp;shelf:&nbsp;string,&nbsp;Id&nbsp;of&nbsp;bookshelf&nbsp;from&nbsp;which&nbsp;to&nbsp;remove&nbsp;a&nbsp;volume.&nbsp;(required)</tt></dd></dl>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]55
56<dl><dt><a name="Resource-volumes"><strong><a href="books.v1.mylibrary.bookshelves.volumes.html">volumes</a></strong></a> = methodResource(self)</dt><dd><tt>A&nbsp;collection&nbsp;resource.</tt></dd></dl>
57
58<hr>
59Data descriptors defined here:<br>
60<dl><dt><strong>__dict__</strong></dt>
61<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
62</dl>
63<dl><dt><strong>__weakref__</strong></dt>
64<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
65</dl>
66</td></tr></table>
67</body></html>