Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 8045c4550a7f366dd071a6ffb27dba362e59bf95 / . / docs / dyn / libraryagent_v1.shelves.html
blob: 48c579abd319d1f93d1f3aa34f6f07dbdab629ea [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[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="libraryagent_v1.html">Library Agent API</a> . <a href="libraryagent_v1.shelves.html">shelves</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="libraryagent_v1.shelves.books.html">books()</a></code>
79</p>
80<p class="firstline">Returns the books Resource.</p>
81
82<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]83 <code><a href="#close">close()</a></code></p>
84<p class="firstline">Close httplib2 connections.</p>
85<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]86 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
87<p class="firstline">Gets a shelf. Returns NOT_FOUND if the shelf does not exist.</p>
88<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]89 <code><a href="#list">list(pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]90<p class="firstline">Lists shelves. The order is unspecified but deterministic. Newly created shelves will not necessarily be added to the end of this list.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]91<p class="toc_element">
92 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
93<p class="firstline">Retrieves the next page of results.</p>
94<h3>Method Details</h3>
95<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]96 <code class="details" id="close">close()</code>
97 <pre>Close httplib2 connections.</pre>
98</div>
99
100<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]101 <code class="details" id="get">get(name, x__xgafv=None)</code>
102 <pre>Gets a shelf. Returns NOT_FOUND if the shelf does not exist.
103
104Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]105 name: string, Required. The name of the shelf to retrieve. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106 x__xgafv: string, V1 error format.
107 Allowed values
108 1 - v1 error format
109 2 - v2 error format
110
111Returns:
112 An object of the form:
113
114 { # A Shelf contains a collection of books with a theme.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]115 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the shelf. Shelf names have the form `shelves/{shelf_id}`. The name is ignored when creating a shelf.
116 &quot;theme&quot;: &quot;A String&quot;, # The theme of the shelf
117}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]118</div>
119
120<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]121 <code class="details" id="list">list(pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]122 <pre>Lists shelves. The order is unspecified but deterministic. Newly created shelves will not necessarily be added to the end of this list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]123
124Args:
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]125 pageSize: integer, Requested page size. Server may return fewer shelves than requested. If unspecified, server will pick an appropriate default.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]126 pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of ListShelvesResponse.next_page_token returned from the previous call to `ListShelves` method.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]127 x__xgafv: string, V1 error format.
128 Allowed values
129 1 - v1 error format
130 2 - v2 error format
131
132Returns:
133 An object of the form:
134
135 { # Response message for LibraryAgent.ListShelves.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]136 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to retrieve next page of results. Pass this value in the ListShelvesRequest.page_token field in the subsequent call to `ListShelves` method to retrieve the next page of results.
137 &quot;shelves&quot;: [ # The list of shelves.
138 { # A Shelf contains a collection of books with a theme.
139 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the shelf. Shelf names have the form `shelves/{shelf_id}`. The name is ignored when creating a shelf.
140 &quot;theme&quot;: &quot;A String&quot;, # The theme of the shelf
141 },
142 ],
143}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]144</div>
145
146<div class="method">
147 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
148 <pre>Retrieves the next page of results.
149
150Args:
151 previous_request: The request for the previous page. (required)
152 previous_response: The response from the request for the previous page. (required)
153
154Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]155 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]156 page. Returns None if there are no more items in the collection.
157 </pre>
158</div>
159
160</body></html>