65 lines
5.1 KiB
HTML
65 lines
5.1 KiB
HTML
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
<html><head><title>Python: class Resource</title>
|
|
</head><body bgcolor="#f0f0f8">
|
|
<p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%">Methods defined here:<br>
|
|
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
|
|
|
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves my reading position information for a volume.<br>
|
|
<br>
|
|
Args:<br>
|
|
source: string, String to identify the originator of this request.<br>
|
|
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
|
volumeId: string, Id of volume for which to retrieve a reading position. (required)<br>
|
|
contentVersion: string, Volume content version for which this reading position is requested.<br>
|
|
<br>
|
|
Returns:<br>
|
|
An object of the form<br>
|
|
<br>
|
|
{<br>
|
|
"kind": "books#readingPosition", # Resource type for a reading position.<br>
|
|
"gbImagePosition": "A String", # Position in a volume for image-based content.<br>
|
|
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.<br>
|
|
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).<br>
|
|
"volumeId": "A String", # Volume id associated with this reading position.<br>
|
|
"pdfPosition": "A String", # Position in a PDF file.<br>
|
|
"gbTextPosition": "A String", # Position in a volume for text-based content.<br>
|
|
}</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Resource-setPosition"><strong>setPosition</strong></a> = method(self, **kwargs)</dt><dd><tt>Sets my reading position information for a volume.<br>
|
|
<br>
|
|
Args:<br>
|
|
source: string, String to identify the originator of this request.<br>
|
|
volumeId: string, Id of volume for which to update the reading position. (required)<br>
|
|
contentVersion: string, Volume content version for which this reading position applies.<br>
|
|
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
|
position: string, Position string for the new volume reading position. (required)<br>
|
|
timestamp: string, <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> UTC format timestamp associated with this reading position. (required)<br>
|
|
action: string, Action that caused this reading position to be set.<br>
|
|
Allowed values<br>
|
|
bookmark - User chose bookmark within volume.<br>
|
|
chapter - User selected chapter from list.<br>
|
|
next-page - Next page event.<br>
|
|
prev-page - Previous page event.<br>
|
|
scroll - User navigated to page.<br>
|
|
search - User chose search results within volume.</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors defined here:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
</td></tr></table>
|
|
</body></html> |