| Joe Gregorio | 945cca1 | 2012-02-21 11:59:48 -0500 | [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-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Moves a topic of the community to the trash folder.<br> |
| 18 | <br> |
| 19 | Args:<br> |
| 20 | topicId: string, The ID of the topic to be moved to the trash folder. (required)<br> |
| 21 | communityId: integer, The ID of the community whose topic will be moved to the trash folder. (required)</tt></dd></dl> |
| 22 | |
| 23 | <dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves a topic of a community.<br> |
| 24 | <br> |
| 25 | Args:<br> |
| 26 | topicId: string, The ID of the topic to get. (required)<br> |
| 27 | hl: string, Specifies the interface language (host language) of your user interface.<br> |
| 28 | communityId: integer, The ID of the community whose topic will be retrieved. (required)<br> |
| 29 | <br> |
| 30 | Returns:<br> |
| 31 | An object of the form<br> |
| 32 | <br> |
| 33 | {<br> |
| 34 | "body": "A String", # The body of the topic.<br> |
| 35 | "lastUpdate": "A String", # The timestamp of the last update, in <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> format.<br> |
| 36 | "kind": "orkut#communityTopic", # Identifies this resource as a community topic. Value: "orkut#communityTopic"<br> |
| 37 | "links": [ # List of resources for the community.<br> |
| 38 | { # Links to resources related to the parent object.<br> |
| 39 | "href": "A String", # URL of the link.<br> |
| 40 | "type": "A String", # Media type of the link.<br> |
| 41 | "rel": "A String", # Relation between the resource and the parent object.<br> |
| 42 | "title": "A String", # Title of the link.<br> |
| 43 | },<br> |
| 44 | ],<br> |
| 45 | "author": { # The creator of the topic.<br> |
| 46 | "url": "A String", # The URL of the author who posted the comment [not yet implemented]<br> |
| 47 | "image": { # Image data about the actor.<br> |
| 48 | "url": "A String", # A URL that points to a thumbnail photo of the author.<br> |
| 49 | },<br> |
| 50 | "displayName": "A String", # The name of the author, suitable for display.<br> |
| 51 | "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.<br> |
| 52 | },<br> |
| 53 | "title": "A String", # The title of the topic.<br> |
| 54 | "messages": [ # Most recent messages.<br> |
| 55 | {<br> |
| 56 | "body": "A String", # The body of the message.<br> |
| 57 | "kind": "orkut#communityMessage", # Identifies this resource as a community message. Value: "orkut#communityMessage"<br> |
| 58 | "links": [ # List of resources for the community message.<br> |
| 59 | { # Links to resources related to the parent object.<br> |
| 60 | "href": "A String", # URL of the link.<br> |
| 61 | "type": "A String", # Media type of the link.<br> |
| 62 | "rel": "A String", # Relation between the resource and the parent object.<br> |
| 63 | "title": "A String", # Title of the link.<br> |
| 64 | },<br> |
| 65 | ],<br> |
| 66 | "author": { # The creator of the message. If ommited, the message is annonimous.<br> |
| 67 | "url": "A String", # The URL of the author who posted the comment [not yet implemented]<br> |
| 68 | "image": { # Image data about the actor.<br> |
| 69 | "url": "A String", # A URL that points to a thumbnail photo of the author.<br> |
| 70 | },<br> |
| 71 | "displayName": "A String", # The name of the author, suitable for display.<br> |
| 72 | "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.<br> |
| 73 | },<br> |
| 74 | "id": "A String", # The ID of the message.<br> |
| 75 | "addedDate": "A String", # The timestamp of the date when the message was added, in <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> format.<br> |
| 76 | "isSpam": True or False, # Whether this post was marked as spam by the viewer, when he/she is not the community owner or one of its moderators.<br> |
| 77 | "subject": "A String", # The subject of the message.<br> |
| 78 | },<br> |
| 79 | ],<br> |
| 80 | "latestMessageSnippet": "A String", # Snippet of the last message posted on this topic.<br> |
| 81 | "isClosed": True or False, # Whether the topic is closed for new messages.<br> |
| 82 | "numberOfReplies": 42, # The total number of replies this topic has received.<br> |
| 83 | "id": "A String", # The ID of the topic.<br> |
| 84 | }</tt></dd></dl> |
| 85 | |
| 86 | <dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Adds a topic to a given community.<br> |
| 87 | <br> |
| 88 | Args:<br> |
| 89 | body: object, The request body. (required)<br> |
| 90 | The object takes the form of:<br> |
| 91 | <br> |
| 92 | {<br> |
| 93 | "body": "A String", # The body of the topic.<br> |
| 94 | "lastUpdate": "A String", # The timestamp of the last update, in <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> format.<br> |
| 95 | "kind": "orkut#communityTopic", # Identifies this resource as a community topic. Value: "orkut#communityTopic"<br> |
| 96 | "links": [ # List of resources for the community.<br> |
| 97 | { # Links to resources related to the parent object.<br> |
| 98 | "href": "A String", # URL of the link.<br> |
| 99 | "type": "A String", # Media type of the link.<br> |
| 100 | "rel": "A String", # Relation between the resource and the parent object.<br> |
| 101 | "title": "A String", # Title of the link.<br> |
| 102 | },<br> |
| 103 | ],<br> |
| 104 | "author": { # The creator of the topic.<br> |
| 105 | "url": "A String", # The URL of the author who posted the comment [not yet implemented]<br> |
| 106 | "image": { # Image data about the actor.<br> |
| 107 | "url": "A String", # A URL that points to a thumbnail photo of the author.<br> |
| 108 | },<br> |
| 109 | "displayName": "A String", # The name of the author, suitable for display.<br> |
| 110 | "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.<br> |
| 111 | },<br> |
| 112 | "title": "A String", # The title of the topic.<br> |
| 113 | "messages": [ # Most recent messages.<br> |
| 114 | {<br> |
| 115 | "body": "A String", # The body of the message.<br> |
| 116 | "kind": "orkut#communityMessage", # Identifies this resource as a community message. Value: "orkut#communityMessage"<br> |
| 117 | "links": [ # List of resources for the community message.<br> |
| 118 | { # Links to resources related to the parent object.<br> |
| 119 | "href": "A String", # URL of the link.<br> |
| 120 | "type": "A String", # Media type of the link.<br> |
| 121 | "rel": "A String", # Relation between the resource and the parent object.<br> |
| 122 | "title": "A String", # Title of the link.<br> |
| 123 | },<br> |
| 124 | ],<br> |
| 125 | "author": { # The creator of the message. If ommited, the message is annonimous.<br> |
| 126 | "url": "A String", # The URL of the author who posted the comment [not yet implemented]<br> |
| 127 | "image": { # Image data about the actor.<br> |
| 128 | "url": "A String", # A URL that points to a thumbnail photo of the author.<br> |
| 129 | },<br> |
| 130 | "displayName": "A String", # The name of the author, suitable for display.<br> |
| 131 | "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.<br> |
| 132 | },<br> |
| 133 | "id": "A String", # The ID of the message.<br> |
| 134 | "addedDate": "A String", # The timestamp of the date when the message was added, in <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> format.<br> |
| 135 | "isSpam": True or False, # Whether this post was marked as spam by the viewer, when he/she is not the community owner or one of its moderators.<br> |
| 136 | "subject": "A String", # The subject of the message.<br> |
| 137 | },<br> |
| 138 | ],<br> |
| 139 | "latestMessageSnippet": "A String", # Snippet of the last message posted on this topic.<br> |
| 140 | "isClosed": True or False, # Whether the topic is closed for new messages.<br> |
| 141 | "numberOfReplies": 42, # The total number of replies this topic has received.<br> |
| 142 | "id": "A String", # The ID of the topic.<br> |
| 143 | }<br> |
| 144 | <br> |
| 145 | isShout: boolean, Whether this topic is a shout.<br> |
| 146 | communityId: integer, The ID of the community the topic should be added to. (required)<br> |
| 147 | <br> |
| 148 | Returns:<br> |
| 149 | An object of the form<br> |
| 150 | <br> |
| 151 | {<br> |
| 152 | "body": "A String", # The body of the topic.<br> |
| 153 | "lastUpdate": "A String", # The timestamp of the last update, in <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> format.<br> |
| 154 | "kind": "orkut#communityTopic", # Identifies this resource as a community topic. Value: "orkut#communityTopic"<br> |
| 155 | "links": [ # List of resources for the community.<br> |
| 156 | { # Links to resources related to the parent object.<br> |
| 157 | "href": "A String", # URL of the link.<br> |
| 158 | "type": "A String", # Media type of the link.<br> |
| 159 | "rel": "A String", # Relation between the resource and the parent object.<br> |
| 160 | "title": "A String", # Title of the link.<br> |
| 161 | },<br> |
| 162 | ],<br> |
| 163 | "author": { # The creator of the topic.<br> |
| 164 | "url": "A String", # The URL of the author who posted the comment [not yet implemented]<br> |
| 165 | "image": { # Image data about the actor.<br> |
| 166 | "url": "A String", # A URL that points to a thumbnail photo of the author.<br> |
| 167 | },<br> |
| 168 | "displayName": "A String", # The name of the author, suitable for display.<br> |
| 169 | "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.<br> |
| 170 | },<br> |
| 171 | "title": "A String", # The title of the topic.<br> |
| 172 | "messages": [ # Most recent messages.<br> |
| 173 | {<br> |
| 174 | "body": "A String", # The body of the message.<br> |
| 175 | "kind": "orkut#communityMessage", # Identifies this resource as a community message. Value: "orkut#communityMessage"<br> |
| 176 | "links": [ # List of resources for the community message.<br> |
| 177 | { # Links to resources related to the parent object.<br> |
| 178 | "href": "A String", # URL of the link.<br> |
| 179 | "type": "A String", # Media type of the link.<br> |
| 180 | "rel": "A String", # Relation between the resource and the parent object.<br> |
| 181 | "title": "A String", # Title of the link.<br> |
| 182 | },<br> |
| 183 | ],<br> |
| 184 | "author": { # The creator of the message. If ommited, the message is annonimous.<br> |
| 185 | "url": "A String", # The URL of the author who posted the comment [not yet implemented]<br> |
| 186 | "image": { # Image data about the actor.<br> |
| 187 | "url": "A String", # A URL that points to a thumbnail photo of the author.<br> |
| 188 | },<br> |
| 189 | "displayName": "A String", # The name of the author, suitable for display.<br> |
| 190 | "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.<br> |
| 191 | },<br> |
| 192 | "id": "A String", # The ID of the message.<br> |
| 193 | "addedDate": "A String", # The timestamp of the date when the message was added, in <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> format.<br> |
| 194 | "isSpam": True or False, # Whether this post was marked as spam by the viewer, when he/she is not the community owner or one of its moderators.<br> |
| 195 | "subject": "A String", # The subject of the message.<br> |
| 196 | },<br> |
| 197 | ],<br> |
| 198 | "latestMessageSnippet": "A String", # Snippet of the last message posted on this topic.<br> |
| 199 | "isClosed": True or False, # Whether the topic is closed for new messages.<br> |
| 200 | "numberOfReplies": 42, # The total number of replies this topic has received.<br> |
| 201 | "id": "A String", # The ID of the topic.<br> |
| 202 | }</tt></dd></dl> |
| 203 | |
| 204 | <dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves the topics of a community.<br> |
| 205 | <br> |
| 206 | Args:<br> |
| 207 | pageToken: string, A continuation token that allows pagination.<br> |
| 208 | maxResults: integer, The maximum number of topics to include in the response.<br> |
| 209 | hl: string, Specifies the interface language (host language) of your user interface.<br> |
| 210 | communityId: integer, The ID of the community which topics will be listed. (required)<br> |
| 211 | <br> |
| 212 | Returns:<br> |
| 213 | An object of the form<br> |
| 214 | <br> |
| 215 | {<br> |
| 216 | "nextPageToken": "A String", # The value of pageToken query parameter in community_topic.list request to get the next page, if there are more to retrieve.<br> |
| 217 | "kind": "orkut#communityTopicList", # Identifies this resource as a collection of community topics. Value: "orkut#communityTopicList"<br> |
| 218 | "items": [ # List of topics retrieved.<br> |
| 219 | {<br> |
| 220 | "body": "A String", # The body of the topic.<br> |
| 221 | "lastUpdate": "A String", # The timestamp of the last update, in <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> format.<br> |
| 222 | "kind": "orkut#communityTopic", # Identifies this resource as a community topic. Value: "orkut#communityTopic"<br> |
| 223 | "links": [ # List of resources for the community.<br> |
| 224 | { # Links to resources related to the parent object.<br> |
| 225 | "href": "A String", # URL of the link.<br> |
| 226 | "type": "A String", # Media type of the link.<br> |
| 227 | "rel": "A String", # Relation between the resource and the parent object.<br> |
| 228 | "title": "A String", # Title of the link.<br> |
| 229 | },<br> |
| 230 | ],<br> |
| 231 | "author": { # The creator of the topic.<br> |
| 232 | "url": "A String", # The URL of the author who posted the comment [not yet implemented]<br> |
| 233 | "image": { # Image data about the actor.<br> |
| 234 | "url": "A String", # A URL that points to a thumbnail photo of the author.<br> |
| 235 | },<br> |
| 236 | "displayName": "A String", # The name of the author, suitable for display.<br> |
| 237 | "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.<br> |
| 238 | },<br> |
| 239 | "title": "A String", # The title of the topic.<br> |
| 240 | "messages": [ # Most recent messages.<br> |
| 241 | {<br> |
| 242 | "body": "A String", # The body of the message.<br> |
| 243 | "kind": "orkut#communityMessage", # Identifies this resource as a community message. Value: "orkut#communityMessage"<br> |
| 244 | "links": [ # List of resources for the community message.<br> |
| 245 | { # Links to resources related to the parent object.<br> |
| 246 | "href": "A String", # URL of the link.<br> |
| 247 | "type": "A String", # Media type of the link.<br> |
| 248 | "rel": "A String", # Relation between the resource and the parent object.<br> |
| 249 | "title": "A String", # Title of the link.<br> |
| 250 | },<br> |
| 251 | ],<br> |
| 252 | "author": { # The creator of the message. If ommited, the message is annonimous.<br> |
| 253 | "url": "A String", # The URL of the author who posted the comment [not yet implemented]<br> |
| 254 | "image": { # Image data about the actor.<br> |
| 255 | "url": "A String", # A URL that points to a thumbnail photo of the author.<br> |
| 256 | },<br> |
| 257 | "displayName": "A String", # The name of the author, suitable for display.<br> |
| 258 | "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.<br> |
| 259 | },<br> |
| 260 | "id": "A String", # The ID of the message.<br> |
| 261 | "addedDate": "A String", # The timestamp of the date when the message was added, in <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> format.<br> |
| 262 | "isSpam": True or False, # Whether this post was marked as spam by the viewer, when he/she is not the community owner or one of its moderators.<br> |
| 263 | "subject": "A String", # The subject of the message.<br> |
| 264 | },<br> |
| 265 | ],<br> |
| 266 | "latestMessageSnippet": "A String", # Snippet of the last message posted on this topic.<br> |
| 267 | "isClosed": True or False, # Whether the topic is closed for new messages.<br> |
| 268 | "numberOfReplies": 42, # The total number of replies this topic has received.<br> |
| 269 | "id": "A String", # The ID of the topic.<br> |
| 270 | },<br> |
| 271 | ],<br> |
| 272 | "prevPageToken": "A String", # The value of pageToken query parameter in community_topic.list request to get the previous page, if there are more to retrieve.<br> |
| 273 | "lastPageToken": "A String", # The value of pageToken query parameter in community_topic.list request to get the last page.<br> |
| 274 | "firstPageToken": "A String", # The value of pageToken query parameter in community_topic.list request to get the first page.<br> |
| 275 | }</tt></dd></dl> |
| 276 | |
| 277 | <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> |
| 278 | <br> |
| 279 | Args:<br> |
| 280 | previous_request: The request for the previous page.<br> |
| 281 | previous_response: The response from the request for the previous page.<br> |
| 282 | <br> |
| 283 | Returns:<br> |
| 284 | A request object that you can call 'execute()' on to request the next<br> |
| 285 | page. Returns None if there are no more items in the collection.</tt></dd></dl> |
| 286 | |
| 287 | <hr> |
| 288 | Data descriptors defined here:<br> |
| 289 | <dl><dt><strong>__dict__</strong></dt> |
| 290 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| 291 | </dl> |
| 292 | <dl><dt><strong>__weakref__</strong></dt> |
| 293 | <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| 294 | </dl> |
| 295 | </td></tr></table> |
| 296 | </body></html> |