Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3c9a9da991ac511b3b195ef9ddc268e963628270 / . / docs / dyn / orkut.v2.comments.html
blob: 9498f55a1b0ee79221795801833cdc10aa0f4ae6 [file] [log] [blame]
Joe Gregorio761c4562011-10-28 14:36:24 -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-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Deletes&nbsp;an&nbsp;existing&nbsp;comment.<br>
18&nbsp;<br>
19Args:<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]20&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
21&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
22&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
23&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio761c4562011-10-28 14:36:24 -0400[diff] [blame]24&nbsp;&nbsp;commentId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;comment&nbsp;to&nbsp;remove.&nbsp;(required)</tt></dd></dl>
25
26<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves&nbsp;an&nbsp;existing&nbsp;comment.<br>
27&nbsp;<br>
28Args:<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]29&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
30&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio761c4562011-10-28 14:36:24 -0400[diff] [blame]31&nbsp;&nbsp;hl:&nbsp;string,&nbsp;Specifies&nbsp;the&nbsp;interface&nbsp;language&nbsp;(host&nbsp;language)&nbsp;of&nbsp;your&nbsp;user&nbsp;interface.<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]32&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
33&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]34&nbsp;&nbsp;commentId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;comment&nbsp;to&nbsp;get.&nbsp;(required)<br>
35&nbsp;<br>
36Returns:<br>
37&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
38&nbsp;<br>
39&nbsp;&nbsp;&nbsp;&nbsp;{<br>
40&nbsp;&nbsp;&nbsp;&nbsp;"inReplyTo":&nbsp;{&nbsp;#&nbsp;Link&nbsp;to&nbsp;the&nbsp;original&nbsp;activity&nbsp;where&nbsp;this&nbsp;comment&nbsp;was&nbsp;posted.<br>
41&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;post&nbsp;on&nbsp;activity&nbsp;stream&nbsp;being&nbsp;commented.&nbsp;Always&nbsp;text/html.<br>
42&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"href":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Link&nbsp;to&nbsp;the&nbsp;post&nbsp;on&nbsp;activity&nbsp;stream&nbsp;being&nbsp;commented.<br>
43&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ref":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Unique&nbsp;identifier&nbsp;of&nbsp;the&nbsp;post&nbsp;on&nbsp;activity&nbsp;stream&nbsp;being&nbsp;commented.<br>
44&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rel":&nbsp;"inReplyTo",&nbsp;#&nbsp;Relationship&nbsp;between&nbsp;the&nbsp;comment&nbsp;and&nbsp;the&nbsp;post&nbsp;on&nbsp;activity&nbsp;stream&nbsp;being&nbsp;commented.&nbsp;Always&nbsp;inReplyTo.<br>
45&nbsp;&nbsp;&nbsp;&nbsp;},<br>
46&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"orkut#comment",&nbsp;#&nbsp;Identifies&nbsp;this&nbsp;resource&nbsp;as&nbsp;a&nbsp;comment.&nbsp;Value:&nbsp;"orkut#comment"<br>
47&nbsp;&nbsp;&nbsp;&nbsp;"links":&nbsp;[&nbsp;#&nbsp;List&nbsp;of&nbsp;resources&nbsp;for&nbsp;the&nbsp;comment.<br>
48&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{&nbsp;#&nbsp;Links&nbsp;to&nbsp;resources&nbsp;related&nbsp;to&nbsp;the&nbsp;parent&nbsp;object.<br>
49&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"href":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;of&nbsp;the&nbsp;link.<br>
50&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Media&nbsp;type&nbsp;of&nbsp;the&nbsp;link.<br>
51&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rel":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Relation&nbsp;between&nbsp;the&nbsp;resource&nbsp;and&nbsp;the&nbsp;parent&nbsp;object.<br>
52&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;the&nbsp;link.<br>
53&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
54&nbsp;&nbsp;&nbsp;&nbsp;],<br>
55&nbsp;&nbsp;&nbsp;&nbsp;"actor":&nbsp;{&nbsp;#&nbsp;The&nbsp;person&nbsp;who&nbsp;posted&nbsp;the&nbsp;comment.<br>
56&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;URL&nbsp;of&nbsp;the&nbsp;author&nbsp;who&nbsp;posted&nbsp;the&nbsp;comment&nbsp;[not&nbsp;yet&nbsp;implemented]<br>
Joe Gregoriodf70dfc2012-04-23 08:31:37 -0400[diff] [blame]57&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"image":&nbsp;{&nbsp;#&nbsp;Image&nbsp;data&nbsp;about&nbsp;the&nbsp;author.<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]58&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;A&nbsp;URL&nbsp;that&nbsp;points&nbsp;to&nbsp;a&nbsp;thumbnail&nbsp;photo&nbsp;of&nbsp;the&nbsp;author.<br>
59&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
60&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"displayName":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;author,&nbsp;suitable&nbsp;for&nbsp;display.<br>
61&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Unique&nbsp;identifier&nbsp;of&nbsp;the&nbsp;person&nbsp;who&nbsp;posted&nbsp;the&nbsp;comment.&nbsp;This&nbsp;is&nbsp;the&nbsp;person's&nbsp;OpenSocial&nbsp;ID.<br>
62&nbsp;&nbsp;&nbsp;&nbsp;},<br>
63&nbsp;&nbsp;&nbsp;&nbsp;"content":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;content&nbsp;of&nbsp;the&nbsp;comment&nbsp;in&nbsp;text/html<br>
64&nbsp;&nbsp;&nbsp;&nbsp;"published":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;time&nbsp;the&nbsp;comment&nbsp;was&nbsp;initially&nbsp;published,&nbsp;in&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;format.<br>
65&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;unique&nbsp;ID&nbsp;for&nbsp;the&nbsp;comment.<br>
66&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorio761c4562011-10-28 14:36:24 -0400[diff] [blame]67
68<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Inserts&nbsp;a&nbsp;new&nbsp;comment&nbsp;to&nbsp;an&nbsp;activity.<br>
69&nbsp;<br>
70Args:<br>
71&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]72&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
73&nbsp;<br>
74{<br>
75&nbsp;&nbsp;"inReplyTo":&nbsp;{&nbsp;#&nbsp;Link&nbsp;to&nbsp;the&nbsp;original&nbsp;activity&nbsp;where&nbsp;this&nbsp;comment&nbsp;was&nbsp;posted.<br>
76&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;post&nbsp;on&nbsp;activity&nbsp;stream&nbsp;being&nbsp;commented.&nbsp;Always&nbsp;text/html.<br>
77&nbsp;&nbsp;&nbsp;&nbsp;"href":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Link&nbsp;to&nbsp;the&nbsp;post&nbsp;on&nbsp;activity&nbsp;stream&nbsp;being&nbsp;commented.<br>
78&nbsp;&nbsp;&nbsp;&nbsp;"ref":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Unique&nbsp;identifier&nbsp;of&nbsp;the&nbsp;post&nbsp;on&nbsp;activity&nbsp;stream&nbsp;being&nbsp;commented.<br>
79&nbsp;&nbsp;&nbsp;&nbsp;"rel":&nbsp;"inReplyTo",&nbsp;#&nbsp;Relationship&nbsp;between&nbsp;the&nbsp;comment&nbsp;and&nbsp;the&nbsp;post&nbsp;on&nbsp;activity&nbsp;stream&nbsp;being&nbsp;commented.&nbsp;Always&nbsp;inReplyTo.<br>
80&nbsp;&nbsp;},<br>
81&nbsp;&nbsp;"kind":&nbsp;"orkut#comment",&nbsp;#&nbsp;Identifies&nbsp;this&nbsp;resource&nbsp;as&nbsp;a&nbsp;comment.&nbsp;Value:&nbsp;"orkut#comment"<br>
82&nbsp;&nbsp;"links":&nbsp;[&nbsp;#&nbsp;List&nbsp;of&nbsp;resources&nbsp;for&nbsp;the&nbsp;comment.<br>
83&nbsp;&nbsp;&nbsp;&nbsp;{&nbsp;#&nbsp;Links&nbsp;to&nbsp;resources&nbsp;related&nbsp;to&nbsp;the&nbsp;parent&nbsp;object.<br>
84&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"href":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;of&nbsp;the&nbsp;link.<br>
85&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Media&nbsp;type&nbsp;of&nbsp;the&nbsp;link.<br>
86&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rel":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Relation&nbsp;between&nbsp;the&nbsp;resource&nbsp;and&nbsp;the&nbsp;parent&nbsp;object.<br>
87&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;the&nbsp;link.<br>
88&nbsp;&nbsp;&nbsp;&nbsp;},<br>
89&nbsp;&nbsp;],<br>
90&nbsp;&nbsp;"actor":&nbsp;{&nbsp;#&nbsp;The&nbsp;person&nbsp;who&nbsp;posted&nbsp;the&nbsp;comment.<br>
91&nbsp;&nbsp;&nbsp;&nbsp;"url":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;URL&nbsp;of&nbsp;the&nbsp;author&nbsp;who&nbsp;posted&nbsp;the&nbsp;comment&nbsp;[not&nbsp;yet&nbsp;implemented]<br>
Joe Gregoriodf70dfc2012-04-23 08:31:37 -0400[diff] [blame]92&nbsp;&nbsp;&nbsp;&nbsp;"image":&nbsp;{&nbsp;#&nbsp;Image&nbsp;data&nbsp;about&nbsp;the&nbsp;author.<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]93&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;A&nbsp;URL&nbsp;that&nbsp;points&nbsp;to&nbsp;a&nbsp;thumbnail&nbsp;photo&nbsp;of&nbsp;the&nbsp;author.<br>
94&nbsp;&nbsp;&nbsp;&nbsp;},<br>
95&nbsp;&nbsp;&nbsp;&nbsp;"displayName":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;author,&nbsp;suitable&nbsp;for&nbsp;display.<br>
96&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Unique&nbsp;identifier&nbsp;of&nbsp;the&nbsp;person&nbsp;who&nbsp;posted&nbsp;the&nbsp;comment.&nbsp;This&nbsp;is&nbsp;the&nbsp;person's&nbsp;OpenSocial&nbsp;ID.<br>
97&nbsp;&nbsp;},<br>
98&nbsp;&nbsp;"content":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;content&nbsp;of&nbsp;the&nbsp;comment&nbsp;in&nbsp;text/html<br>
99&nbsp;&nbsp;"published":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;time&nbsp;the&nbsp;comment&nbsp;was&nbsp;initially&nbsp;published,&nbsp;in&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;format.<br>
100&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;unique&nbsp;ID&nbsp;for&nbsp;the&nbsp;comment.<br>
101}<br>
102&nbsp;<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]103&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
104&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
105&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]106&nbsp;&nbsp;activityId:&nbsp;string,&nbsp;The&nbsp;ID&nbsp;of&nbsp;the&nbsp;activity&nbsp;to&nbsp;contain&nbsp;the&nbsp;new&nbsp;comment.&nbsp;(required)<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]107&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]108&nbsp;<br>
109Returns:<br>
110&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
111&nbsp;<br>
112&nbsp;&nbsp;&nbsp;&nbsp;{<br>
113&nbsp;&nbsp;&nbsp;&nbsp;"inReplyTo":&nbsp;{&nbsp;#&nbsp;Link&nbsp;to&nbsp;the&nbsp;original&nbsp;activity&nbsp;where&nbsp;this&nbsp;comment&nbsp;was&nbsp;posted.<br>
114&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;post&nbsp;on&nbsp;activity&nbsp;stream&nbsp;being&nbsp;commented.&nbsp;Always&nbsp;text/html.<br>
115&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"href":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Link&nbsp;to&nbsp;the&nbsp;post&nbsp;on&nbsp;activity&nbsp;stream&nbsp;being&nbsp;commented.<br>
116&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ref":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Unique&nbsp;identifier&nbsp;of&nbsp;the&nbsp;post&nbsp;on&nbsp;activity&nbsp;stream&nbsp;being&nbsp;commented.<br>
117&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rel":&nbsp;"inReplyTo",&nbsp;#&nbsp;Relationship&nbsp;between&nbsp;the&nbsp;comment&nbsp;and&nbsp;the&nbsp;post&nbsp;on&nbsp;activity&nbsp;stream&nbsp;being&nbsp;commented.&nbsp;Always&nbsp;inReplyTo.<br>
118&nbsp;&nbsp;&nbsp;&nbsp;},<br>
119&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"orkut#comment",&nbsp;#&nbsp;Identifies&nbsp;this&nbsp;resource&nbsp;as&nbsp;a&nbsp;comment.&nbsp;Value:&nbsp;"orkut#comment"<br>
120&nbsp;&nbsp;&nbsp;&nbsp;"links":&nbsp;[&nbsp;#&nbsp;List&nbsp;of&nbsp;resources&nbsp;for&nbsp;the&nbsp;comment.<br>
121&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{&nbsp;#&nbsp;Links&nbsp;to&nbsp;resources&nbsp;related&nbsp;to&nbsp;the&nbsp;parent&nbsp;object.<br>
122&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"href":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;of&nbsp;the&nbsp;link.<br>
123&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Media&nbsp;type&nbsp;of&nbsp;the&nbsp;link.<br>
124&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rel":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Relation&nbsp;between&nbsp;the&nbsp;resource&nbsp;and&nbsp;the&nbsp;parent&nbsp;object.<br>
125&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;the&nbsp;link.<br>
126&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
127&nbsp;&nbsp;&nbsp;&nbsp;],<br>
128&nbsp;&nbsp;&nbsp;&nbsp;"actor":&nbsp;{&nbsp;#&nbsp;The&nbsp;person&nbsp;who&nbsp;posted&nbsp;the&nbsp;comment.<br>
129&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;URL&nbsp;of&nbsp;the&nbsp;author&nbsp;who&nbsp;posted&nbsp;the&nbsp;comment&nbsp;[not&nbsp;yet&nbsp;implemented]<br>
Joe Gregoriodf70dfc2012-04-23 08:31:37 -0400[diff] [blame]130&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"image":&nbsp;{&nbsp;#&nbsp;Image&nbsp;data&nbsp;about&nbsp;the&nbsp;author.<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]131&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;A&nbsp;URL&nbsp;that&nbsp;points&nbsp;to&nbsp;a&nbsp;thumbnail&nbsp;photo&nbsp;of&nbsp;the&nbsp;author.<br>
132&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
133&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"displayName":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;author,&nbsp;suitable&nbsp;for&nbsp;display.<br>
134&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Unique&nbsp;identifier&nbsp;of&nbsp;the&nbsp;person&nbsp;who&nbsp;posted&nbsp;the&nbsp;comment.&nbsp;This&nbsp;is&nbsp;the&nbsp;person's&nbsp;OpenSocial&nbsp;ID.<br>
135&nbsp;&nbsp;&nbsp;&nbsp;},<br>
136&nbsp;&nbsp;&nbsp;&nbsp;"content":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;content&nbsp;of&nbsp;the&nbsp;comment&nbsp;in&nbsp;text/html<br>
137&nbsp;&nbsp;&nbsp;&nbsp;"published":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;time&nbsp;the&nbsp;comment&nbsp;was&nbsp;initially&nbsp;published,&nbsp;in&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;format.<br>
138&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;unique&nbsp;ID&nbsp;for&nbsp;the&nbsp;comment.<br>
139&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorio761c4562011-10-28 14:36:24 -0400[diff] [blame]140
141<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves&nbsp;a&nbsp;list&nbsp;of&nbsp;comments,&nbsp;possibly&nbsp;filtered.<br>
142&nbsp;<br>
143Args:<br>
144&nbsp;&nbsp;orderBy:&nbsp;string,&nbsp;Sort&nbsp;search&nbsp;results.<br>
145&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
146&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ascending&nbsp;-&nbsp;Use&nbsp;ascending&nbsp;sort&nbsp;order.<br>
147&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;descending&nbsp;-&nbsp;Use&nbsp;descending&nbsp;sort&nbsp;order.<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]148&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
149&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio761c4562011-10-28 14:36:24 -0400[diff] [blame]150&nbsp;&nbsp;pageToken:&nbsp;string,&nbsp;A&nbsp;continuation&nbsp;token&nbsp;that&nbsp;allows&nbsp;pagination.<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]151&nbsp;&nbsp;hl:&nbsp;string,&nbsp;Specifies&nbsp;the&nbsp;interface&nbsp;language&nbsp;(host&nbsp;language)&nbsp;of&nbsp;your&nbsp;user&nbsp;interface.<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]152&nbsp;&nbsp;maxResults:&nbsp;integer,&nbsp;The&nbsp;maximum&nbsp;number&nbsp;of&nbsp;activities&nbsp;to&nbsp;include&nbsp;in&nbsp;the&nbsp;response.<br>
153&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
154&nbsp;&nbsp;activityId:&nbsp;string,&nbsp;The&nbsp;ID&nbsp;of&nbsp;the&nbsp;activity&nbsp;containing&nbsp;the&nbsp;comments.&nbsp;(required)<br>
155&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]156&nbsp;<br>
157Returns:<br>
158&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
159&nbsp;<br>
160&nbsp;&nbsp;&nbsp;&nbsp;{<br>
161&nbsp;&nbsp;&nbsp;&nbsp;"nextPageToken":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;value&nbsp;of&nbsp;pageToken&nbsp;query&nbsp;parameter&nbsp;in&nbsp;comments.list&nbsp;request&nbsp;to&nbsp;get&nbsp;the&nbsp;next&nbsp;page,&nbsp;if&nbsp;there&nbsp;are&nbsp;more&nbsp;to&nbsp;retrieve.<br>
162&nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[&nbsp;#&nbsp;List&nbsp;of&nbsp;comments&nbsp;retrieved.<br>
163&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
164&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"inReplyTo":&nbsp;{&nbsp;#&nbsp;Link&nbsp;to&nbsp;the&nbsp;original&nbsp;activity&nbsp;where&nbsp;this&nbsp;comment&nbsp;was&nbsp;posted.<br>
165&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;post&nbsp;on&nbsp;activity&nbsp;stream&nbsp;being&nbsp;commented.&nbsp;Always&nbsp;text/html.<br>
166&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"href":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Link&nbsp;to&nbsp;the&nbsp;post&nbsp;on&nbsp;activity&nbsp;stream&nbsp;being&nbsp;commented.<br>
167&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ref":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Unique&nbsp;identifier&nbsp;of&nbsp;the&nbsp;post&nbsp;on&nbsp;activity&nbsp;stream&nbsp;being&nbsp;commented.<br>
168&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rel":&nbsp;"inReplyTo",&nbsp;#&nbsp;Relationship&nbsp;between&nbsp;the&nbsp;comment&nbsp;and&nbsp;the&nbsp;post&nbsp;on&nbsp;activity&nbsp;stream&nbsp;being&nbsp;commented.&nbsp;Always&nbsp;inReplyTo.<br>
169&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
170&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"orkut#comment",&nbsp;#&nbsp;Identifies&nbsp;this&nbsp;resource&nbsp;as&nbsp;a&nbsp;comment.&nbsp;Value:&nbsp;"orkut#comment"<br>
171&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"links":&nbsp;[&nbsp;#&nbsp;List&nbsp;of&nbsp;resources&nbsp;for&nbsp;the&nbsp;comment.<br>
172&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{&nbsp;#&nbsp;Links&nbsp;to&nbsp;resources&nbsp;related&nbsp;to&nbsp;the&nbsp;parent&nbsp;object.<br>
173&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"href":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;of&nbsp;the&nbsp;link.<br>
174&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Media&nbsp;type&nbsp;of&nbsp;the&nbsp;link.<br>
175&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rel":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Relation&nbsp;between&nbsp;the&nbsp;resource&nbsp;and&nbsp;the&nbsp;parent&nbsp;object.<br>
176&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;the&nbsp;link.<br>
177&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
178&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
179&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"actor":&nbsp;{&nbsp;#&nbsp;The&nbsp;person&nbsp;who&nbsp;posted&nbsp;the&nbsp;comment.<br>
180&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;author&nbsp;who&nbsp;posted&nbsp;the&nbsp;comment&nbsp;[not&nbsp;yet&nbsp;implemented]<br>
Joe Gregoriodf70dfc2012-04-23 08:31:37 -0400[diff] [blame]181&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"image":&nbsp;{&nbsp;#&nbsp;Image&nbsp;data&nbsp;about&nbsp;the&nbsp;author.<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]182&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;A&nbsp;URL&nbsp;that&nbsp;points&nbsp;to&nbsp;a&nbsp;thumbnail&nbsp;photo&nbsp;of&nbsp;the&nbsp;author.<br>
183&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
184&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"displayName":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;author,&nbsp;suitable&nbsp;for&nbsp;display.<br>
185&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Unique&nbsp;identifier&nbsp;of&nbsp;the&nbsp;person&nbsp;who&nbsp;posted&nbsp;the&nbsp;comment.&nbsp;This&nbsp;is&nbsp;the&nbsp;person's&nbsp;OpenSocial&nbsp;ID.<br>
186&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
187&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"content":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;content&nbsp;of&nbsp;the&nbsp;comment&nbsp;in&nbsp;text/html<br>
188&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"published":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;time&nbsp;the&nbsp;comment&nbsp;was&nbsp;initially&nbsp;published,&nbsp;in&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;format.<br>
189&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;unique&nbsp;ID&nbsp;for&nbsp;the&nbsp;comment.<br>
190&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
191&nbsp;&nbsp;&nbsp;&nbsp;],<br>
192&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"orkut#commentList",&nbsp;#&nbsp;Identifies&nbsp;this&nbsp;resource&nbsp;as&nbsp;a&nbsp;collection&nbsp;of&nbsp;comments.&nbsp;Value:&nbsp;"orkut#commentList"<br>
193&nbsp;&nbsp;&nbsp;&nbsp;"previousPageToken":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;value&nbsp;of&nbsp;pageToken&nbsp;query&nbsp;parameter&nbsp;in&nbsp;comments.list&nbsp;request&nbsp;to&nbsp;get&nbsp;the&nbsp;previous&nbsp;page,&nbsp;if&nbsp;there&nbsp;are&nbsp;more&nbsp;to&nbsp;retrieve.<br>
194&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorio761c4562011-10-28 14:36:24 -0400[diff] [blame]195
196<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>
197&nbsp;<br>
198Args:<br>
199&nbsp;&nbsp;previous_request:&nbsp;The&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
200&nbsp;&nbsp;previous_response:&nbsp;The&nbsp;response&nbsp;from&nbsp;the&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
201&nbsp;<br>
202Returns:<br>
203&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>
204&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>
205
206<hr>
207Data descriptors defined here:<br>
208<dl><dt><strong>__dict__</strong></dt>
209<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
210</dl>
211<dl><dt><strong>__weakref__</strong></dt>
212<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
213</dl>
214</td></tr></table>
215</body></html>