Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d059ad881c7ae58c67931c48788d0bd7343ab16c / . / docs / dyn / books_v1.mylibrary.readingpositions.html
blob: b51af84e2009623fe0c3e28abe8238714594e667 [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.readingpositions.html">readingpositions</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]78 <code><a href="#get">get(volumeId, source=None, contentVersion=None, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]79<p class="firstline">Retrieves my reading position information for a volume.</p>
80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]81 <code><a href="#setPosition">setPosition(volumeId, position=None, contentVersion=None, timestamp=None, action=None, deviceCookie=None, source=None, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]82<p class="firstline">Sets my reading position information for a volume.</p>
83<h3>Method Details</h3>
84<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]85 <code class="details" id="get">get(volumeId, source=None, contentVersion=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]86 <pre>Retrieves my reading position information for a volume.
87
88Args:
89 volumeId: string, ID of volume for which to retrieve a reading position. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]90 source: string, String to identify the originator of this request.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]91 contentVersion: string, Volume content version for which this reading position is requested.
92 x__xgafv: string, V1 error format.
93 Allowed values
94 1 - v1 error format
95 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]96
97Returns:
98 An object of the form:
99
100 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]101 &quot;gbImagePosition&quot;: &quot;A String&quot;, # Position in a volume for image-based content.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]102 &quot;epubCfiPosition&quot;: &quot;A String&quot;, # Position in an EPUB as a CFI.
103 &quot;volumeId&quot;: &quot;A String&quot;, # Volume id associated with this reading position.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]104 &quot;gbTextPosition&quot;: &quot;A String&quot;, # Position in a volume for text-based content.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]105 &quot;pdfPosition&quot;: &quot;A String&quot;, # Position in a PDF file.
106 &quot;updated&quot;: &quot;A String&quot;, # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]107 &quot;kind&quot;: &quot;A String&quot;, # Resource type for a reading position.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]108 }</pre>
109</div>
110
111<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]112 <code class="details" id="setPosition">setPosition(volumeId, position=None, contentVersion=None, timestamp=None, action=None, deviceCookie=None, source=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]113 <pre>Sets my reading position information for a volume.
114
115Args:
116 volumeId: string, ID of volume for which to update the reading position. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]117 position: string, Position string for the new volume reading position.
118 contentVersion: string, Volume content version for which this reading position applies.
119 timestamp: string, RFC 3339 UTC format timestamp associated with this reading position.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]120 action: string, Action that caused this reading position to be set.
121 Allowed values
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]122 ACTION_UNDEFINED -
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]123 bookmark - User chose bookmark within volume.
124 chapter - User selected chapter from list.
125 next-page - Next page event.
126 prev-page - Previous page event.
127 scroll - User navigated to page.
128 search - User chose search results within volume.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]129 deviceCookie: string, Random persistent device cookie optional on set position.
130 source: string, String to identify the originator of this request.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]131 x__xgafv: string, V1 error format.
132 Allowed values
133 1 - v1 error format
134 2 - v2 error format
135
136Returns:
137 An object of the form:
138
139 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
140 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]141</div>
142
143</body></html>