Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 614db98bf45b9da1f29c35a9d942536111e99d41 / . / docs / dyn / books_v1.mylibrary.bookshelves.html
blob: 907ef4ff1b9261cb5715d41a15b774976eac7e18 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame^]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="books_v1.html">Books API</a> . <a href="books_v1.mylibrary.html">mylibrary</a> . <a href="books_v1.mylibrary.bookshelves.html">bookshelves</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="books_v1.mylibrary.bookshelves.volumes.html">volumes()</a></code>
79</p>
80<p class="firstline">Returns the volumes Resource.</p>
81
82<p class="toc_element">
83 <code><a href="#addVolume">addVolume(shelf, volumeId, source=None)</a></code></p>
84<p class="firstline">Adds a volume to a bookshelf.</p>
85<p class="toc_element">
86 <code><a href="#clearVolumes">clearVolumes(shelf, source=None)</a></code></p>
87<p class="firstline">Clears all volumes from a bookshelf.</p>
88<p class="toc_element">
89 <code><a href="#get">get(shelf, source=None)</a></code></p>
90<p class="firstline">Retrieves metadata for a specific bookshelf belonging to the authenticated user.</p>
91<p class="toc_element">
92 <code><a href="#list">list(source=None)</a></code></p>
93<p class="firstline">Retrieves a list of bookshelves belonging to the authenticated user.</p>
94<p class="toc_element">
95 <code><a href="#moveVolume">moveVolume(shelf, volumeId, volumePosition, source=None)</a></code></p>
96<p class="firstline">Moves a volume within a bookshelf.</p>
97<p class="toc_element">
98 <code><a href="#removeVolume">removeVolume(shelf, volumeId, source=None)</a></code></p>
99<p class="firstline">Removes a volume from a bookshelf.</p>
100<h3>Method Details</h3>
101<div class="method">
102 <code class="details" id="addVolume">addVolume(shelf, volumeId, source=None)</code>
103 <pre>Adds a volume to a bookshelf.
104
105Args:
106 shelf: string, ID of bookshelf to which to add a volume. (required)
107 volumeId: string, ID of volume to add. (required)
108 source: string, String to identify the originator of this request.
109</pre>
110</div>
111
112<div class="method">
113 <code class="details" id="clearVolumes">clearVolumes(shelf, source=None)</code>
114 <pre>Clears all volumes from a bookshelf.
115
116Args:
117 shelf: string, ID of bookshelf from which to remove a volume. (required)
118 source: string, String to identify the originator of this request.
119</pre>
120</div>
121
122<div class="method">
123 <code class="details" id="get">get(shelf, source=None)</code>
124 <pre>Retrieves metadata for a specific bookshelf belonging to the authenticated user.
125
126Args:
127 shelf: string, ID of bookshelf to retrieve. (required)
128 source: string, String to identify the originator of this request.
129
130Returns:
131 An object of the form:
132
133 {
134 "kind": "books#bookshelf", # Resource type for bookshelf metadata.
135 "description": "A String", # Description of this bookshelf.
136 "created": "A String", # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).
137 "volumeCount": 42, # Number of volumes in this bookshelf.
138 "title": "A String", # Title of this bookshelf.
139 "updated": "A String", # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).
140 "access": "A String", # Whether this bookshelf is PUBLIC or PRIVATE.
141 "volumesLastUpdated": "A String", # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).
142 "id": 42, # Id of this bookshelf, only unique by user.
143 "selfLink": "A String", # URL to this resource.
144 }</pre>
145</div>
146
147<div class="method">
148 <code class="details" id="list">list(source=None)</code>
149 <pre>Retrieves a list of bookshelves belonging to the authenticated user.
150
151Args:
152 source: string, String to identify the originator of this request.
153
154Returns:
155 An object of the form:
156
157 {
158 "items": [ # A list of bookshelves.
159 {
160 "kind": "books#bookshelf", # Resource type for bookshelf metadata.
161 "description": "A String", # Description of this bookshelf.
162 "created": "A String", # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).
163 "volumeCount": 42, # Number of volumes in this bookshelf.
164 "title": "A String", # Title of this bookshelf.
165 "updated": "A String", # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).
166 "access": "A String", # Whether this bookshelf is PUBLIC or PRIVATE.
167 "volumesLastUpdated": "A String", # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).
168 "id": 42, # Id of this bookshelf, only unique by user.
169 "selfLink": "A String", # URL to this resource.
170 },
171 ],
172 "kind": "books#bookshelves", # Resource type.
173 }</pre>
174</div>
175
176<div class="method">
177 <code class="details" id="moveVolume">moveVolume(shelf, volumeId, volumePosition, source=None)</code>
178 <pre>Moves a volume within a bookshelf.
179
180Args:
181 shelf: string, ID of bookshelf with the volume. (required)
182 volumeId: string, ID of volume to move. (required)
183 volumePosition: integer, Position on shelf to move the item (0 puts the item before the current first item, 1 puts it between the first and the second and so on.) (required)
184 source: string, String to identify the originator of this request.
185</pre>
186</div>
187
188<div class="method">
189 <code class="details" id="removeVolume">removeVolume(shelf, volumeId, source=None)</code>
190 <pre>Removes a volume from a bookshelf.
191
192Args:
193 shelf: string, ID of bookshelf from which to remove a volume. (required)
194 volumeId: string, ID of volume to remove. (required)
195 source: string, String to identify the originator of this request.
196</pre>
197</div>
198
199</body></html>