67 lines
4.6 KiB
HTML
67 lines
4.6 KiB
HTML
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
<html><head><title>Python: class Resource</title>
|
|
</head><body bgcolor="#f0f0f8">
|
|
<p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<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>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%">Methods defined here:<br>
|
|
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
|
|
|
<dl><dt><a name="Resource-addVolume"><strong>addVolume</strong></a> = method(self, **kwargs)</dt><dd><tt>Adds a volume to a bookshelf.<br>
|
|
<br>
|
|
Args:<br>
|
|
body: object, The request body. (required)<br>
|
|
source: string, String to identify the originator of this request.<br>
|
|
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
|
volumeId: string, Id of volume to add. (required)<br>
|
|
shelf: string, Id of bookshelf to which to add a volume. (required)</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Resource-clearVolumes"><strong>clearVolumes</strong></a> = method(self, **kwargs)</dt><dd><tt>Clears all volumes from a bookshelf.<br>
|
|
<br>
|
|
Args:<br>
|
|
body: object, The request body. (required)<br>
|
|
source: string, String to identify the originator of this request.<br>
|
|
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
|
shelf: string, Id of bookshelf from which to remove a volume. (required)</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves a specific bookshelf belonging to the authenticated user.<br>
|
|
<br>
|
|
Args:<br>
|
|
source: string, String to identify the originator of this request.<br>
|
|
shelf: string, Id of bookshelf to retrieve. (required)<br>
|
|
country: string, ISO-3166-1 code to override the IP-based location.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves a list of bookshelves belonging to the authenticated user.<br>
|
|
<br>
|
|
Args:<br>
|
|
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
|
source: string, String to identify the originator of this request.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Resource-removeVolume"><strong>removeVolume</strong></a> = method(self, **kwargs)</dt><dd><tt>Removes a volume from a bookshelf.<br>
|
|
<br>
|
|
Args:<br>
|
|
body: object, The request body. (required)<br>
|
|
source: string, String to identify the originator of this request.<br>
|
|
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
|
volumeId: string, Id of volume to remove. (required)<br>
|
|
shelf: string, Id of bookshelf from which to remove a volume. (required)</tt></dd></dl>
|
|
|
|
<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 collection resource.</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors defined here:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
</td></tr></table>
|
|
</body></html> |