File: books_v1.mylibrary.readingpositions.html

package info (click to toggle)
python-googleapi 2.186.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 553,432 kB
  • sloc: python: 11,087; javascript: 249; sh: 114; makefile: 59
file content (151 lines) | stat: -rw-r--r-- 4,808 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
<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="books_v1.html">Books API</a> . <a href="books_v1.mylibrary.html">mylibrary</a> . <a href="books_v1.mylibrary.readingpositions.html">readingpositions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#get">get(volumeId, contentVersion=None, source=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves my reading position information for a volume.</p>
<p class="toc_element">
  <code><a href="#setPosition">setPosition(volumeId, position, timestamp, action=None, contentVersion=None, deviceCookie=None, source=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sets my reading position information for a volume.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="get">get(volumeId, contentVersion=None, source=None, x__xgafv=None)</code>
  <pre>Retrieves my reading position information for a volume.

Args:
  volumeId: string, ID of volume for which to retrieve a reading position. (required)
  contentVersion: string, Volume content version for which this reading position is requested.
  source: string, String to identify the originator of this request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  &quot;epubCfiPosition&quot;: &quot;A String&quot;, # Position in an EPUB as a CFI.
  &quot;gbImagePosition&quot;: &quot;A String&quot;, # Position in a volume for image-based content.
  &quot;gbTextPosition&quot;: &quot;A String&quot;, # Position in a volume for text-based content.
  &quot;kind&quot;: &quot;A String&quot;, # Resource type for a reading position.
  &quot;pdfPosition&quot;: &quot;A String&quot;, # Position in a PDF file.
  &quot;updated&quot;: &quot;A String&quot;, # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
  &quot;volumeId&quot;: &quot;A String&quot;, # Volume id associated with this reading position.
}</pre>
</div>

<div class="method">
    <code class="details" id="setPosition">setPosition(volumeId, position, timestamp, action=None, contentVersion=None, deviceCookie=None, source=None, x__xgafv=None)</code>
  <pre>Sets my reading position information for a volume.

Args:
  volumeId: string, ID of volume for which to update the reading position. (required)
  position: string, Position string for the new volume reading position. (required)
  timestamp: string, RFC 3339 UTC format timestamp associated with this reading position. (required)
  action: string, Action that caused this reading position to be set.
    Allowed values
      ACTION_UNDEFINED - 
      bookmark - User chose bookmark within volume.
      chapter - User selected chapter from list.
      next-page - Next page event.
      prev-page - Previous page event.
      scroll - User navigated to page.
      search - User chose search results within volume.
  contentVersion: string, Volume content version for which this reading position applies.
  deviceCookie: string, Random persistent device cookie optional on set position.
  source: string, String to identify the originator of this request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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); }
}</pre>
</div>

</body></html>