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