Debian Codegraph @

docs/dyn/blogger_v3.comments.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="blogger_v3.html">blogger API</a> . <a href="blogger_v3.comments.html">comments</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#approve">approve(blogId, postId, commentId, x__xgafv=None)</a></code></p>
79 <p class="firstline">Marks a comment as not spam by blog id, post id and comment id.</p>
80 <p class="toc_element">
81 <code><a href="#close">close()</a></code></p>
82 <p class="firstline">Close httplib2 connections.</p>
83 <p class="toc_element">
84 <code><a href="#delete">delete(blogId, postId, commentId, x__xgafv=None)</a></code></p>
85 <p class="firstline">Deletes a comment by blog id, post id and comment id.</p>
86 <p class="toc_element">
87 <code><a href="#get">get(blogId, postId, commentId, view=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Gets a comment by id.</p>
89 <p class="toc_element">
90 <code><a href="#list">list(blogId, postId, endDate=None, fetchBodies=None, maxResults=None, pageToken=None, startDate=None, status=None, view=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Lists comments.</p>
92 <p class="toc_element">
93 <code><a href="#listByBlog">listByBlog(blogId, endDate=None, fetchBodies=None, maxResults=None, pageToken=None, startDate=None, status=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Lists comments by blog.</p>
95 <p class="toc_element">
96 <code><a href="#listByBlog_next">listByBlog_next()</a></code></p>
97 <p class="firstline">Retrieves the next page of results.</p>
98 <p class="toc_element">
99 <code><a href="#list_next">list_next()</a></code></p>
100 <p class="firstline">Retrieves the next page of results.</p>
101 <p class="toc_element">
102 <code><a href="#markAsSpam">markAsSpam(blogId, postId, commentId, x__xgafv=None)</a></code></p>
103 <p class="firstline">Marks a comment as spam by blog id, post id and comment id.</p>
104 <p class="toc_element">
105 <code><a href="#removeContent">removeContent(blogId, postId, commentId, x__xgafv=None)</a></code></p>
106 <p class="firstline">Removes the content of a comment by blog id, post id and comment id.</p>
107 <h3>Method Details</h3>
108 <div class="method">
109 <code class="details" id="approve">approve(blogId, postId, commentId, x__xgafv=None)</code>
110 <pre>Marks a comment as not spam by blog id, post id and comment id.
111
112 Args:
113 blogId: string, A parameter (required)
114 postId: string, A parameter (required)
115 commentId: string, A parameter (required)
116 x__xgafv: string, V1 error format.
117 Allowed values
118 1 - v1 error format
119 2 - v2 error format
120
121 Returns:
122 An object of the form:
123
124 {
125 &quot;author&quot;: { # The author of this Comment.
126 &quot;displayName&quot;: &quot;A String&quot;, # The display name.
127 &quot;id&quot;: &quot;A String&quot;, # The identifier of the creator.
128 &quot;image&quot;: { # The creator&#x27;s avatar.
129 &quot;url&quot;: &quot;A String&quot;, # The creator&#x27;s avatar URL.
130 },
131 &quot;url&quot;: &quot;A String&quot;, # The URL of the creator&#x27;s Profile page.
132 },
133 &quot;blog&quot;: { # Data about the blog containing this comment.
134 &quot;id&quot;: &quot;A String&quot;, # The identifier of the blog containing this comment.
135 },
136 &quot;content&quot;: &quot;A String&quot;, # The actual content of the comment. May include HTML markup.
137 &quot;id&quot;: &quot;A String&quot;, # The identifier for this resource.
138 &quot;inReplyTo&quot;: { # Data about the comment this is in reply to.
139 &quot;id&quot;: &quot;A String&quot;, # The identified of the parent of this comment.
140 },
141 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entry. Always blogger#comment.
142 &quot;post&quot;: { # Data about the post containing this comment.
143 &quot;id&quot;: &quot;A String&quot;, # The identifier of the post containing this comment.
144 },
145 &quot;published&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was published.
146 &quot;selfLink&quot;: &quot;A String&quot;, # The API REST URL to fetch this resource from.
147 &quot;status&quot;: &quot;A String&quot;, # The status of the comment (only populated for admin users).
148 &quot;updated&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was last updated.
149 }</pre>
150 </div>
151
152 <div class="method">
153 <code class="details" id="close">close()</code>
154 <pre>Close httplib2 connections.</pre>
155 </div>
156
157 <div class="method">
158 <code class="details" id="delete">delete(blogId, postId, commentId, x__xgafv=None)</code>
159 <pre>Deletes a comment by blog id, post id and comment id.
160
161 Args:
162 blogId: string, A parameter (required)
163 postId: string, A parameter (required)
164 commentId: string, A parameter (required)
165 x__xgafv: string, V1 error format.
166 Allowed values
167 1 - v1 error format
168 2 - v2 error format
169 </pre>
170 </div>
171
172 <div class="method">
173 <code class="details" id="get">get(blogId, postId, commentId, view=None, x__xgafv=None)</code>
174 <pre>Gets a comment by id.
175
176 Args:
177 blogId: string, A parameter (required)
178 postId: string, A parameter (required)
179 commentId: string, A parameter (required)
180 view: string, A parameter
181 Allowed values
182 VIEW_TYPE_UNSPECIFIED -
183 READER -
184 AUTHOR -
185 ADMIN -
186 x__xgafv: string, V1 error format.
187 Allowed values
188 1 - v1 error format
189 2 - v2 error format
190
191 Returns:
192 An object of the form:
193
194 {
195 &quot;author&quot;: { # The author of this Comment.
196 &quot;displayName&quot;: &quot;A String&quot;, # The display name.
197 &quot;id&quot;: &quot;A String&quot;, # The identifier of the creator.
198 &quot;image&quot;: { # The creator&#x27;s avatar.
199 &quot;url&quot;: &quot;A String&quot;, # The creator&#x27;s avatar URL.
200 },
201 &quot;url&quot;: &quot;A String&quot;, # The URL of the creator&#x27;s Profile page.
202 },
203 &quot;blog&quot;: { # Data about the blog containing this comment.
204 &quot;id&quot;: &quot;A String&quot;, # The identifier of the blog containing this comment.
205 },
206 &quot;content&quot;: &quot;A String&quot;, # The actual content of the comment. May include HTML markup.
207 &quot;id&quot;: &quot;A String&quot;, # The identifier for this resource.
208 &quot;inReplyTo&quot;: { # Data about the comment this is in reply to.
209 &quot;id&quot;: &quot;A String&quot;, # The identified of the parent of this comment.
210 },
211 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entry. Always blogger#comment.
212 &quot;post&quot;: { # Data about the post containing this comment.
213 &quot;id&quot;: &quot;A String&quot;, # The identifier of the post containing this comment.
214 },
215 &quot;published&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was published.
216 &quot;selfLink&quot;: &quot;A String&quot;, # The API REST URL to fetch this resource from.
217 &quot;status&quot;: &quot;A String&quot;, # The status of the comment (only populated for admin users).
218 &quot;updated&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was last updated.
219 }</pre>
220 </div>
221
222 <div class="method">
223 <code class="details" id="list">list(blogId, postId, endDate=None, fetchBodies=None, maxResults=None, pageToken=None, startDate=None, status=None, view=None, x__xgafv=None)</code>
224 <pre>Lists comments.
225
226 Args:
227 blogId: string, A parameter (required)
228 postId: string, A parameter (required)
229 endDate: string, A parameter
230 fetchBodies: boolean, A parameter
231 maxResults: integer, A parameter
232 pageToken: string, A parameter
233 startDate: string, A parameter
234 status: string, A parameter
235 Allowed values
236 LIVE -
237 EMPTIED -
238 PENDING -
239 SPAM -
240 view: string, A parameter
241 Allowed values
242 VIEW_TYPE_UNSPECIFIED -
243 READER -
244 AUTHOR -
245 ADMIN -
246 x__xgafv: string, V1 error format.
247 Allowed values
248 1 - v1 error format
249 2 - v2 error format
250
251 Returns:
252 An object of the form:
253
254 {
255 &quot;etag&quot;: &quot;A String&quot;, # Etag of the response.
256 &quot;items&quot;: [ # The List of Comments for a Post.
257 {
258 &quot;author&quot;: { # The author of this Comment.
259 &quot;displayName&quot;: &quot;A String&quot;, # The display name.
260 &quot;id&quot;: &quot;A String&quot;, # The identifier of the creator.
261 &quot;image&quot;: { # The creator&#x27;s avatar.
262 &quot;url&quot;: &quot;A String&quot;, # The creator&#x27;s avatar URL.
263 },
264 &quot;url&quot;: &quot;A String&quot;, # The URL of the creator&#x27;s Profile page.
265 },
266 &quot;blog&quot;: { # Data about the blog containing this comment.
267 &quot;id&quot;: &quot;A String&quot;, # The identifier of the blog containing this comment.
268 },
269 &quot;content&quot;: &quot;A String&quot;, # The actual content of the comment. May include HTML markup.
270 &quot;id&quot;: &quot;A String&quot;, # The identifier for this resource.
271 &quot;inReplyTo&quot;: { # Data about the comment this is in reply to.
272 &quot;id&quot;: &quot;A String&quot;, # The identified of the parent of this comment.
273 },
274 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entry. Always blogger#comment.
275 &quot;post&quot;: { # Data about the post containing this comment.
276 &quot;id&quot;: &quot;A String&quot;, # The identifier of the post containing this comment.
277 },
278 &quot;published&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was published.
279 &quot;selfLink&quot;: &quot;A String&quot;, # The API REST URL to fetch this resource from.
280 &quot;status&quot;: &quot;A String&quot;, # The status of the comment (only populated for admin users).
281 &quot;updated&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was last updated.
282 },
283 ],
284 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entry. Always blogger#commentList.
285 &quot;nextPageToken&quot;: &quot;A String&quot;, # Pagination token to fetch the next page, if one exists.
286 &quot;prevPageToken&quot;: &quot;A String&quot;, # Pagination token to fetch the previous page, if one exists.
287 }</pre>
288 </div>
289
290 <div class="method">
291 <code class="details" id="listByBlog">listByBlog(blogId, endDate=None, fetchBodies=None, maxResults=None, pageToken=None, startDate=None, status=None, x__xgafv=None)</code>
292 <pre>Lists comments by blog.
293
294 Args:
295 blogId: string, A parameter (required)
296 endDate: string, A parameter
297 fetchBodies: boolean, A parameter
298 maxResults: integer, A parameter
299 pageToken: string, A parameter
300 startDate: string, A parameter
301 status: string, A parameter (repeated)
302 Allowed values
303 LIVE -
304 EMPTIED -
305 PENDING -
306 SPAM -
307 x__xgafv: string, V1 error format.
308 Allowed values
309 1 - v1 error format
310 2 - v2 error format
311
312 Returns:
313 An object of the form:
314
315 {
316 &quot;etag&quot;: &quot;A String&quot;, # Etag of the response.
317 &quot;items&quot;: [ # The List of Comments for a Post.
318 {
319 &quot;author&quot;: { # The author of this Comment.
320 &quot;displayName&quot;: &quot;A String&quot;, # The display name.
321 &quot;id&quot;: &quot;A String&quot;, # The identifier of the creator.
322 &quot;image&quot;: { # The creator&#x27;s avatar.
323 &quot;url&quot;: &quot;A String&quot;, # The creator&#x27;s avatar URL.
324 },
325 &quot;url&quot;: &quot;A String&quot;, # The URL of the creator&#x27;s Profile page.
326 },
327 &quot;blog&quot;: { # Data about the blog containing this comment.
328 &quot;id&quot;: &quot;A String&quot;, # The identifier of the blog containing this comment.
329 },
330 &quot;content&quot;: &quot;A String&quot;, # The actual content of the comment. May include HTML markup.
331 &quot;id&quot;: &quot;A String&quot;, # The identifier for this resource.
332 &quot;inReplyTo&quot;: { # Data about the comment this is in reply to.
333 &quot;id&quot;: &quot;A String&quot;, # The identified of the parent of this comment.
334 },
335 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entry. Always blogger#comment.
336 &quot;post&quot;: { # Data about the post containing this comment.
337 &quot;id&quot;: &quot;A String&quot;, # The identifier of the post containing this comment.
338 },
339 &quot;published&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was published.
340 &quot;selfLink&quot;: &quot;A String&quot;, # The API REST URL to fetch this resource from.
341 &quot;status&quot;: &quot;A String&quot;, # The status of the comment (only populated for admin users).
342 &quot;updated&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was last updated.
343 },
344 ],
345 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entry. Always blogger#commentList.
346 &quot;nextPageToken&quot;: &quot;A String&quot;, # Pagination token to fetch the next page, if one exists.
347 &quot;prevPageToken&quot;: &quot;A String&quot;, # Pagination token to fetch the previous page, if one exists.
348 }</pre>
349 </div>
350
351 <div class="method">
352 <code class="details" id="listByBlog_next">listByBlog_next()</code>
353 <pre>Retrieves the next page of results.
354
355 Args:
356 previous_request: The request for the previous page. (required)
357 previous_response: The response from the request for the previous page. (required)
358
359 Returns:
360 A request object that you can call &#x27;execute()&#x27; on to request the next
361 page. Returns None if there are no more items in the collection.
362 </pre>
363 </div>
364
365 <div class="method">
366 <code class="details" id="list_next">list_next()</code>
367 <pre>Retrieves the next page of results.
368
369 Args:
370 previous_request: The request for the previous page. (required)
371 previous_response: The response from the request for the previous page. (required)
372
373 Returns:
374 A request object that you can call &#x27;execute()&#x27; on to request the next
375 page. Returns None if there are no more items in the collection.
376 </pre>
377 </div>
378
379 <div class="method">
380 <code class="details" id="markAsSpam">markAsSpam(blogId, postId, commentId, x__xgafv=None)</code>
381 <pre>Marks a comment as spam by blog id, post id and comment id.
382
383 Args:
384 blogId: string, A parameter (required)
385 postId: string, A parameter (required)
386 commentId: string, A parameter (required)
387 x__xgafv: string, V1 error format.
388 Allowed values
389 1 - v1 error format
390 2 - v2 error format
391
392 Returns:
393 An object of the form:
394
395 {
396 &quot;author&quot;: { # The author of this Comment.
397 &quot;displayName&quot;: &quot;A String&quot;, # The display name.
398 &quot;id&quot;: &quot;A String&quot;, # The identifier of the creator.
399 &quot;image&quot;: { # The creator&#x27;s avatar.
400 &quot;url&quot;: &quot;A String&quot;, # The creator&#x27;s avatar URL.
401 },
402 &quot;url&quot;: &quot;A String&quot;, # The URL of the creator&#x27;s Profile page.
403 },
404 &quot;blog&quot;: { # Data about the blog containing this comment.
405 &quot;id&quot;: &quot;A String&quot;, # The identifier of the blog containing this comment.
406 },
407 &quot;content&quot;: &quot;A String&quot;, # The actual content of the comment. May include HTML markup.
408 &quot;id&quot;: &quot;A String&quot;, # The identifier for this resource.
409 &quot;inReplyTo&quot;: { # Data about the comment this is in reply to.
410 &quot;id&quot;: &quot;A String&quot;, # The identified of the parent of this comment.
411 },
412 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entry. Always blogger#comment.
413 &quot;post&quot;: { # Data about the post containing this comment.
414 &quot;id&quot;: &quot;A String&quot;, # The identifier of the post containing this comment.
415 },
416 &quot;published&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was published.
417 &quot;selfLink&quot;: &quot;A String&quot;, # The API REST URL to fetch this resource from.
418 &quot;status&quot;: &quot;A String&quot;, # The status of the comment (only populated for admin users).
419 &quot;updated&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was last updated.
420 }</pre>
421 </div>
422
423 <div class="method">
424 <code class="details" id="removeContent">removeContent(blogId, postId, commentId, x__xgafv=None)</code>
425 <pre>Removes the content of a comment by blog id, post id and comment id.
426
427 Args:
428 blogId: string, A parameter (required)
429 postId: string, A parameter (required)
430 commentId: string, A parameter (required)
431 x__xgafv: string, V1 error format.
432 Allowed values
433 1 - v1 error format
434 2 - v2 error format
435
436 Returns:
437 An object of the form:
438
439 {
440 &quot;author&quot;: { # The author of this Comment.
441 &quot;displayName&quot;: &quot;A String&quot;, # The display name.
442 &quot;id&quot;: &quot;A String&quot;, # The identifier of the creator.
443 &quot;image&quot;: { # The creator&#x27;s avatar.
444 &quot;url&quot;: &quot;A String&quot;, # The creator&#x27;s avatar URL.
445 },
446 &quot;url&quot;: &quot;A String&quot;, # The URL of the creator&#x27;s Profile page.
447 },
448 &quot;blog&quot;: { # Data about the blog containing this comment.
449 &quot;id&quot;: &quot;A String&quot;, # The identifier of the blog containing this comment.
450 },
451 &quot;content&quot;: &quot;A String&quot;, # The actual content of the comment. May include HTML markup.
452 &quot;id&quot;: &quot;A String&quot;, # The identifier for this resource.
453 &quot;inReplyTo&quot;: { # Data about the comment this is in reply to.
454 &quot;id&quot;: &quot;A String&quot;, # The identified of the parent of this comment.
455 },
456 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entry. Always blogger#comment.
457 &quot;post&quot;: { # Data about the post containing this comment.
458 &quot;id&quot;: &quot;A String&quot;, # The identifier of the post containing this comment.
459 },
460 &quot;published&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was published.
461 &quot;selfLink&quot;: &quot;A String&quot;, # The API REST URL to fetch this resource from.
462 &quot;status&quot;: &quot;A String&quot;, # The status of the comment (only populated for admin users).
463 &quot;updated&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was last updated.
464 }</pre>
465 </div>
466
467 </body></html>