Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 614db98bf45b9da1f29c35a9d942536111e99d41 / . / docs / dyn / plusDomains_v1.comments.html
blob: 6aefd3f5e59d4f48a141d9352e0f8156a30ef853 [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.
125 },
126 "verb": "post", # This comment's verb, indicating what action was performed. Possible values are:
127 # - "post" - Publish content to the stream.
128 "etag": "A String", # ETag of this response for caching purposes.
129 "published": "A String", # The time at which this comment was initially published. Formatted as an RFC 3339 timestamp.
130 "id": "A String", # The ID of this comment.
131 "selfLink": "A String", # Link to this comment resource.
132 }</pre>
133</div>
134
135<div class="method">
136 <code class="details" id="insert">insert(activityId, body)</code>
137 <pre>Create a new comment in reply to an activity.
138
139Args:
140 activityId: string, The ID of the activity to reply to. (required)
141 body: object, The request body. (required)
142 The object takes the form of:
143
144{
145 "inReplyTo": [ # The activity this comment replied to.
146 {
147 "url": "A String", # The URL of the activity.
148 "id": "A String", # The ID of the activity.
149 },
150 ],
151 "kind": "plus#comment", # Identifies this resource as a comment. Value: "plus#comment".
152 "plusoners": { # People who +1'd this comment.
153 "totalItems": 42, # Total number of people who +1'd this comment.
154 },
155 "object": { # The object of this comment.
156 "content": "A String", # The HTML-formatted content, suitable for display.
157 "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.
158 "objectType": "comment", # The object type of this comment. Possible values are:
159 # - "comment" - A comment in reply to an activity.
160 },
161 "updated": "A String", # The time at which this comment was last updated. Formatted as an RFC 3339 timestamp.
162 "actor": { # The person who posted this comment.
163 "url": "A String", # A link to the Person resource for this actor.
164 "image": { # The image representation of this actor.
165 "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.
166 },
167 "displayName": "A String", # The name of this actor, suitable for display.
168 "id": "A String", # The ID of the actor.
169 },
170 "verb": "post", # This comment's verb, indicating what action was performed. Possible values are:
171 # - "post" - Publish content to the stream.
172 "etag": "A String", # ETag of this response for caching purposes.
173 "published": "A String", # The time at which this comment was initially published. Formatted as an RFC 3339 timestamp.
174 "id": "A String", # The ID of this comment.
175 "selfLink": "A String", # Link to this comment resource.
176 }
177
178
179Returns:
180 An object of the form:
181
182 {
183 "inReplyTo": [ # The activity this comment replied to.
184 {
185 "url": "A String", # The URL of the activity.
186 "id": "A String", # The ID of the activity.
187 },
188 ],
189 "kind": "plus#comment", # Identifies this resource as a comment. Value: "plus#comment".
190 "plusoners": { # People who +1'd this comment.
191 "totalItems": 42, # Total number of people who +1'd this comment.
192 },
193 "object": { # The object of this comment.
194 "content": "A String", # The HTML-formatted content, suitable for display.
195 "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.
196 "objectType": "comment", # The object type of this comment. Possible values are:
197 # - "comment" - A comment in reply to an activity.
198 },
199 "updated": "A String", # The time at which this comment was last updated. Formatted as an RFC 3339 timestamp.
200 "actor": { # The person who posted this comment.
201 "url": "A String", # A link to the Person resource for this actor.
202 "image": { # The image representation of this actor.
203 "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.
204 },
205 "displayName": "A String", # The name of this actor, suitable for display.
206 "id": "A String", # The ID of the actor.
207 },
208 "verb": "post", # This comment's verb, indicating what action was performed. Possible values are:
209 # - "post" - Publish content to the stream.
210 "etag": "A String", # ETag of this response for caching purposes.
211 "published": "A String", # The time at which this comment was initially published. Formatted as an RFC 3339 timestamp.
212 "id": "A String", # The ID of this comment.
213 "selfLink": "A String", # Link to this comment resource.
214 }</pre>
215</div>
216
217<div class="method">
218 <code class="details" id="list">list(activityId, pageToken=None, maxResults=None, sortOrder=None)</code>
219 <pre>List all of the comments for an activity.
220
221Args:
222 activityId: string, The ID of the activity to get comments for. (required)
223 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.
224 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.
225 sortOrder: string, The order in which to sort the list of comments.
226 Allowed values
227 ascending - Sort oldest comments first.
228 descending - Sort newest comments first.
229
230Returns:
231 An object of the form:
232
233 {
234 "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.
235 "kind": "plus#commentFeed", # Identifies this resource as a collection of comments. Value: "plus#commentFeed".
236 "title": "A String", # The title of this collection of comments.
237 "items": [ # The comments in this page of results.
238 {
239 "inReplyTo": [ # The activity this comment replied to.
240 {
241 "url": "A String", # The URL of the activity.
242 "id": "A String", # The ID of the activity.
243 },
244 ],
245 "kind": "plus#comment", # Identifies this resource as a comment. Value: "plus#comment".
246 "plusoners": { # People who +1'd this comment.
247 "totalItems": 42, # Total number of people who +1'd this comment.
248 },
249 "object": { # The object of this comment.
250 "content": "A String", # The HTML-formatted content, suitable for display.
251 "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.
252 "objectType": "comment", # The object type of this comment. Possible values are:
253 # - "comment" - A comment in reply to an activity.
254 },
255 "updated": "A String", # The time at which this comment was last updated. Formatted as an RFC 3339 timestamp.
256 "actor": { # The person who posted this comment.
257 "url": "A String", # A link to the Person resource for this actor.
258 "image": { # The image representation of this actor.
259 "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.
260 },
261 "displayName": "A String", # The name of this actor, suitable for display.
262 "id": "A String", # The ID of the actor.
263 },
264 "verb": "post", # This comment's verb, indicating what action was performed. Possible values are:
265 # - "post" - Publish content to the stream.
266 "etag": "A String", # ETag of this response for caching purposes.
267 "published": "A String", # The time at which this comment was initially published. Formatted as an RFC 3339 timestamp.
268 "id": "A String", # The ID of this comment.
269 "selfLink": "A String", # Link to this comment resource.
270 },
271 ],
272 "updated": "A String", # The time at which this collection of comments was last updated. Formatted as an RFC 3339 timestamp.
273 "nextLink": "A String", # Link to the next page of activities.
274 "etag": "A String", # ETag of this response for caching purposes.
275 "id": "A String", # The ID of this collection of comments.
276 }</pre>
277</div>
278
279<div class="method">
280 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
281 <pre>Retrieves the next page of results.
282
283Args:
284 previous_request: The request for the previous page. (required)
285 previous_response: The response from the request for the previous page. (required)
286
287Returns:
288 A request object that you can call 'execute()' on to request the next
289 page. Returns None if there are no more items in the collection.
290 </pre>
291</div>
292
293</body></html>