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
|
<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.comments.html">comments</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(commentId)</a></code></p>
<p class="firstline">Deletes an existing comment.</p>
<p class="toc_element">
<code><a href="#get">get(commentId, hl=None)</a></code></p>
<p class="firstline">Retrieves an existing comment.</p>
<p class="toc_element">
<code><a href="#insert">insert(activityId, body)</a></code></p>
<p class="firstline">Inserts a new comment to an activity.</p>
<p class="toc_element">
<code><a href="#list">list(activityId, orderBy=None, pageToken=None, hl=None, maxResults=None)</a></code></p>
<p class="firstline">Retrieves a list of comments, possibly filtered.</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(commentId)</code>
<pre>Deletes an existing comment.
Args:
commentId: string, ID of the comment to remove. (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(commentId, hl=None)</code>
<pre>Retrieves an existing comment.
Args:
commentId: string, ID of the comment to get. (required)
hl: string, Specifies the interface language (host language) of your user interface.
Returns:
An object of the form:
{
"inReplyTo": { # Link to the original activity where this comment was posted.
"type": "A String", # Type of the post on activity stream being commented. Always text/html.
"href": "A String", # Link to the post on activity stream being commented.
"ref": "A String", # Unique identifier of the post on activity stream being commented.
"rel": "inReplyTo", # Relationship between the comment and the post on activity stream being commented. Always inReplyTo.
},
"kind": "orkut#comment", # Identifies this resource as a comment. Value: "orkut#comment"
"links": [ # List of resources for the comment.
{ # 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.
},
],
"actor": { # The person who posted the comment.
"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.
},
"content": "A String", # The content of the comment in text/html
"published": "A String", # The time the comment was initially published, in RFC 3339 format.
"id": "A String", # The unique ID for the comment.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(activityId, body)</code>
<pre>Inserts a new comment to an activity.
Args:
activityId: string, The ID of the activity to contain the new comment. (required)
body: object, The request body. (required)
The object takes the form of:
{
"inReplyTo": { # Link to the original activity where this comment was posted.
"type": "A String", # Type of the post on activity stream being commented. Always text/html.
"href": "A String", # Link to the post on activity stream being commented.
"ref": "A String", # Unique identifier of the post on activity stream being commented.
"rel": "inReplyTo", # Relationship between the comment and the post on activity stream being commented. Always inReplyTo.
},
"kind": "orkut#comment", # Identifies this resource as a comment. Value: "orkut#comment"
"links": [ # List of resources for the comment.
{ # 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.
},
],
"actor": { # The person who posted the comment.
"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.
},
"content": "A String", # The content of the comment in text/html
"published": "A String", # The time the comment was initially published, in RFC 3339 format.
"id": "A String", # The unique ID for the comment.
}
Returns:
An object of the form:
{
"inReplyTo": { # Link to the original activity where this comment was posted.
"type": "A String", # Type of the post on activity stream being commented. Always text/html.
"href": "A String", # Link to the post on activity stream being commented.
"ref": "A String", # Unique identifier of the post on activity stream being commented.
"rel": "inReplyTo", # Relationship between the comment and the post on activity stream being commented. Always inReplyTo.
},
"kind": "orkut#comment", # Identifies this resource as a comment. Value: "orkut#comment"
"links": [ # List of resources for the comment.
{ # 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.
},
],
"actor": { # The person who posted the comment.
"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.
},
"content": "A String", # The content of the comment in text/html
"published": "A String", # The time the comment was initially published, in RFC 3339 format.
"id": "A String", # The unique ID for the comment.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(activityId, orderBy=None, pageToken=None, hl=None, maxResults=None)</code>
<pre>Retrieves a list of comments, possibly filtered.
Args:
activityId: string, The ID of the activity containing the comments. (required)
orderBy: string, Sort search results.
Allowed values
ascending - Use ascending sort order.
descending - Use descending sort order.
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 activities to include in the response.
Returns:
An object of the form:
{
"nextPageToken": "A String", # The value of pageToken query parameter in comments.list request to get the next page, if there are more to retrieve.
"items": [ # List of comments retrieved.
{
"inReplyTo": { # Link to the original activity where this comment was posted.
"type": "A String", # Type of the post on activity stream being commented. Always text/html.
"href": "A String", # Link to the post on activity stream being commented.
"ref": "A String", # Unique identifier of the post on activity stream being commented.
"rel": "inReplyTo", # Relationship between the comment and the post on activity stream being commented. Always inReplyTo.
},
"kind": "orkut#comment", # Identifies this resource as a comment. Value: "orkut#comment"
"links": [ # List of resources for the comment.
{ # 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.
},
],
"actor": { # The person who posted the comment.
"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.
},
"content": "A String", # The content of the comment in text/html
"published": "A String", # The time the comment was initially published, in RFC 3339 format.
"id": "A String", # The unique ID for the comment.
},
],
"kind": "orkut#commentList", # Identifies this resource as a collection of comments. Value: "orkut#commentList"
"previousPageToken": "A String", # The value of pageToken query parameter in comments.list request to get the previous page, if there are more to retrieve.
}</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>
|
