Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 46a8071fe1d1a112dcc791f61c20fd8306b4061f / . / docs / dyn / plusDomains_v1.comments.html
blob: 15825436b5a0bdf2cd689fef6d7c0685b7eaf4f7 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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="plusDomains_v1.html">Google+ Domains API</a> . <a href="plusDomains_v1.comments.html">comments</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(commentId)</a></code></p>
79<p class="firstline">Get a comment.</p>
80<p class="toc_element">
81 <code><a href="#insert">insert(activityId, body)</a></code></p>
82<p class="firstline">Create a new comment in reply to an activity.</p>
83<p class="toc_element">
84 <code><a href="#list">list(activityId, pageToken=None, maxResults=None, sortOrder=None)</a></code></p>
85<p class="firstline">List all of the comments for an activity.</p>
86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<h3>Method Details</h3>
90<div class="method">
91 <code class="details" id="get">get(commentId)</code>
92 <pre>Get a comment.
93
94Args:
95 commentId: string, The ID of the comment to get. (required)
96
97Returns:
98 An object of the form:
99
100 {
101 "inReplyTo": [ # The activity this comment replied to.
102 {
103 "url": "A String", # The URL of the activity.
104 "id": "A String", # The ID of the activity.
105 },
106 ],
107 "kind": "plus#comment", # Identifies this resource as a comment. Value: "plus#comment".
108 "plusoners": { # People who +1'd this comment.
109 "totalItems": 42, # Total number of people who +1'd this comment.
110 },
111 "object": { # The object of this comment.
112 "content": "A String", # The HTML-formatted content, suitable for display.
113 "originalContent": "A String", # The content (text) as provided by the author, stored without any HTML formatting. When creating or updating a comment, this value must be supplied as plain text in the request.
114 "objectType": "comment", # The object type of this comment. Possible values are:
115 # - "comment" - A comment in reply to an activity.
116 },
117 "updated": "A String", # The time at which this comment was last updated. Formatted as an RFC 3339 timestamp.
118 "actor": { # The person who posted this comment.
119 "url": "A String", # A link to the Person resource for this actor.
120 "image": { # The image representation of this actor.
121 "url": "A String", # The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
122 },
123 "displayName": "A String", # The name of this actor, suitable for display.
124 "id": "A String", # The ID of the actor.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]125 "verification": { # Verification status of actor.
126 "adHocVerified": "A String", # Verification for one-time or manual processes.
127 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]128 },
129 "verb": "post", # This comment's verb, indicating what action was performed. Possible values are:
130 # - "post" - Publish content to the stream.
131 "etag": "A String", # ETag of this response for caching purposes.
132 "published": "A String", # The time at which this comment was initially published. Formatted as an RFC 3339 timestamp.
133 "id": "A String", # The ID of this comment.
134 "selfLink": "A String", # Link to this comment resource.
135 }</pre>
136</div>
137
138<div class="method">
139 <code class="details" id="insert">insert(activityId, body)</code>
140 <pre>Create a new comment in reply to an activity.
141
142Args:
143 activityId: string, The ID of the activity to reply to. (required)
144 body: object, The request body. (required)
145 The object takes the form of:
146
147{
148 "inReplyTo": [ # The activity this comment replied to.
149 {
150 "url": "A String", # The URL of the activity.
151 "id": "A String", # The ID of the activity.
152 },
153 ],
154 "kind": "plus#comment", # Identifies this resource as a comment. Value: "plus#comment".
155 "plusoners": { # People who +1'd this comment.
156 "totalItems": 42, # Total number of people who +1'd this comment.
157 },
158 "object": { # The object of this comment.
159 "content": "A String", # The HTML-formatted content, suitable for display.
160 "originalContent": "A String", # The content (text) as provided by the author, stored without any HTML formatting. When creating or updating a comment, this value must be supplied as plain text in the request.
161 "objectType": "comment", # The object type of this comment. Possible values are:
162 # - "comment" - A comment in reply to an activity.
163 },
164 "updated": "A String", # The time at which this comment was last updated. Formatted as an RFC 3339 timestamp.
165 "actor": { # The person who posted this comment.
166 "url": "A String", # A link to the Person resource for this actor.
167 "image": { # The image representation of this actor.
168 "url": "A String", # The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
169 },
170 "displayName": "A String", # The name of this actor, suitable for display.
171 "id": "A String", # The ID of the actor.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]172 "verification": { # Verification status of actor.
173 "adHocVerified": "A String", # Verification for one-time or manual processes.
174 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]175 },
176 "verb": "post", # This comment's verb, indicating what action was performed. Possible values are:
177 # - "post" - Publish content to the stream.
178 "etag": "A String", # ETag of this response for caching purposes.
179 "published": "A String", # The time at which this comment was initially published. Formatted as an RFC 3339 timestamp.
180 "id": "A String", # The ID of this comment.
181 "selfLink": "A String", # Link to this comment resource.
182 }
183
184
185Returns:
186 An object of the form:
187
188 {
189 "inReplyTo": [ # The activity this comment replied to.
190 {
191 "url": "A String", # The URL of the activity.
192 "id": "A String", # The ID of the activity.
193 },
194 ],
195 "kind": "plus#comment", # Identifies this resource as a comment. Value: "plus#comment".
196 "plusoners": { # People who +1'd this comment.
197 "totalItems": 42, # Total number of people who +1'd this comment.
198 },
199 "object": { # The object of this comment.
200 "content": "A String", # The HTML-formatted content, suitable for display.
201 "originalContent": "A String", # The content (text) as provided by the author, stored without any HTML formatting. When creating or updating a comment, this value must be supplied as plain text in the request.
202 "objectType": "comment", # The object type of this comment. Possible values are:
203 # - "comment" - A comment in reply to an activity.
204 },
205 "updated": "A String", # The time at which this comment was last updated. Formatted as an RFC 3339 timestamp.
206 "actor": { # The person who posted this comment.
207 "url": "A String", # A link to the Person resource for this actor.
208 "image": { # The image representation of this actor.
209 "url": "A String", # The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
210 },
211 "displayName": "A String", # The name of this actor, suitable for display.
212 "id": "A String", # The ID of the actor.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]213 "verification": { # Verification status of actor.
214 "adHocVerified": "A String", # Verification for one-time or manual processes.
215 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]216 },
217 "verb": "post", # This comment's verb, indicating what action was performed. Possible values are:
218 # - "post" - Publish content to the stream.
219 "etag": "A String", # ETag of this response for caching purposes.
220 "published": "A String", # The time at which this comment was initially published. Formatted as an RFC 3339 timestamp.
221 "id": "A String", # The ID of this comment.
222 "selfLink": "A String", # Link to this comment resource.
223 }</pre>
224</div>
225
226<div class="method">
227 <code class="details" id="list">list(activityId, pageToken=None, maxResults=None, sortOrder=None)</code>
228 <pre>List all of the comments for an activity.
229
230Args:
231 activityId: string, The ID of the activity to get comments for. (required)
232 pageToken: string, The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
233 maxResults: integer, The maximum number of comments to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
234 sortOrder: string, The order in which to sort the list of comments.
235 Allowed values
236 ascending - Sort oldest comments first.
237 descending - Sort newest comments first.
238
239Returns:
240 An object of the form:
241
242 {
243 "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
244 "kind": "plus#commentFeed", # Identifies this resource as a collection of comments. Value: "plus#commentFeed".
245 "title": "A String", # The title of this collection of comments.
246 "items": [ # The comments in this page of results.
247 {
248 "inReplyTo": [ # The activity this comment replied to.
249 {
250 "url": "A String", # The URL of the activity.
251 "id": "A String", # The ID of the activity.
252 },
253 ],
254 "kind": "plus#comment", # Identifies this resource as a comment. Value: "plus#comment".
255 "plusoners": { # People who +1'd this comment.
256 "totalItems": 42, # Total number of people who +1'd this comment.
257 },
258 "object": { # The object of this comment.
259 "content": "A String", # The HTML-formatted content, suitable for display.
260 "originalContent": "A String", # The content (text) as provided by the author, stored without any HTML formatting. When creating or updating a comment, this value must be supplied as plain text in the request.
261 "objectType": "comment", # The object type of this comment. Possible values are:
262 # - "comment" - A comment in reply to an activity.
263 },
264 "updated": "A String", # The time at which this comment was last updated. Formatted as an RFC 3339 timestamp.
265 "actor": { # The person who posted this comment.
266 "url": "A String", # A link to the Person resource for this actor.
267 "image": { # The image representation of this actor.
268 "url": "A String", # The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
269 },
270 "displayName": "A String", # The name of this actor, suitable for display.
271 "id": "A String", # The ID of the actor.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]272 "verification": { # Verification status of actor.
273 "adHocVerified": "A String", # Verification for one-time or manual processes.
274 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]275 },
276 "verb": "post", # This comment's verb, indicating what action was performed. Possible values are:
277 # - "post" - Publish content to the stream.
278 "etag": "A String", # ETag of this response for caching purposes.
279 "published": "A String", # The time at which this comment was initially published. Formatted as an RFC 3339 timestamp.
280 "id": "A String", # The ID of this comment.
281 "selfLink": "A String", # Link to this comment resource.
282 },
283 ],
284 "updated": "A String", # The time at which this collection of comments was last updated. Formatted as an RFC 3339 timestamp.
285 "nextLink": "A String", # Link to the next page of activities.
286 "etag": "A String", # ETag of this response for caching purposes.
287 "id": "A String", # The ID of this collection of comments.
288 }</pre>
289</div>
290
291<div class="method">
292 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
293 <pre>Retrieves the next page of results.
294
295Args:
296 previous_request: The request for the previous page. (required)
297 previous_response: The response from the request for the previous page. (required)
298
299Returns:
300 A request object that you can call 'execute()' on to request the next
301 page. Returns None if there are no more items in the collection.
302 </pre>
303</div>
304
305</body></html>