| Joe Gregorio | b9e63ff | 2011-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> <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> </tt></td> |
| 12 | <td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr> |
| 13 | <tr><td> </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-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves a specific bookshelf for the specified user.<br> |
| 18 | <br> |
| 19 | Args:<br> |
| 20 | source: string, String to identify the originator of this request.<br> |
| Joe Gregorio | 0250385 | 2011-08-31 09:07:55 -0400 | [diff] [blame] | 21 | country: string, ISO-3166-1 code to override the IP-based location.<br> |
| 22 | userId: string, Id of user for whom to retrieve bookshelves. (required)<br> |
| Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame] | 23 | shelf: string, Id of bookshelf to retrieve. (required)<br> |
| 24 | <br> |
| 25 | Returns:<br> |
| 26 | An object of the form<br> |
| 27 | <br> |
| 28 | {<br> |
| 29 | "kind": "books#bookshelf", # Resource type for bookshelf metadata.<br> |
| 30 | "description": "A String", # Description of this bookshelf.<br> |
| 31 | "created": "A String", # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).<br> |
| 32 | "volumeCount": 42, # Number of volumes in this bookshelf.<br> |
| 33 | "title": "A String", # Title of this bookshelf.<br> |
| 34 | "updated": "A String", # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).<br> |
| 35 | "access": "A String", # Whether this bookshelf is PUBLIC or PRIVATE.<br> |
| 36 | "volumesLastUpdated": "A String", # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).<br> |
| 37 | "id": 42, # Id of this bookshelf, only unique by user.<br> |
| 38 | "selfLink": "A String", # URL to this resource.<br> |
| 39 | }</tt></dd></dl> |
| Joe Gregorio | b9e63ff | 2011-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 a list of public bookshelves for the specified user.<br> |
| 42 | <br> |
| 43 | Args:<br> |
| 44 | source: string, String to identify the originator of this request.<br> |
| Joe Gregorio | 0250385 | 2011-08-31 09:07:55 -0400 | [diff] [blame] | 45 | country: string, ISO-3166-1 code to override the IP-based location.<br> |
| Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame] | 46 | userId: string, Id of user for whom to retrieve bookshelves. (required)<br> |
| 47 | <br> |
| 48 | Returns:<br> |
| 49 | An object of the form<br> |
| 50 | <br> |
| 51 | {<br> |
| 52 | "items": [ # A list of bookshelves.<br> |
| 53 | {<br> |
| 54 | "kind": "books#bookshelf", # Resource type for bookshelf metadata.<br> |
| 55 | "description": "A String", # Description of this bookshelf.<br> |
| 56 | "created": "A String", # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).<br> |
| 57 | "volumeCount": 42, # Number of volumes in this bookshelf.<br> |
| 58 | "title": "A String", # Title of this bookshelf.<br> |
| 59 | "updated": "A String", # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).<br> |
| 60 | "access": "A String", # Whether this bookshelf is PUBLIC or PRIVATE.<br> |
| 61 | "volumesLastUpdated": "A String", # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).<br> |
| 62 | "id": 42, # Id of this bookshelf, only unique by user.<br> |
| 63 | "selfLink": "A String", # URL to this resource.<br> |
| 64 | },<br> |
| 65 | ],<br> |
| 66 | "kind": "books#bookshelves", # Resource type.<br> |
| 67 | }</tt></dd></dl> |
| Joe Gregorio | b9e63ff | 2011-06-30 12:38:10 -0400 | [diff] [blame] | 68 | |
| 69 | <dl><dt><a name="Resource-volumes"><strong><a href="books.v1.bookshelves.volumes.html">volumes</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl> |
| 70 | |
| 71 | <hr> |
| 72 | Data descriptors defined here:<br> |
| 73 | <dl><dt><strong>__dict__</strong></dt> |
| 74 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| 75 | </dl> |
| 76 | <dl><dt><strong>__weakref__</strong></dt> |
| 77 | <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| 78 | </dl> |
| 79 | </td></tr></table> |
| 80 | </body></html> |