You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
226 lines
6.8 KiB
226 lines
6.8 KiB
<html><body>
|
|
<style>
|
|
|
|
body, h1, h2, h3, div, span, p, pre, a {
|
|
margin: 0;
|
|
padding: 0;
|
|
border: 0;
|
|
font-weight: inherit;
|
|
font-style: inherit;
|
|
font-size: 100%;
|
|
font-family: inherit;
|
|
vertical-align: baseline;
|
|
}
|
|
|
|
body {
|
|
font-size: 13px;
|
|
padding: 1em;
|
|
}
|
|
|
|
h1 {
|
|
font-size: 26px;
|
|
margin-bottom: 1em;
|
|
}
|
|
|
|
h2 {
|
|
font-size: 24px;
|
|
margin-bottom: 1em;
|
|
}
|
|
|
|
h3 {
|
|
font-size: 20px;
|
|
margin-bottom: 1em;
|
|
margin-top: 1em;
|
|
}
|
|
|
|
pre, code {
|
|
line-height: 1.5;
|
|
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
|
|
}
|
|
|
|
pre {
|
|
margin-top: 0.5em;
|
|
}
|
|
|
|
h1, h2, h3, p {
|
|
font-family: Arial, sans serif;
|
|
}
|
|
|
|
h1, h2, h3 {
|
|
border-bottom: solid #CCC 1px;
|
|
}
|
|
|
|
.toc_element {
|
|
margin-top: 0.5em;
|
|
}
|
|
|
|
.firstline {
|
|
margin-left: 2 em;
|
|
}
|
|
|
|
.method {
|
|
margin-top: 1em;
|
|
border: solid 1px #CCC;
|
|
padding: 1em;
|
|
background: #EEE;
|
|
}
|
|
|
|
.details {
|
|
font-weight: bold;
|
|
font-size: 14px;
|
|
}
|
|
|
|
</style>
|
|
|
|
<h1><a href="libraryagent_v1.html">Library Agent API</a> . <a href="libraryagent_v1.shelves.html">shelves</a> . <a href="libraryagent_v1.shelves.books.html">books</a></h1>
|
|
<h2>Instance Methods</h2>
|
|
<p class="toc_element">
|
|
<code><a href="#borrow">borrow(name, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Borrow a book from the library. Returns the book if it is borrowed</p>
|
|
<p class="toc_element">
|
|
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Gets a book. Returns NOT_FOUND if the book does not exist.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
|
|
<p class="firstline">Lists books in a shelf. The order is unspecified but deterministic. Newly</p>
|
|
<p class="toc_element">
|
|
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
|
<p class="firstline">Retrieves the next page of results.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#return_">return_(name, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Return a book to the library. Returns the book if it is returned to the</p>
|
|
<h3>Method Details</h3>
|
|
<div class="method">
|
|
<code class="details" id="borrow">borrow(name, x__xgafv=None)</code>
|
|
<pre>Borrow a book from the library. Returns the book if it is borrowed
|
|
successfully. Returns NOT_FOUND if the book does not exist in the library.
|
|
Returns quota exceeded error if the amount of books borrowed exceeds
|
|
allocation quota in any dimensions.
|
|
|
|
Args:
|
|
name: string, The name of the book to borrow. (required)
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # A single book in the library.
|
|
"read": True or False, # Value indicating whether the book has been read.
|
|
"title": "A String", # The title of the book.
|
|
"name": "A String", # The resource name of the book.
|
|
# Book names have the form `shelves/{shelf_id}/books/{book_id}`.
|
|
# The name is ignored when creating a book.
|
|
"author": "A String", # The name of the book author.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="get">get(name, x__xgafv=None)</code>
|
|
<pre>Gets a book. Returns NOT_FOUND if the book does not exist.
|
|
|
|
Args:
|
|
name: string, The name of the book to retrieve. (required)
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # A single book in the library.
|
|
"read": True or False, # Value indicating whether the book has been read.
|
|
"title": "A String", # The title of the book.
|
|
"name": "A String", # The resource name of the book.
|
|
# Book names have the form `shelves/{shelf_id}/books/{book_id}`.
|
|
# The name is ignored when creating a book.
|
|
"author": "A String", # The name of the book author.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
|
|
<pre>Lists books in a shelf. The order is unspecified but deterministic. Newly
|
|
created books will not necessarily be added to the end of this list.
|
|
Returns NOT_FOUND if the shelf does not exist.
|
|
|
|
Args:
|
|
parent: string, The name of the shelf whose books we'd like to list. (required)
|
|
pageToken: string, A token identifying a page of results the server should return.
|
|
Typically, this is the value of
|
|
ListBooksResponse.next_page_token.
|
|
returned from the previous call to `ListBooks` method.
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
pageSize: integer, Requested page size. Server may return fewer books than requested.
|
|
If unspecified, server will pick an appropriate default.
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # Response message for LibraryAgent.ListBooks.
|
|
"nextPageToken": "A String", # A token to retrieve next page of results.
|
|
# Pass this value in the
|
|
# ListBooksRequest.page_token
|
|
# field in the subsequent call to `ListBooks` method to retrieve the next
|
|
# page of results.
|
|
"books": [ # The list of books.
|
|
{ # A single book in the library.
|
|
"read": True or False, # Value indicating whether the book has been read.
|
|
"title": "A String", # The title of the book.
|
|
"name": "A String", # The resource name of the book.
|
|
# Book names have the form `shelves/{shelf_id}/books/{book_id}`.
|
|
# The name is ignored when creating a book.
|
|
"author": "A String", # The name of the book author.
|
|
},
|
|
],
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
|
|
<pre>Retrieves the next page of results.
|
|
|
|
Args:
|
|
previous_request: The request for the previous page. (required)
|
|
previous_response: The response from the request for the previous page. (required)
|
|
|
|
Returns:
|
|
A request object that you can call 'execute()' on to request the next
|
|
page. Returns None if there are no more items in the collection.
|
|
</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="return_">return_(name, x__xgafv=None)</code>
|
|
<pre>Return a book to the library. Returns the book if it is returned to the
|
|
library successfully.
|
|
Returns error if the book does not belong to the library
|
|
or the users didn't borrow before.
|
|
|
|
Args:
|
|
name: string, The name of the book to return. (required)
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # A single book in the library.
|
|
"read": True or False, # Value indicating whether the book has been read.
|
|
"title": "A String", # The title of the book.
|
|
"name": "A String", # The resource name of the book.
|
|
# Book names have the form `shelves/{shelf_id}/books/{book_id}`.
|
|
# The name is ignored when creating a book.
|
|
"author": "A String", # The name of the book author.
|
|
}</pre>
|
|
</div>
|
|
|
|
</body></html> |