Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d02bf5ee3860a50d36f960cd2c90ab6d1ecec7cd / . / docs / dyn / blogger.v2.comments.html
blob: aa710e1f03abd73094cb4002ca76d23c2db86d52 [file] [log] [blame]
Joe Gregorioa8451672011-09-15 09:53:21 -0400[diff] [blame]1
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: class Resource</title>
4</head><body bgcolor="#f0f0f8">
5<p>
6<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
7<tr bgcolor="#ffc8d8">
8<td colspan=3 valign=bottom>&nbsp;<br>
9<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>
10
11<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
12<td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
13<tr><td>&nbsp;</td>
14<td width="100%">Methods defined here:<br>
15<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
16
17<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets&nbsp;one&nbsp;comment&nbsp;by&nbsp;id.<br>
18&nbsp;<br>
19Args:<br>
20&nbsp;&nbsp;commentId:&nbsp;string,&nbsp;The&nbsp;ID&nbsp;of&nbsp;the&nbsp;comment&nbsp;to&nbsp;get.&nbsp;(required)<br>
21&nbsp;&nbsp;postId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;post&nbsp;to&nbsp;fetch&nbsp;posts&nbsp;from.&nbsp;(required)<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]22&nbsp;&nbsp;blogId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;blog&nbsp;to&nbsp;containing&nbsp;the&nbsp;comment.&nbsp;(required)<br>
23&nbsp;<br>
24Returns:<br>
25&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
26&nbsp;<br>
27&nbsp;&nbsp;&nbsp;&nbsp;{<br>
28&nbsp;&nbsp;&nbsp;&nbsp;"content":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;actual&nbsp;content&nbsp;of&nbsp;the&nbsp;comment.&nbsp;May&nbsp;include&nbsp;HTML&nbsp;markup.<br>
29&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"blogger#comment",&nbsp;#&nbsp;The&nbsp;kind&nbsp;of&nbsp;this&nbsp;entry.&nbsp;Always&nbsp;blogger#comment<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500[diff] [blame]30&nbsp;&nbsp;&nbsp;&nbsp;"inReplyTo":&nbsp;{&nbsp;#&nbsp;Data&nbsp;about&nbsp;the&nbsp;comment&nbsp;this&nbsp;is&nbsp;in&nbsp;reply&nbsp;to.<br>
31&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;identified&nbsp;of&nbsp;the&nbsp;parent&nbsp;of&nbsp;this&nbsp;comment.<br>
32&nbsp;&nbsp;&nbsp;&nbsp;},<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]33&nbsp;&nbsp;&nbsp;&nbsp;"author":&nbsp;{&nbsp;#&nbsp;The&nbsp;author&nbsp;of&nbsp;this&nbsp;Comment.<br>
34&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;URL&nbsp;of&nbsp;the&nbsp;Comment&nbsp;creator's&nbsp;Profile&nbsp;page.<br>
35&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"image":&nbsp;{&nbsp;#&nbsp;The&nbsp;comment&nbsp;creator's&nbsp;avatar.<br>
36&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;comment&nbsp;creator's&nbsp;avatar&nbsp;URL.<br>
37&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
38&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"displayName":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;display&nbsp;name.<br>
39&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;identifier&nbsp;of&nbsp;the&nbsp;Comment&nbsp;creator.<br>
40&nbsp;&nbsp;&nbsp;&nbsp;},<br>
41&nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;date-time&nbsp;when&nbsp;this&nbsp;comment&nbsp;was&nbsp;last&nbsp;updated.<br>
42&nbsp;&nbsp;&nbsp;&nbsp;"blog":&nbsp;{&nbsp;#&nbsp;Data&nbsp;about&nbsp;the&nbsp;blog&nbsp;containing&nbsp;this&nbsp;comment.<br>
43&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;identifier&nbsp;of&nbsp;the&nbsp;blog&nbsp;containing&nbsp;this&nbsp;comment.<br>
44&nbsp;&nbsp;&nbsp;&nbsp;},<br>
45&nbsp;&nbsp;&nbsp;&nbsp;"published":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;date-time&nbsp;when&nbsp;this&nbsp;comment&nbsp;was&nbsp;published.<br>
46&nbsp;&nbsp;&nbsp;&nbsp;"post":&nbsp;{&nbsp;#&nbsp;Data&nbsp;about&nbsp;the&nbsp;post&nbsp;containing&nbsp;this&nbsp;comment.<br>
47&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;identifier&nbsp;of&nbsp;the&nbsp;post&nbsp;containing&nbsp;this&nbsp;comment.<br>
48&nbsp;&nbsp;&nbsp;&nbsp;},<br>
49&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;identifier&nbsp;for&nbsp;this&nbsp;resource.<br>
50&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;API&nbsp;REST&nbsp;URL&nbsp;to&nbsp;fetch&nbsp;this&nbsp;resource&nbsp;from.<br>
51&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorioa8451672011-09-15 09:53:21 -0400[diff] [blame]52
53<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves&nbsp;the&nbsp;comments&nbsp;for&nbsp;a&nbsp;blog,&nbsp;possibly&nbsp;filtered.<br>
54&nbsp;<br>
55Args:<br>
56&nbsp;&nbsp;startDate:&nbsp;string,&nbsp;Earliest&nbsp;date&nbsp;of&nbsp;comment&nbsp;to&nbsp;fetch.<br>
57&nbsp;&nbsp;fetchBodies:&nbsp;boolean,&nbsp;Whether&nbsp;the&nbsp;body&nbsp;content&nbsp;of&nbsp;the&nbsp;comments&nbsp;is&nbsp;included.<br>
58&nbsp;&nbsp;pageToken:&nbsp;string,&nbsp;Continuation&nbsp;token&nbsp;if&nbsp;request&nbsp;is&nbsp;paged.<br>
59&nbsp;&nbsp;maxResults:&nbsp;integer,&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;comments&nbsp;to&nbsp;include&nbsp;in&nbsp;the&nbsp;result.<br>
60&nbsp;&nbsp;postId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;post&nbsp;to&nbsp;fetch&nbsp;posts&nbsp;from.&nbsp;(required)<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]61&nbsp;&nbsp;blogId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;blog&nbsp;to&nbsp;fetch&nbsp;comments&nbsp;from.&nbsp;(required)<br>
62&nbsp;<br>
63Returns:<br>
64&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
65&nbsp;<br>
66&nbsp;&nbsp;&nbsp;&nbsp;{<br>
67&nbsp;&nbsp;&nbsp;&nbsp;"nextPageToken":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Pagination&nbsp;token&nbsp;to&nbsp;fetch&nbsp;the&nbsp;next&nbsp;page,&nbsp;if&nbsp;one&nbsp;exists.<br>
68&nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[&nbsp;#&nbsp;The&nbsp;List&nbsp;of&nbsp;Comments&nbsp;for&nbsp;a&nbsp;Post.<br>
69&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
70&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"content":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;actual&nbsp;content&nbsp;of&nbsp;the&nbsp;comment.&nbsp;May&nbsp;include&nbsp;HTML&nbsp;markup.<br>
71&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"blogger#comment",&nbsp;#&nbsp;The&nbsp;kind&nbsp;of&nbsp;this&nbsp;entry.&nbsp;Always&nbsp;blogger#comment<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500[diff] [blame]72&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"inReplyTo":&nbsp;{&nbsp;#&nbsp;Data&nbsp;about&nbsp;the&nbsp;comment&nbsp;this&nbsp;is&nbsp;in&nbsp;reply&nbsp;to.<br>
73&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;identified&nbsp;of&nbsp;the&nbsp;parent&nbsp;of&nbsp;this&nbsp;comment.<br>
74&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]75&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"author":&nbsp;{&nbsp;#&nbsp;The&nbsp;author&nbsp;of&nbsp;this&nbsp;Comment.<br>
76&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;URL&nbsp;of&nbsp;the&nbsp;Comment&nbsp;creator's&nbsp;Profile&nbsp;page.<br>
77&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"image":&nbsp;{&nbsp;#&nbsp;The&nbsp;comment&nbsp;creator's&nbsp;avatar.<br>
78&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;comment&nbsp;creator's&nbsp;avatar&nbsp;URL.<br>
79&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
80&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"displayName":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;display&nbsp;name.<br>
81&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;identifier&nbsp;of&nbsp;the&nbsp;Comment&nbsp;creator.<br>
82&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
83&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;date-time&nbsp;when&nbsp;this&nbsp;comment&nbsp;was&nbsp;last&nbsp;updated.<br>
84&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"blog":&nbsp;{&nbsp;#&nbsp;Data&nbsp;about&nbsp;the&nbsp;blog&nbsp;containing&nbsp;this&nbsp;comment.<br>
85&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;identifier&nbsp;of&nbsp;the&nbsp;blog&nbsp;containing&nbsp;this&nbsp;comment.<br>
86&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
87&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"published":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;date-time&nbsp;when&nbsp;this&nbsp;comment&nbsp;was&nbsp;published.<br>
88&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"post":&nbsp;{&nbsp;#&nbsp;Data&nbsp;about&nbsp;the&nbsp;post&nbsp;containing&nbsp;this&nbsp;comment.<br>
89&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;identifier&nbsp;of&nbsp;the&nbsp;post&nbsp;containing&nbsp;this&nbsp;comment.<br>
90&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
91&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;identifier&nbsp;for&nbsp;this&nbsp;resource.<br>
92&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;API&nbsp;REST&nbsp;URL&nbsp;to&nbsp;fetch&nbsp;this&nbsp;resource&nbsp;from.<br>
93&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
94&nbsp;&nbsp;&nbsp;&nbsp;],<br>
95&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"blogger#commentList",&nbsp;#&nbsp;The&nbsp;kind&nbsp;of&nbsp;this&nbsp;entry.&nbsp;Always&nbsp;blogger#commentList<br>
96&nbsp;&nbsp;&nbsp;&nbsp;"prevPageToken":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Pagination&nbsp;token&nbsp;to&nbsp;fetch&nbsp;the&nbsp;previous&nbsp;page,&nbsp;if&nbsp;one&nbsp;exists.<br>
97&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorioa8451672011-09-15 09:53:21 -0400[diff] [blame]98
99<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves&nbsp;the&nbsp;next&nbsp;page&nbsp;of&nbsp;results.<br>
100&nbsp;<br>
101Args:<br>
102&nbsp;&nbsp;previous_request:&nbsp;The&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
103&nbsp;&nbsp;previous_response:&nbsp;The&nbsp;response&nbsp;from&nbsp;the&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
104&nbsp;<br>
105Returns:<br>
106&nbsp;&nbsp;A&nbsp;request&nbsp;object&nbsp;that&nbsp;you&nbsp;can&nbsp;call&nbsp;'execute()'&nbsp;on&nbsp;to&nbsp;request&nbsp;the&nbsp;next<br>
107&nbsp;&nbsp;page.&nbsp;Returns&nbsp;None&nbsp;if&nbsp;there&nbsp;are&nbsp;no&nbsp;more&nbsp;items&nbsp;in&nbsp;the&nbsp;collection.</tt></dd></dl>
108
109<hr>
110Data descriptors defined here:<br>
111<dl><dt><strong>__dict__</strong></dt>
112<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
113</dl>
114<dl><dt><strong>__weakref__</strong></dt>
115<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
116</dl>
117</td></tr></table>
118</body></html>