Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4c46b7b86171b89f0c85f6d48eaf6d24e702c6f9 / . / docs / dyn / books.v1.mylibrary.bookshelves.html
blob: 4455cc8cb7a803925f204dc9397690b02fbb1984 [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 Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]20&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]21&nbsp;&nbsp;country:&nbsp;string,&nbsp;ISO-3166-1&nbsp;code&nbsp;to&nbsp;override&nbsp;the&nbsp;IP-based&nbsp;location.<br>
22&nbsp;&nbsp;volumeId:&nbsp;string,&nbsp;Id&nbsp;of&nbsp;volume&nbsp;to&nbsp;add.&nbsp;(required)<br>
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)</tt></dd></dl>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]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>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]28&nbsp;&nbsp;source:&nbsp;string,&nbsp;String&nbsp;to&nbsp;identify&nbsp;the&nbsp;originator&nbsp;of&nbsp;this&nbsp;request.<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500[diff] [blame]29&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>
30&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]31
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500[diff] [blame]32<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]33&nbsp;<br>
34Args:<br>
Joe Gregorio02503852011-08-31 09:07:55 -0400[diff] [blame]35&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]36&nbsp;&nbsp;shelf:&nbsp;string,&nbsp;Id&nbsp;of&nbsp;bookshelf&nbsp;to&nbsp;retrieve.&nbsp;(required)<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]37&nbsp;&nbsp;country:&nbsp;string,&nbsp;ISO-3166-1&nbsp;code&nbsp;to&nbsp;override&nbsp;the&nbsp;IP-based&nbsp;location.<br>
38&nbsp;<br>
39Returns:<br>
40&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
41&nbsp;<br>
42&nbsp;&nbsp;&nbsp;&nbsp;{<br>
43&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"books#bookshelf",&nbsp;#&nbsp;Resource&nbsp;type&nbsp;for&nbsp;bookshelf&nbsp;metadata.<br>
44&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Description&nbsp;of&nbsp;this&nbsp;bookshelf.<br>
45&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>
46&nbsp;&nbsp;&nbsp;&nbsp;"volumeCount":&nbsp;42,&nbsp;#&nbsp;Number&nbsp;of&nbsp;volumes&nbsp;in&nbsp;this&nbsp;bookshelf.<br>
47&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;this&nbsp;bookshelf.<br>
48&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>
49&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>
50&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>
51&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>
52&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;to&nbsp;this&nbsp;resource.<br>
53&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]54
55<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>
56&nbsp;<br>
57Args:<br>
Joe Gregorio02503852011-08-31 09:07:55 -0400[diff] [blame]58&nbsp;&nbsp;country:&nbsp;string,&nbsp;ISO-3166-1&nbsp;code&nbsp;to&nbsp;override&nbsp;the&nbsp;IP-based&nbsp;location.<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]59&nbsp;&nbsp;source:&nbsp;string,&nbsp;String&nbsp;to&nbsp;identify&nbsp;the&nbsp;originator&nbsp;of&nbsp;this&nbsp;request.<br>
60&nbsp;<br>
61Returns:<br>
62&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
63&nbsp;<br>
64&nbsp;&nbsp;&nbsp;&nbsp;{<br>
65&nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[&nbsp;#&nbsp;A&nbsp;list&nbsp;of&nbsp;bookshelves.<br>
66&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
67&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"books#bookshelf",&nbsp;#&nbsp;Resource&nbsp;type&nbsp;for&nbsp;bookshelf&nbsp;metadata.<br>
68&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Description&nbsp;of&nbsp;this&nbsp;bookshelf.<br>
69&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>
70&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>
71&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;this&nbsp;bookshelf.<br>
72&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>
73&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>
74&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>
75&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>
76&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;to&nbsp;this&nbsp;resource.<br>
77&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
78&nbsp;&nbsp;&nbsp;&nbsp;],<br>
79&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"books#bookshelves",&nbsp;#&nbsp;Resource&nbsp;type.<br>
80&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]81
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500[diff] [blame]82<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>
83&nbsp;<br>
84Args:<br>
85&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>
86&nbsp;&nbsp;source:&nbsp;string,&nbsp;String&nbsp;to&nbsp;identify&nbsp;the&nbsp;originator&nbsp;of&nbsp;this&nbsp;request.<br>
87&nbsp;&nbsp;country:&nbsp;string,&nbsp;ISO-3166-1&nbsp;code&nbsp;to&nbsp;override&nbsp;the&nbsp;IP-based&nbsp;location.<br>
88&nbsp;&nbsp;volumeId:&nbsp;string,&nbsp;Id&nbsp;of&nbsp;volume&nbsp;to&nbsp;move.&nbsp;(required)<br>
89&nbsp;&nbsp;shelf:&nbsp;string,&nbsp;Id&nbsp;of&nbsp;bookshelf&nbsp;with&nbsp;the&nbsp;volume.&nbsp;(required)</tt></dd></dl>
90
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]91<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>
92&nbsp;<br>
93Args:<br>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]94&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]95&nbsp;&nbsp;country:&nbsp;string,&nbsp;ISO-3166-1&nbsp;code&nbsp;to&nbsp;override&nbsp;the&nbsp;IP-based&nbsp;location.<br>
96&nbsp;&nbsp;volumeId:&nbsp;string,&nbsp;Id&nbsp;of&nbsp;volume&nbsp;to&nbsp;remove.&nbsp;(required)<br>
97&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]98
99<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>
100
101<hr>
102Data descriptors defined here:<br>
103<dl><dt><strong>__dict__</strong></dt>
104<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
105</dl>
106<dl><dt><strong>__weakref__</strong></dt>
107<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
108</dl>
109</td></tr></table>
110</body></html>