Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 81d92cc73fb5e35c1e6a539dc1eb5f60b02dd316 / . / docs / dyn / books.v1.mylibrary.bookshelves.html
blob: c7c6710416e004935d31b025e4be69de6bf2b08f [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>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]20&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
21&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]22&nbsp;&nbsp;source:&nbsp;string,&nbsp;String&nbsp;to&nbsp;identify&nbsp;the&nbsp;originator&nbsp;of&nbsp;this&nbsp;request.<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]23&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>
Joe Gregorio6121dd92012-04-13 07:50:04 -0400[diff] [blame]24&nbsp;&nbsp;volumeId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;volume&nbsp;to&nbsp;add.&nbsp;(required)<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]25&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
26&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter</tt></dd></dl>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]27
28<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>
29&nbsp;<br>
30Args:<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]31&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
32&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]33&nbsp;&nbsp;source:&nbsp;string,&nbsp;String&nbsp;to&nbsp;identify&nbsp;the&nbsp;originator&nbsp;of&nbsp;this&nbsp;request.<br>
Joe Gregorio6121dd92012-04-13 07:50:04 -0400[diff] [blame]34&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>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]35&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
36&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter</tt></dd></dl>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]37
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500[diff] [blame]38<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves&nbsp;metadata&nbsp;for&nbsp;a&nbsp;specific&nbsp;bookshelf&nbsp;belonging&nbsp;to&nbsp;the&nbsp;authenticated&nbsp;user.<br>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]39&nbsp;<br>
40Args:<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]41&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
42&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio02503852011-08-31 09:07:55 -0400[diff] [blame]43&nbsp;&nbsp;source:&nbsp;string,&nbsp;String&nbsp;to&nbsp;identify&nbsp;the&nbsp;originator&nbsp;of&nbsp;this&nbsp;request.<br>
Joe Gregorio6121dd92012-04-13 07:50:04 -0400[diff] [blame]44&nbsp;&nbsp;shelf:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;bookshelf&nbsp;to&nbsp;retrieve.&nbsp;(required)<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]45&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
46&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]47&nbsp;<br>
48Returns:<br>
49&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
50&nbsp;<br>
51&nbsp;&nbsp;&nbsp;&nbsp;{<br>
52&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"books#bookshelf",&nbsp;#&nbsp;Resource&nbsp;type&nbsp;for&nbsp;bookshelf&nbsp;metadata.<br>
53&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Description&nbsp;of&nbsp;this&nbsp;bookshelf.<br>
54&nbsp;&nbsp;&nbsp;&nbsp;"created":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Created&nbsp;time&nbsp;for&nbsp;this&nbsp;bookshelf&nbsp;(formatted&nbsp;UTC&nbsp;timestamp&nbsp;with&nbsp;millisecond&nbsp;resolution).<br>
55&nbsp;&nbsp;&nbsp;&nbsp;"volumeCount":&nbsp;42,&nbsp;#&nbsp;Number&nbsp;of&nbsp;volumes&nbsp;in&nbsp;this&nbsp;bookshelf.<br>
56&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;this&nbsp;bookshelf.<br>
57&nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Last&nbsp;modified&nbsp;time&nbsp;of&nbsp;this&nbsp;bookshelf&nbsp;(formatted&nbsp;UTC&nbsp;timestamp&nbsp;with&nbsp;millisecond&nbsp;resolution).<br>
58&nbsp;&nbsp;&nbsp;&nbsp;"access":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Whether&nbsp;this&nbsp;bookshelf&nbsp;is&nbsp;PUBLIC&nbsp;or&nbsp;PRIVATE.<br>
59&nbsp;&nbsp;&nbsp;&nbsp;"volumesLastUpdated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Last&nbsp;time&nbsp;a&nbsp;volume&nbsp;was&nbsp;added&nbsp;or&nbsp;removed&nbsp;from&nbsp;this&nbsp;bookshelf&nbsp;(formatted&nbsp;UTC&nbsp;timestamp&nbsp;with&nbsp;millisecond&nbsp;resolution).<br>
60&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;42,&nbsp;#&nbsp;Id&nbsp;of&nbsp;this&nbsp;bookshelf,&nbsp;only&nbsp;unique&nbsp;by&nbsp;user.<br>
61&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;to&nbsp;this&nbsp;resource.<br>
62&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]63
64<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>
65&nbsp;<br>
66Args:<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]67&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
68&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]69&nbsp;&nbsp;source:&nbsp;string,&nbsp;String&nbsp;to&nbsp;identify&nbsp;the&nbsp;originator&nbsp;of&nbsp;this&nbsp;request.<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]70&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
71&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]72&nbsp;<br>
73Returns:<br>
74&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
75&nbsp;<br>
76&nbsp;&nbsp;&nbsp;&nbsp;{<br>
77&nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[&nbsp;#&nbsp;A&nbsp;list&nbsp;of&nbsp;bookshelves.<br>
78&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
79&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"books#bookshelf",&nbsp;#&nbsp;Resource&nbsp;type&nbsp;for&nbsp;bookshelf&nbsp;metadata.<br>
80&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Description&nbsp;of&nbsp;this&nbsp;bookshelf.<br>
81&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"created":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Created&nbsp;time&nbsp;for&nbsp;this&nbsp;bookshelf&nbsp;(formatted&nbsp;UTC&nbsp;timestamp&nbsp;with&nbsp;millisecond&nbsp;resolution).<br>
82&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"volumeCount":&nbsp;42,&nbsp;#&nbsp;Number&nbsp;of&nbsp;volumes&nbsp;in&nbsp;this&nbsp;bookshelf.<br>
83&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;this&nbsp;bookshelf.<br>
84&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Last&nbsp;modified&nbsp;time&nbsp;of&nbsp;this&nbsp;bookshelf&nbsp;(formatted&nbsp;UTC&nbsp;timestamp&nbsp;with&nbsp;millisecond&nbsp;resolution).<br>
85&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"access":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Whether&nbsp;this&nbsp;bookshelf&nbsp;is&nbsp;PUBLIC&nbsp;or&nbsp;PRIVATE.<br>
86&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"volumesLastUpdated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Last&nbsp;time&nbsp;a&nbsp;volume&nbsp;was&nbsp;added&nbsp;or&nbsp;removed&nbsp;from&nbsp;this&nbsp;bookshelf&nbsp;(formatted&nbsp;UTC&nbsp;timestamp&nbsp;with&nbsp;millisecond&nbsp;resolution).<br>
87&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;42,&nbsp;#&nbsp;Id&nbsp;of&nbsp;this&nbsp;bookshelf,&nbsp;only&nbsp;unique&nbsp;by&nbsp;user.<br>
88&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;to&nbsp;this&nbsp;resource.<br>
89&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
90&nbsp;&nbsp;&nbsp;&nbsp;],<br>
91&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"books#bookshelves",&nbsp;#&nbsp;Resource&nbsp;type.<br>
92&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]93
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500[diff] [blame]94<dl><dt><a name="Resource-moveVolume"><strong>moveVolume</strong></a> = method(self, **kwargs)</dt><dd><tt>Moves&nbsp;a&nbsp;volume&nbsp;within&nbsp;a&nbsp;bookshelf.<br>
95&nbsp;<br>
96Args:<br>
97&nbsp;&nbsp;volumePosition:&nbsp;integer,&nbsp;Position&nbsp;on&nbsp;shelf&nbsp;to&nbsp;move&nbsp;the&nbsp;item&nbsp;(0&nbsp;puts&nbsp;the&nbsp;item&nbsp;before&nbsp;the&nbsp;current&nbsp;first&nbsp;item,&nbsp;1&nbsp;puts&nbsp;it&nbsp;between&nbsp;the&nbsp;first&nbsp;and&nbsp;the&nbsp;second&nbsp;and&nbsp;so&nbsp;on.)&nbsp;(required)<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]98&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
99&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500[diff] [blame]100&nbsp;&nbsp;source:&nbsp;string,&nbsp;String&nbsp;to&nbsp;identify&nbsp;the&nbsp;originator&nbsp;of&nbsp;this&nbsp;request.<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]101&nbsp;&nbsp;shelf:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;bookshelf&nbsp;with&nbsp;the&nbsp;volume.&nbsp;(required)<br>
Joe Gregorio6121dd92012-04-13 07:50:04 -0400[diff] [blame]102&nbsp;&nbsp;volumeId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;volume&nbsp;to&nbsp;move.&nbsp;(required)<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]103&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
104&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter</tt></dd></dl>
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500[diff] [blame]105
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]106<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>
107&nbsp;<br>
108Args:<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]109&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
110&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]111&nbsp;&nbsp;source:&nbsp;string,&nbsp;String&nbsp;to&nbsp;identify&nbsp;the&nbsp;originator&nbsp;of&nbsp;this&nbsp;request.<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]112&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>
Joe Gregorio6121dd92012-04-13 07:50:04 -0400[diff] [blame]113&nbsp;&nbsp;volumeId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;volume&nbsp;to&nbsp;remove.&nbsp;(required)<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]114&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
115&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter</tt></dd></dl>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]116
117<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>
118
119<hr>
120Data descriptors defined here:<br>
121<dl><dt><strong>__dict__</strong></dt>
122<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
123</dl>
124<dl><dt><strong>__weakref__</strong></dt>
125<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
126</dl>
127</td></tr></table>
128</body></html>