Home | History | Annotate | Download | only in dyn 
      1 <html><body>
      2 <style>
      3 
      4 body, 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 
     15 body {
     16   font-size: 13px;
     17   padding: 1em;
     18 }
     19 
     20 h1 {
     21   font-size: 26px;
     22   margin-bottom: 1em;
     23 }
     24 
     25 h2 {
     26   font-size: 24px;
     27   margin-bottom: 1em;
     28 }
     29 
     30 h3 {
     31   font-size: 20px;
     32   margin-bottom: 1em;
     33   margin-top: 1em;
     34 }
     35 
     36 pre, code {
     37   line-height: 1.5;
     38   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
     39 }
     40 
     41 pre {
     42   margin-top: 0.5em;
     43 }
     44 
     45 h1, h2, h3, p {
     46   font-family: Arial, sans serif;
     47 }
     48 
     49 h1, 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">
     78   <code><a href="#get">get(volumeId, source=None, contentVersion=None)</a></code></p>
     79 <p class="firstline">Retrieves my reading position information for a volume.</p>
     80 <p class="toc_element">
     81   <code><a href="#setPosition">setPosition(volumeId, timestamp, position, deviceCookie=None, source=None, contentVersion=None, action=None)</a></code></p>
     82 <p class="firstline">Sets my reading position information for a volume.</p>
     83 <h3>Method Details</h3>
     84 <div class="method">
     85     <code class="details" id="get">get(volumeId, source=None, contentVersion=None)</code>
     86   <pre>Retrieves my reading position information for a volume.
     87 
     88 Args:
     89   volumeId: string, ID of volume for which to retrieve a reading position. (required)
     90   source: string, String to identify the originator of this request.
     91   contentVersion: string, Volume content version for which this reading position is requested.
     92 
     93 Returns:
     94   An object of the form:
     95 
     96     {
     97     "kind": "books#readingPosition", # Resource type for a reading position.
     98     "gbImagePosition": "A String", # Position in a volume for image-based content.
     99     "epubCfiPosition": "A String", # Position in an EPUB as a CFI.
    100     "updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
    101     "volumeId": "A String", # Volume id associated with this reading position.
    102     "pdfPosition": "A String", # Position in a PDF file.
    103     "gbTextPosition": "A String", # Position in a volume for text-based content.
    104   }</pre>
    105 </div>
    106 
    107 <div class="method">
    108     <code class="details" id="setPosition">setPosition(volumeId, timestamp, position, deviceCookie=None, source=None, contentVersion=None, action=None)</code>
    109   <pre>Sets my reading position information for a volume.
    110 
    111 Args:
    112   volumeId: string, ID of volume for which to update the reading position. (required)
    113   timestamp: string, RFC 3339 UTC format timestamp associated with this reading position. (required)
    114   position: string, Position string for the new volume reading position. (required)
    115   deviceCookie: string, Random persistent device cookie optional on set position.
    116   source: string, String to identify the originator of this request.
    117   contentVersion: string, Volume content version for which this reading position applies.
    118   action: string, Action that caused this reading position to be set.
    119     Allowed values
    120       bookmark - User chose bookmark within volume.
    121       chapter - User selected chapter from list.
    122       next-page - Next page event.
    123       prev-page - Previous page event.
    124       scroll - User navigated to page.
    125       search - User chose search results within volume.
    126 </pre>
    127 </div>
    128 
    129 </body></html>