Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame^] | 1 | |
| 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| 3 | <html><head><title>Python: class Resource</title> |
| 4 | </head><body bgcolor="#f0f0f8"> |
| 5 | <p> |
| 6 | <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| 7 | <tr bgcolor="#ffc8d8"> |
| 8 | <td colspan=3 valign=bottom> <br> |
| 9 | <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> |
| 10 | |
| 11 | <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| 12 | <td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr> |
| 13 | <tr><td> </td> |
| 14 | <td width="100%">Methods defined here:<br> |
| 15 | <dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl> |
| 16 | |
| 17 | <dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets the volume annotation.<br> |
| 18 | <br> |
| 19 | Args:<br> |
| 20 | pp: string, A parameter<br> |
| 21 | trace: string, A parameter<br> |
| 22 | source: string, String to identify the originator of this request.<br> |
| 23 | locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.<br> |
| 24 | annotationId: string, The ID of the volume annotation to retrieve. (required)<br> |
| 25 | volumeId: string, The volume to retrieve annotations for. (required)<br> |
| 26 | strict: string, A parameter<br> |
| 27 | layerId: string, The ID for the layer to get the annotations. (required)<br> |
| 28 | userip: string, A parameter<br> |
| 29 | <br> |
| 30 | Returns:<br> |
| 31 | An object of the form<br> |
| 32 | <br> |
| 33 | {<br> |
| 34 | "annotationType": "A String", # The type of annotation this is.<br> |
| 35 | "kind": "books#volumeannotation", # Resource Type<br> |
| 36 | "updated": "A String", # Timestamp for the last time this anntoation was updated. (<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> UTC date-time format).<br> |
| 37 | "deleted": True or False, # Indicates that this annotation is deleted.<br> |
| 38 | "contentRanges": { # The content ranges to identify the selected text.<br> |
| 39 | "contentVersion": "A String", # Content version applicable to ranges below.<br> |
| 40 | "gbTextRange": { # Range in GB text format for this annotation for version above.<br> |
| 41 | "startPosition": "A String", # The starting position for the range.<br> |
| 42 | "endPosition": "A String", # The ending position for the range.<br> |
| 43 | "startOffset": "A String", # The offset from the starting position.<br> |
| 44 | "endOffset": "A String", # The offset from the ending position.<br> |
| 45 | },<br> |
| 46 | "cfiRange": { # Range in CFI format for this annotation for version above.<br> |
| 47 | "startPosition": "A String", # The starting position for the range.<br> |
| 48 | "endPosition": "A String", # The ending position for the range.<br> |
| 49 | "startOffset": "A String", # The offset from the starting position.<br> |
| 50 | "endOffset": "A String", # The offset from the ending position.<br> |
| 51 | },<br> |
| 52 | "gbImageRange": { # Range in GB image format for this annotation for version above.<br> |
| 53 | "startPosition": "A String", # The starting position for the range.<br> |
| 54 | "endPosition": "A String", # The ending position for the range.<br> |
| 55 | "startOffset": "A String", # The offset from the starting position.<br> |
| 56 | "endOffset": "A String", # The offset from the ending position.<br> |
| 57 | },<br> |
| 58 | },<br> |
| 59 | "selectedText": "A String", # Excerpt from the volume.<br> |
| 60 | "volumeId": "A String", # The Volume this annotation is for.<br> |
| 61 | "annotationDataId": "A String", # The annotation data id for this volume annotation.<br> |
| 62 | "annotationDataLink": "A String", # Link to get data for this annotation.<br> |
| 63 | "pageIds": [ # Pages the annotation spans.<br> |
| 64 | "A String",<br> |
| 65 | ],<br> |
| 66 | "layerId": "A String", # The Layer this annotation is for.<br> |
| 67 | "data": "A String", # Data for this annotation.<br> |
| 68 | "id": "A String", # Unique id of this volume annotation.<br> |
| 69 | "selfLink": "A String", # URL to this resource.<br> |
| 70 | }</tt></dd></dl> |
| 71 | |
| 72 | <dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets the volume annotations for a volume and layer.<br> |
| 73 | <br> |
| 74 | Args:<br> |
| 75 | endPosition: string, The end position to end retrieving data from.<br> |
| 76 | locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.<br> |
| 77 | startOffset: string, The start offset to start retrieving data from.<br> |
| 78 | pp: string, A parameter<br> |
| 79 | trace: string, A parameter<br> |
| 80 | pageToken: string, The value of the nextToken from the previous page.<br> |
| 81 | updatedMin: string, <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp to restrict to items updated since this timestamp (inclusive).<br> |
| 82 | endOffset: string, The end offset to end retrieving data from.<br> |
| 83 | showDeleted: boolean, Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.<br> |
| 84 | contentVersion: string, The content version for the requested volume. (required)<br> |
| 85 | layerId: string, The ID for the layer to get the annotations. (required)<br> |
| 86 | strict: string, A parameter<br> |
| 87 | updatedMax: string, <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp to restrict to items updated prior to this timestamp (exclusive).<br> |
| 88 | volumeId: string, The volume to retrieve annotations for. (required)<br> |
| 89 | maxResults: integer, Maximum number of results to return<br> |
| 90 | startPosition: string, The start position to start retrieving data from.<br> |
| 91 | source: string, String to identify the originator of this request.<br> |
| 92 | userip: string, A parameter<br> |
| 93 | <br> |
| 94 | Returns:<br> |
| 95 | An object of the form<br> |
| 96 | <br> |
| 97 | {<br> |
| 98 | "nextPageToken": "A String", # Token to pass in for pagination for the next page. This will not be present if this request does not have more results.<br> |
| 99 | "items": [ # A list of volume annotations.<br> |
| 100 | {<br> |
| 101 | "annotationType": "A String", # The type of annotation this is.<br> |
| 102 | "kind": "books#volumeannotation", # Resource Type<br> |
| 103 | "updated": "A String", # Timestamp for the last time this anntoation was updated. (<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> UTC date-time format).<br> |
| 104 | "deleted": True or False, # Indicates that this annotation is deleted.<br> |
| 105 | "contentRanges": { # The content ranges to identify the selected text.<br> |
| 106 | "contentVersion": "A String", # Content version applicable to ranges below.<br> |
| 107 | "gbTextRange": { # Range in GB text format for this annotation for version above.<br> |
| 108 | "startPosition": "A String", # The starting position for the range.<br> |
| 109 | "endPosition": "A String", # The ending position for the range.<br> |
| 110 | "startOffset": "A String", # The offset from the starting position.<br> |
| 111 | "endOffset": "A String", # The offset from the ending position.<br> |
| 112 | },<br> |
| 113 | "cfiRange": { # Range in CFI format for this annotation for version above.<br> |
| 114 | "startPosition": "A String", # The starting position for the range.<br> |
| 115 | "endPosition": "A String", # The ending position for the range.<br> |
| 116 | "startOffset": "A String", # The offset from the starting position.<br> |
| 117 | "endOffset": "A String", # The offset from the ending position.<br> |
| 118 | },<br> |
| 119 | "gbImageRange": { # Range in GB image format for this annotation for version above.<br> |
| 120 | "startPosition": "A String", # The starting position for the range.<br> |
| 121 | "endPosition": "A String", # The ending position for the range.<br> |
| 122 | "startOffset": "A String", # The offset from the starting position.<br> |
| 123 | "endOffset": "A String", # The offset from the ending position.<br> |
| 124 | },<br> |
| 125 | },<br> |
| 126 | "selectedText": "A String", # Excerpt from the volume.<br> |
| 127 | "volumeId": "A String", # The Volume this annotation is for.<br> |
| 128 | "annotationDataId": "A String", # The annotation data id for this volume annotation.<br> |
| 129 | "annotationDataLink": "A String", # Link to get data for this annotation.<br> |
| 130 | "pageIds": [ # Pages the annotation spans.<br> |
| 131 | "A String",<br> |
| 132 | ],<br> |
| 133 | "layerId": "A String", # The Layer this annotation is for.<br> |
| 134 | "data": "A String", # Data for this annotation.<br> |
| 135 | "id": "A String", # Unique id of this volume annotation.<br> |
| 136 | "selfLink": "A String", # URL to this resource.<br> |
| 137 | },<br> |
| 138 | ],<br> |
| 139 | "kind": "books#volumeannotations", # Resource type<br> |
| 140 | "totalItems": 42, # The total number of volume annotations found.<br> |
| 141 | }</tt></dd></dl> |
| 142 | |
| 143 | <dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br> |
| 144 | <br> |
| 145 | Args:<br> |
| 146 | previous_request: The request for the previous page.<br> |
| 147 | previous_response: The response from the request for the previous page.<br> |
| 148 | <br> |
| 149 | Returns:<br> |
| 150 | A request object that you can call 'execute()' on to request the next<br> |
| 151 | page. Returns None if there are no more items in the collection.</tt></dd></dl> |
| 152 | |
| 153 | <hr> |
| 154 | Data descriptors defined here:<br> |
| 155 | <dl><dt><strong>__dict__</strong></dt> |
| 156 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| 157 | </dl> |
| 158 | <dl><dt><strong>__weakref__</strong></dt> |
| 159 | <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| 160 | </dl> |
| 161 | </td></tr></table> |
| 162 | </body></html> |