blob: 1aa548414912cbfe52436f5843a7bfb567b3280e [file] [log] [blame]
Joe Gregoriob9e63ff2011-06-30 12:38:10 -04001
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>
22&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)<br>
23&nbsp;&nbsp;volumeId:&nbsp;string,&nbsp;Id&nbsp;of&nbsp;volume&nbsp;to&nbsp;add.&nbsp;(required)</tt></dd></dl>
24
25<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>
26&nbsp;<br>
27Args:<br>
28&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
29&nbsp;&nbsp;source:&nbsp;string,&nbsp;String&nbsp;to&nbsp;identify&nbsp;the&nbsp;originator&nbsp;of&nbsp;this&nbsp;request.<br>
30&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>
31
32<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>
33&nbsp;<br>
34Args:<br>
35&nbsp;&nbsp;shelf:&nbsp;string,&nbsp;Id&nbsp;of&nbsp;bookshelf&nbsp;to&nbsp;retrieve.&nbsp;(required)<br>
36&nbsp;&nbsp;source:&nbsp;string,&nbsp;String&nbsp;to&nbsp;identify&nbsp;the&nbsp;originator&nbsp;of&nbsp;this&nbsp;request.</tt></dd></dl>
37
38<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>
39&nbsp;<br>
40Args:<br>
41&nbsp;&nbsp;source:&nbsp;string,&nbsp;String&nbsp;to&nbsp;identify&nbsp;the&nbsp;originator&nbsp;of&nbsp;this&nbsp;request.</tt></dd></dl>
42
43<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>
44&nbsp;<br>
45Args:<br>
46&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
47&nbsp;&nbsp;source:&nbsp;string,&nbsp;String&nbsp;to&nbsp;identify&nbsp;the&nbsp;originator&nbsp;of&nbsp;this&nbsp;request.<br>
48&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)<br>
49&nbsp;&nbsp;volumeId:&nbsp;string,&nbsp;Id&nbsp;of&nbsp;volume&nbsp;to&nbsp;remove.&nbsp;(required)</tt></dd></dl>
50
51<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>
52
53<hr>
54Data descriptors defined here:<br>
55<dl><dt><strong>__dict__</strong></dt>
56<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
57</dl>
58<dl><dt><strong>__weakref__</strong></dt>
59<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
60</dl>
61</td></tr></table>
62</body></html>