| |
| <!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-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Moves a topic of the community to the trash folder.<br> |
| <br> |
| Args:<br> |
| topicId: string, The ID of the topic to be moved to the trash folder. (required)<br> |
| communityId: integer, The ID of the community whose topic will be moved to the trash folder. (required)</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves a topic of a community.<br> |
| <br> |
| Args:<br> |
| topicId: string, The ID of the topic to get. (required)<br> |
| hl: string, Specifies the interface language (host language) of your user interface.<br> |
| communityId: integer, The ID of the community whose topic will be retrieved. (required)<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "body": "A String", # The body of the topic.<br> |
| "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> |
| "kind": "orkut#communityTopic", # Identifies this resource as a community topic. Value: "orkut#communityTopic"<br> |
| "links": [ # List of resources for the community.<br> |
| { # Links to resources related to the parent object.<br> |
| "href": "A String", # URL of the link.<br> |
| "type": "A String", # Media type of the link.<br> |
| "rel": "A String", # Relation between the resource and the parent object.<br> |
| "title": "A String", # Title of the link.<br> |
| },<br> |
| ],<br> |
| "author": { # The creator of the topic.<br> |
| "url": "A String", # The URL of the author who posted the comment [not yet implemented]<br> |
| "image": { # Image data about the actor.<br> |
| "url": "A String", # A URL that points to a thumbnail photo of the author.<br> |
| },<br> |
| "displayName": "A String", # The name of the author, suitable for display.<br> |
| "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.<br> |
| },<br> |
| "title": "A String", # The title of the topic.<br> |
| "messages": [ # Most recent messages.<br> |
| {<br> |
| "body": "A String", # The body of the message.<br> |
| "kind": "orkut#communityMessage", # Identifies this resource as a community message. Value: "orkut#communityMessage"<br> |
| "links": [ # List of resources for the community message.<br> |
| { # Links to resources related to the parent object.<br> |
| "href": "A String", # URL of the link.<br> |
| "type": "A String", # Media type of the link.<br> |
| "rel": "A String", # Relation between the resource and the parent object.<br> |
| "title": "A String", # Title of the link.<br> |
| },<br> |
| ],<br> |
| "author": { # The creator of the message. If ommited, the message is annonimous.<br> |
| "url": "A String", # The URL of the author who posted the comment [not yet implemented]<br> |
| "image": { # Image data about the actor.<br> |
| "url": "A String", # A URL that points to a thumbnail photo of the author.<br> |
| },<br> |
| "displayName": "A String", # The name of the author, suitable for display.<br> |
| "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.<br> |
| },<br> |
| "id": "A String", # The ID of the message.<br> |
| "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> |
| "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> |
| "subject": "A String", # The subject of the message.<br> |
| },<br> |
| ],<br> |
| "latestMessageSnippet": "A String", # Snippet of the last message posted on this topic.<br> |
| "isClosed": True or False, # Whether the topic is closed for new messages.<br> |
| "numberOfReplies": 42, # The total number of replies this topic has received.<br> |
| "id": "A String", # The ID of the topic.<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Adds a topic to a given community.<br> |
| <br> |
| Args:<br> |
| body: object, The request body. (required)<br> |
| The object takes the form of:<br> |
| <br> |
| {<br> |
| "body": "A String", # The body of the topic.<br> |
| "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> |
| "kind": "orkut#communityTopic", # Identifies this resource as a community topic. Value: "orkut#communityTopic"<br> |
| "links": [ # List of resources for the community.<br> |
| { # Links to resources related to the parent object.<br> |
| "href": "A String", # URL of the link.<br> |
| "type": "A String", # Media type of the link.<br> |
| "rel": "A String", # Relation between the resource and the parent object.<br> |
| "title": "A String", # Title of the link.<br> |
| },<br> |
| ],<br> |
| "author": { # The creator of the topic.<br> |
| "url": "A String", # The URL of the author who posted the comment [not yet implemented]<br> |
| "image": { # Image data about the actor.<br> |
| "url": "A String", # A URL that points to a thumbnail photo of the author.<br> |
| },<br> |
| "displayName": "A String", # The name of the author, suitable for display.<br> |
| "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.<br> |
| },<br> |
| "title": "A String", # The title of the topic.<br> |
| "messages": [ # Most recent messages.<br> |
| {<br> |
| "body": "A String", # The body of the message.<br> |
| "kind": "orkut#communityMessage", # Identifies this resource as a community message. Value: "orkut#communityMessage"<br> |
| "links": [ # List of resources for the community message.<br> |
| { # Links to resources related to the parent object.<br> |
| "href": "A String", # URL of the link.<br> |
| "type": "A String", # Media type of the link.<br> |
| "rel": "A String", # Relation between the resource and the parent object.<br> |
| "title": "A String", # Title of the link.<br> |
| },<br> |
| ],<br> |
| "author": { # The creator of the message. If ommited, the message is annonimous.<br> |
| "url": "A String", # The URL of the author who posted the comment [not yet implemented]<br> |
| "image": { # Image data about the actor.<br> |
| "url": "A String", # A URL that points to a thumbnail photo of the author.<br> |
| },<br> |
| "displayName": "A String", # The name of the author, suitable for display.<br> |
| "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.<br> |
| },<br> |
| "id": "A String", # The ID of the message.<br> |
| "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> |
| "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> |
| "subject": "A String", # The subject of the message.<br> |
| },<br> |
| ],<br> |
| "latestMessageSnippet": "A String", # Snippet of the last message posted on this topic.<br> |
| "isClosed": True or False, # Whether the topic is closed for new messages.<br> |
| "numberOfReplies": 42, # The total number of replies this topic has received.<br> |
| "id": "A String", # The ID of the topic.<br> |
| }<br> |
| <br> |
| isShout: boolean, Whether this topic is a shout.<br> |
| communityId: integer, The ID of the community the topic should be added to. (required)<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "body": "A String", # The body of the topic.<br> |
| "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> |
| "kind": "orkut#communityTopic", # Identifies this resource as a community topic. Value: "orkut#communityTopic"<br> |
| "links": [ # List of resources for the community.<br> |
| { # Links to resources related to the parent object.<br> |
| "href": "A String", # URL of the link.<br> |
| "type": "A String", # Media type of the link.<br> |
| "rel": "A String", # Relation between the resource and the parent object.<br> |
| "title": "A String", # Title of the link.<br> |
| },<br> |
| ],<br> |
| "author": { # The creator of the topic.<br> |
| "url": "A String", # The URL of the author who posted the comment [not yet implemented]<br> |
| "image": { # Image data about the actor.<br> |
| "url": "A String", # A URL that points to a thumbnail photo of the author.<br> |
| },<br> |
| "displayName": "A String", # The name of the author, suitable for display.<br> |
| "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.<br> |
| },<br> |
| "title": "A String", # The title of the topic.<br> |
| "messages": [ # Most recent messages.<br> |
| {<br> |
| "body": "A String", # The body of the message.<br> |
| "kind": "orkut#communityMessage", # Identifies this resource as a community message. Value: "orkut#communityMessage"<br> |
| "links": [ # List of resources for the community message.<br> |
| { # Links to resources related to the parent object.<br> |
| "href": "A String", # URL of the link.<br> |
| "type": "A String", # Media type of the link.<br> |
| "rel": "A String", # Relation between the resource and the parent object.<br> |
| "title": "A String", # Title of the link.<br> |
| },<br> |
| ],<br> |
| "author": { # The creator of the message. If ommited, the message is annonimous.<br> |
| "url": "A String", # The URL of the author who posted the comment [not yet implemented]<br> |
| "image": { # Image data about the actor.<br> |
| "url": "A String", # A URL that points to a thumbnail photo of the author.<br> |
| },<br> |
| "displayName": "A String", # The name of the author, suitable for display.<br> |
| "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.<br> |
| },<br> |
| "id": "A String", # The ID of the message.<br> |
| "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> |
| "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> |
| "subject": "A String", # The subject of the message.<br> |
| },<br> |
| ],<br> |
| "latestMessageSnippet": "A String", # Snippet of the last message posted on this topic.<br> |
| "isClosed": True or False, # Whether the topic is closed for new messages.<br> |
| "numberOfReplies": 42, # The total number of replies this topic has received.<br> |
| "id": "A String", # The ID of the topic.<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves the topics of a community.<br> |
| <br> |
| Args:<br> |
| pageToken: string, A continuation token that allows pagination.<br> |
| maxResults: integer, The maximum number of topics to include in the response.<br> |
| hl: string, Specifies the interface language (host language) of your user interface.<br> |
| communityId: integer, The ID of the community which topics will be listed. (required)<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "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> |
| "kind": "orkut#communityTopicList", # Identifies this resource as a collection of community topics. Value: "orkut#communityTopicList"<br> |
| "items": [ # List of topics retrieved.<br> |
| {<br> |
| "body": "A String", # The body of the topic.<br> |
| "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> |
| "kind": "orkut#communityTopic", # Identifies this resource as a community topic. Value: "orkut#communityTopic"<br> |
| "links": [ # List of resources for the community.<br> |
| { # Links to resources related to the parent object.<br> |
| "href": "A String", # URL of the link.<br> |
| "type": "A String", # Media type of the link.<br> |
| "rel": "A String", # Relation between the resource and the parent object.<br> |
| "title": "A String", # Title of the link.<br> |
| },<br> |
| ],<br> |
| "author": { # The creator of the topic.<br> |
| "url": "A String", # The URL of the author who posted the comment [not yet implemented]<br> |
| "image": { # Image data about the actor.<br> |
| "url": "A String", # A URL that points to a thumbnail photo of the author.<br> |
| },<br> |
| "displayName": "A String", # The name of the author, suitable for display.<br> |
| "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.<br> |
| },<br> |
| "title": "A String", # The title of the topic.<br> |
| "messages": [ # Most recent messages.<br> |
| {<br> |
| "body": "A String", # The body of the message.<br> |
| "kind": "orkut#communityMessage", # Identifies this resource as a community message. Value: "orkut#communityMessage"<br> |
| "links": [ # List of resources for the community message.<br> |
| { # Links to resources related to the parent object.<br> |
| "href": "A String", # URL of the link.<br> |
| "type": "A String", # Media type of the link.<br> |
| "rel": "A String", # Relation between the resource and the parent object.<br> |
| "title": "A String", # Title of the link.<br> |
| },<br> |
| ],<br> |
| "author": { # The creator of the message. If ommited, the message is annonimous.<br> |
| "url": "A String", # The URL of the author who posted the comment [not yet implemented]<br> |
| "image": { # Image data about the actor.<br> |
| "url": "A String", # A URL that points to a thumbnail photo of the author.<br> |
| },<br> |
| "displayName": "A String", # The name of the author, suitable for display.<br> |
| "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.<br> |
| },<br> |
| "id": "A String", # The ID of the message.<br> |
| "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> |
| "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> |
| "subject": "A String", # The subject of the message.<br> |
| },<br> |
| ],<br> |
| "latestMessageSnippet": "A String", # Snippet of the last message posted on this topic.<br> |
| "isClosed": True or False, # Whether the topic is closed for new messages.<br> |
| "numberOfReplies": 42, # The total number of replies this topic has received.<br> |
| "id": "A String", # The ID of the topic.<br> |
| },<br> |
| ],<br> |
| "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> |
| "lastPageToken": "A String", # The value of pageToken query parameter in community_topic.list request to get the last page.<br> |
| "firstPageToken": "A String", # The value of pageToken query parameter in community_topic.list request to get the first page.<br> |
| }</tt></dd></dl> |
| |
| <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> |
| <br> |
| Args:<br> |
| previous_request: The request for the previous page.<br> |
| previous_response: The response from the request for the previous page.<br> |
| <br> |
| Returns:<br> |
| A request object that you can call 'execute()' on to request the next<br> |
| page. Returns None if there are no more items in the collection.</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> |