• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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">
83  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
84<p class="firstline">Gets a shelf. Returns NOT_FOUND if the shelf does not exist.</p>
85<p class="toc_element">
86  <code><a href="#list">list(pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
87<p class="firstline">Lists shelves. The order is unspecified but deterministic. Newly created</p>
88<p class="toc_element">
89  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
90<p class="firstline">Retrieves the next page of results.</p>
91<h3>Method Details</h3>
92<div class="method">
93    <code class="details" id="get">get(name, x__xgafv=None)</code>
94  <pre>Gets a shelf. Returns NOT_FOUND if the shelf does not exist.
95
96Args:
97  name: string, The name of the shelf to retrieve. (required)
98  x__xgafv: string, V1 error format.
99    Allowed values
100      1 - v1 error format
101      2 - v2 error format
102
103Returns:
104  An object of the form:
105
106    { # A Shelf contains a collection of books with a theme.
107    "theme": "A String", # The theme of the shelf
108    "name": "A String", # Output only. The resource name of the shelf.
109        # Shelf names have the form `shelves/{shelf_id}`.
110        # The name is ignored when creating a shelf.
111  }</pre>
112</div>
113
114<div class="method">
115    <code class="details" id="list">list(pageSize=None, pageToken=None, x__xgafv=None)</code>
116  <pre>Lists shelves. The order is unspecified but deterministic. Newly created
117shelves will not necessarily be added to the end of this list.
118
119Args:
120  pageSize: integer, Requested page size. Server may return fewer shelves than requested.
121If unspecified, server will pick an appropriate default.
122  pageToken: string, A token identifying a page of results the server should return.
123Typically, this is the value of
124ListShelvesResponse.next_page_token
125returned from the previous call to `ListShelves` method.
126  x__xgafv: string, V1 error format.
127    Allowed values
128      1 - v1 error format
129      2 - v2 error format
130
131Returns:
132  An object of the form:
133
134    { # Response message for LibraryAgent.ListShelves.
135    "nextPageToken": "A String", # A token to retrieve next page of results.
136        # Pass this value in the
137        # ListShelvesRequest.page_token
138        # field in the subsequent call to `ListShelves` method to retrieve the next
139        # page of results.
140    "shelves": [ # The list of shelves.
141      { # A Shelf contains a collection of books with a theme.
142        "theme": "A String", # The theme of the shelf
143        "name": "A String", # Output only. The resource name of the shelf.
144            # Shelf names have the form `shelves/{shelf_id}`.
145            # The name is ignored when creating a shelf.
146      },
147    ],
148  }</pre>
149</div>
150
151<div class="method">
152    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
153  <pre>Retrieves the next page of results.
154
155Args:
156  previous_request: The request for the previous page. (required)
157  previous_response: The response from the request for the previous page. (required)
158
159Returns:
160  A request object that you can call 'execute()' on to request the next
161  page. Returns None if there are no more items in the collection.
162    </pre>
163</div>
164
165</body></html>