1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="orkut_v2.html">Orkut API</a> . <a href="orkut_v2.communityTopics.html">communityTopics</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(communityId, topicId)</a></code></p>
<p class="firstline">Moves a topic of the community to the trash folder.</p>
<p class="toc_element">
<code><a href="#get">get(communityId, topicId, hl=None)</a></code></p>
<p class="firstline">Retrieves a topic of a community.</p>
<p class="toc_element">
<code><a href="#insert">insert(communityId, body, isShout=None)</a></code></p>
<p class="firstline">Adds a topic to a given community.</p>
<p class="toc_element">
<code><a href="#list">list(communityId, pageToken=None, hl=None, maxResults=None)</a></code></p>
<p class="firstline">Retrieves the topics of a community.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(communityId, topicId)</code>
<pre>Moves a topic of the community to the trash folder.
Args:
communityId: integer, The ID of the community whose topic will be moved to the trash folder. (required)
topicId: string, The ID of the topic to be moved to the trash folder. (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(communityId, topicId, hl=None)</code>
<pre>Retrieves a topic of a community.
Args:
communityId: integer, The ID of the community whose topic will be retrieved. (required)
topicId: string, The ID of the topic to get. (required)
hl: string, Specifies the interface language (host language) of your user interface.
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 author.
"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 author.
"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.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(communityId, body, isShout=None)</code>
<pre>Adds a topic to a given community.
Args:
communityId: integer, The ID of the community the topic should be added to. (required)
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 author.
"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 author.
"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.
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 author.
"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 author.
"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.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(communityId, pageToken=None, hl=None, maxResults=None)</code>
<pre>Retrieves the topics of a community.
Args:
communityId: integer, The ID of the community which topics will be listed. (required)
pageToken: string, A continuation token that allows pagination.
hl: string, Specifies the interface language (host language) of your user interface.
maxResults: integer, The maximum number of topics to include in the response.
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 author.
"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 author.
"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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
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.
</pre>
</div>
</body></html>
|
