Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / db5a0ed106aff656a031a99ad64780ffd88c8425 / . / docs / dyn / drive_v2.comments.html
blob: 6cbeaa7fc69d958f15493bc819745f1a430fde37 [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="drive_v2.html">Drive API</a> . <a href="drive_v2.comments.html">comments</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(fileId, commentId)</a></code></p>
79<p class="firstline">Deletes a comment.</p>
80<p class="toc_element">
81 <code><a href="#get">get(fileId, commentId, includeDeleted=None)</a></code></p>
82<p class="firstline">Gets a comment by ID.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(fileId, body)</a></code></p>
85<p class="firstline">Creates a new comment on the given file.</p>
86<p class="toc_element">
87 <code><a href="#list">list(fileId, includeDeleted=None, pageToken=None, updatedMin=None, maxResults=None)</a></code></p>
88<p class="firstline">Lists a file's comments.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93 <code><a href="#patch">patch(fileId, commentId, body)</a></code></p>
94<p class="firstline">Updates an existing comment. This method supports patch semantics.</p>
95<p class="toc_element">
96 <code><a href="#update">update(fileId, commentId, body)</a></code></p>
97<p class="firstline">Updates an existing comment.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="delete">delete(fileId, commentId)</code>
101 <pre>Deletes a comment.
102
103Args:
104 fileId: string, The ID of the file. (required)
105 commentId: string, The ID of the comment. (required)
106</pre>
107</div>
108
109<div class="method">
110 <code class="details" id="get">get(fileId, commentId, includeDeleted=None)</code>
111 <pre>Gets a comment by ID.
112
113Args:
114 fileId: string, The ID of the file. (required)
115 commentId: string, The ID of the comment. (required)
116 includeDeleted: boolean, If set, this will succeed when retrieving a deleted comment, and will include any deleted replies.
117
118Returns:
119 An object of the form:
120
121 { # A JSON representation of a comment on a file in Google Drive.
122 "status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
123 # - "open" - The comment is still open.
124 # - "resolved" - The comment has been resolved by one of its replies.
125 "selfLink": "A String", # A link back to this comment.
126 "kind": "drive#comment", # This is always drive#comment.
127 "author": { # The JSON template for a user. # The user who wrote this comment.
128 "picture": { # The user's profile picture.
129 "url": "A String", # A URL that points to a profile picture of this user.
130 },
131 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]132 "displayName": "A String", # A plain text displayable name for this user.
133 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]134 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
135 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]136 },
137 "deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
138 "replies": [ # Replies to this post.
139 { # A JSON representation of a reply to a comment on a file in Google Drive.
140 "kind": "drive#commentReply", # This is always drive#commentReply.
141 "author": { # The JSON template for a user. # The user who wrote this reply.
142 "picture": { # The user's profile picture.
143 "url": "A String", # A URL that points to a profile picture of this user.
144 },
145 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]146 "displayName": "A String", # A plain text displayable name for this user.
147 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]148 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
149 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]150 },
151 "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
152 "htmlContent": "A String", # HTML formatted content for this reply.
153 "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
154 "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
155 # - "resolve" - To resolve a comment.
156 # - "reopen" - To reopen (un-resolve) a comment.
157 "replyId": "A String", # The ID of the reply.
158 "modifiedDate": "A String", # The date when this reply was last modified.
159 "createdDate": "A String", # The date when this reply was first created.
160 },
161 ],
162 "htmlContent": "A String", # HTML formatted content for this comment.
163 "content": "A String", # The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content.
164 "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
165 "context": { # The context of the file which is being commented on.
166 "type": "A String", # The MIME type of the context snippet.
167 "value": "A String", # Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about.
168 },
169 "createdDate": "A String", # The date when this comment was first created.
170 "commentId": "A String", # The ID of the comment.
171 "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
172 "fileTitle": "A String", # The title of the file which this comment is addressing.
173 "fileId": "A String", # The file which this comment is addressing.
174 }</pre>
175</div>
176
177<div class="method">
178 <code class="details" id="insert">insert(fileId, body)</code>
179 <pre>Creates a new comment on the given file.
180
181Args:
182 fileId: string, The ID of the file. (required)
183 body: object, The request body. (required)
184 The object takes the form of:
185
186{ # A JSON representation of a comment on a file in Google Drive.
187 "status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
188 # - "open" - The comment is still open.
189 # - "resolved" - The comment has been resolved by one of its replies.
190 "selfLink": "A String", # A link back to this comment.
191 "kind": "drive#comment", # This is always drive#comment.
192 "author": { # The JSON template for a user. # The user who wrote this comment.
193 "picture": { # The user's profile picture.
194 "url": "A String", # A URL that points to a profile picture of this user.
195 },
196 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]197 "displayName": "A String", # A plain text displayable name for this user.
198 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]199 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
200 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]201 },
202 "deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
203 "replies": [ # Replies to this post.
204 { # A JSON representation of a reply to a comment on a file in Google Drive.
205 "kind": "drive#commentReply", # This is always drive#commentReply.
206 "author": { # The JSON template for a user. # The user who wrote this reply.
207 "picture": { # The user's profile picture.
208 "url": "A String", # A URL that points to a profile picture of this user.
209 },
210 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]211 "displayName": "A String", # A plain text displayable name for this user.
212 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]213 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
214 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]215 },
216 "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
217 "htmlContent": "A String", # HTML formatted content for this reply.
218 "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
219 "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
220 # - "resolve" - To resolve a comment.
221 # - "reopen" - To reopen (un-resolve) a comment.
222 "replyId": "A String", # The ID of the reply.
223 "modifiedDate": "A String", # The date when this reply was last modified.
224 "createdDate": "A String", # The date when this reply was first created.
225 },
226 ],
227 "htmlContent": "A String", # HTML formatted content for this comment.
228 "content": "A String", # The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content.
229 "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
230 "context": { # The context of the file which is being commented on.
231 "type": "A String", # The MIME type of the context snippet.
232 "value": "A String", # Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about.
233 },
234 "createdDate": "A String", # The date when this comment was first created.
235 "commentId": "A String", # The ID of the comment.
236 "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
237 "fileTitle": "A String", # The title of the file which this comment is addressing.
238 "fileId": "A String", # The file which this comment is addressing.
239 }
240
241
242Returns:
243 An object of the form:
244
245 { # A JSON representation of a comment on a file in Google Drive.
246 "status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
247 # - "open" - The comment is still open.
248 # - "resolved" - The comment has been resolved by one of its replies.
249 "selfLink": "A String", # A link back to this comment.
250 "kind": "drive#comment", # This is always drive#comment.
251 "author": { # The JSON template for a user. # The user who wrote this comment.
252 "picture": { # The user's profile picture.
253 "url": "A String", # A URL that points to a profile picture of this user.
254 },
255 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]256 "displayName": "A String", # A plain text displayable name for this user.
257 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]258 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
259 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]260 },
261 "deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
262 "replies": [ # Replies to this post.
263 { # A JSON representation of a reply to a comment on a file in Google Drive.
264 "kind": "drive#commentReply", # This is always drive#commentReply.
265 "author": { # The JSON template for a user. # The user who wrote this reply.
266 "picture": { # The user's profile picture.
267 "url": "A String", # A URL that points to a profile picture of this user.
268 },
269 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]270 "displayName": "A String", # A plain text displayable name for this user.
271 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]272 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
273 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]274 },
275 "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
276 "htmlContent": "A String", # HTML formatted content for this reply.
277 "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
278 "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
279 # - "resolve" - To resolve a comment.
280 # - "reopen" - To reopen (un-resolve) a comment.
281 "replyId": "A String", # The ID of the reply.
282 "modifiedDate": "A String", # The date when this reply was last modified.
283 "createdDate": "A String", # The date when this reply was first created.
284 },
285 ],
286 "htmlContent": "A String", # HTML formatted content for this comment.
287 "content": "A String", # The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content.
288 "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
289 "context": { # The context of the file which is being commented on.
290 "type": "A String", # The MIME type of the context snippet.
291 "value": "A String", # Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about.
292 },
293 "createdDate": "A String", # The date when this comment was first created.
294 "commentId": "A String", # The ID of the comment.
295 "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
296 "fileTitle": "A String", # The title of the file which this comment is addressing.
297 "fileId": "A String", # The file which this comment is addressing.
298 }</pre>
299</div>
300
301<div class="method">
302 <code class="details" id="list">list(fileId, includeDeleted=None, pageToken=None, updatedMin=None, maxResults=None)</code>
303 <pre>Lists a file's comments.
304
305Args:
306 fileId: string, The ID of the file. (required)
307 includeDeleted: boolean, If set, all comments and replies, including deleted comments and replies (with content stripped) will be returned.
308 pageToken: string, The continuation token, 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.
309 updatedMin: string, Only discussions that were updated after this timestamp will be returned. Formatted as an RFC 3339 timestamp.
310 maxResults: integer, The maximum number of discussions to include in the response, used for paging.
311
312Returns:
313 An object of the form:
314
315 { # A JSON representation of a list of comments on a file in Google Drive.
316 "nextPageToken": "A String", # The token to use to request the next page of results.
317 "items": [ # List of comments.
318 { # A JSON representation of a comment on a file in Google Drive.
319 "status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
320 # - "open" - The comment is still open.
321 # - "resolved" - The comment has been resolved by one of its replies.
322 "selfLink": "A String", # A link back to this comment.
323 "kind": "drive#comment", # This is always drive#comment.
324 "author": { # The JSON template for a user. # The user who wrote this comment.
325 "picture": { # The user's profile picture.
326 "url": "A String", # A URL that points to a profile picture of this user.
327 },
328 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]329 "displayName": "A String", # A plain text displayable name for this user.
330 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]331 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
332 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]333 },
334 "deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
335 "replies": [ # Replies to this post.
336 { # A JSON representation of a reply to a comment on a file in Google Drive.
337 "kind": "drive#commentReply", # This is always drive#commentReply.
338 "author": { # The JSON template for a user. # The user who wrote this reply.
339 "picture": { # The user's profile picture.
340 "url": "A String", # A URL that points to a profile picture of this user.
341 },
342 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]343 "displayName": "A String", # A plain text displayable name for this user.
344 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]345 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
346 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]347 },
348 "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
349 "htmlContent": "A String", # HTML formatted content for this reply.
350 "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
351 "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
352 # - "resolve" - To resolve a comment.
353 # - "reopen" - To reopen (un-resolve) a comment.
354 "replyId": "A String", # The ID of the reply.
355 "modifiedDate": "A String", # The date when this reply was last modified.
356 "createdDate": "A String", # The date when this reply was first created.
357 },
358 ],
359 "htmlContent": "A String", # HTML formatted content for this comment.
360 "content": "A String", # The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content.
361 "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
362 "context": { # The context of the file which is being commented on.
363 "type": "A String", # The MIME type of the context snippet.
364 "value": "A String", # Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about.
365 },
366 "createdDate": "A String", # The date when this comment was first created.
367 "commentId": "A String", # The ID of the comment.
368 "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
369 "fileTitle": "A String", # The title of the file which this comment is addressing.
370 "fileId": "A String", # The file which this comment is addressing.
371 },
372 ],
373 "kind": "drive#commentList", # This is always drive#commentList.
374 "selfLink": "A String", # A link back to this list.
375 "nextLink": "A String", # A link to the next page of comments.
376 }</pre>
377</div>
378
379<div class="method">
380 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
381 <pre>Retrieves the next page of results.
382
383Args:
384 previous_request: The request for the previous page. (required)
385 previous_response: The response from the request for the previous page. (required)
386
387Returns:
388 A request object that you can call 'execute()' on to request the next
389 page. Returns None if there are no more items in the collection.
390 </pre>
391</div>
392
393<div class="method">
394 <code class="details" id="patch">patch(fileId, commentId, body)</code>
395 <pre>Updates an existing comment. This method supports patch semantics.
396
397Args:
398 fileId: string, The ID of the file. (required)
399 commentId: string, The ID of the comment. (required)
400 body: object, The request body. (required)
401 The object takes the form of:
402
403{ # A JSON representation of a comment on a file in Google Drive.
404 "status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
405 # - "open" - The comment is still open.
406 # - "resolved" - The comment has been resolved by one of its replies.
407 "selfLink": "A String", # A link back to this comment.
408 "kind": "drive#comment", # This is always drive#comment.
409 "author": { # The JSON template for a user. # The user who wrote this comment.
410 "picture": { # The user's profile picture.
411 "url": "A String", # A URL that points to a profile picture of this user.
412 },
413 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]414 "displayName": "A String", # A plain text displayable name for this user.
415 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]416 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
417 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]418 },
419 "deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
420 "replies": [ # Replies to this post.
421 { # A JSON representation of a reply to a comment on a file in Google Drive.
422 "kind": "drive#commentReply", # This is always drive#commentReply.
423 "author": { # The JSON template for a user. # The user who wrote this reply.
424 "picture": { # The user's profile picture.
425 "url": "A String", # A URL that points to a profile picture of this user.
426 },
427 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]428 "displayName": "A String", # A plain text displayable name for this user.
429 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]430 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
431 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]432 },
433 "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
434 "htmlContent": "A String", # HTML formatted content for this reply.
435 "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
436 "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
437 # - "resolve" - To resolve a comment.
438 # - "reopen" - To reopen (un-resolve) a comment.
439 "replyId": "A String", # The ID of the reply.
440 "modifiedDate": "A String", # The date when this reply was last modified.
441 "createdDate": "A String", # The date when this reply was first created.
442 },
443 ],
444 "htmlContent": "A String", # HTML formatted content for this comment.
445 "content": "A String", # The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content.
446 "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
447 "context": { # The context of the file which is being commented on.
448 "type": "A String", # The MIME type of the context snippet.
449 "value": "A String", # Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about.
450 },
451 "createdDate": "A String", # The date when this comment was first created.
452 "commentId": "A String", # The ID of the comment.
453 "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
454 "fileTitle": "A String", # The title of the file which this comment is addressing.
455 "fileId": "A String", # The file which this comment is addressing.
456 }
457
458
459Returns:
460 An object of the form:
461
462 { # A JSON representation of a comment on a file in Google Drive.
463 "status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
464 # - "open" - The comment is still open.
465 # - "resolved" - The comment has been resolved by one of its replies.
466 "selfLink": "A String", # A link back to this comment.
467 "kind": "drive#comment", # This is always drive#comment.
468 "author": { # The JSON template for a user. # The user who wrote this comment.
469 "picture": { # The user's profile picture.
470 "url": "A String", # A URL that points to a profile picture of this user.
471 },
472 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]473 "displayName": "A String", # A plain text displayable name for this user.
474 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]475 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
476 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]477 },
478 "deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
479 "replies": [ # Replies to this post.
480 { # A JSON representation of a reply to a comment on a file in Google Drive.
481 "kind": "drive#commentReply", # This is always drive#commentReply.
482 "author": { # The JSON template for a user. # The user who wrote this reply.
483 "picture": { # The user's profile picture.
484 "url": "A String", # A URL that points to a profile picture of this user.
485 },
486 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]487 "displayName": "A String", # A plain text displayable name for this user.
488 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]489 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
490 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]491 },
492 "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
493 "htmlContent": "A String", # HTML formatted content for this reply.
494 "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
495 "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
496 # - "resolve" - To resolve a comment.
497 # - "reopen" - To reopen (un-resolve) a comment.
498 "replyId": "A String", # The ID of the reply.
499 "modifiedDate": "A String", # The date when this reply was last modified.
500 "createdDate": "A String", # The date when this reply was first created.
501 },
502 ],
503 "htmlContent": "A String", # HTML formatted content for this comment.
504 "content": "A String", # The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content.
505 "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
506 "context": { # The context of the file which is being commented on.
507 "type": "A String", # The MIME type of the context snippet.
508 "value": "A String", # Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about.
509 },
510 "createdDate": "A String", # The date when this comment was first created.
511 "commentId": "A String", # The ID of the comment.
512 "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
513 "fileTitle": "A String", # The title of the file which this comment is addressing.
514 "fileId": "A String", # The file which this comment is addressing.
515 }</pre>
516</div>
517
518<div class="method">
519 <code class="details" id="update">update(fileId, commentId, body)</code>
520 <pre>Updates an existing comment.
521
522Args:
523 fileId: string, The ID of the file. (required)
524 commentId: string, The ID of the comment. (required)
525 body: object, The request body. (required)
526 The object takes the form of:
527
528{ # A JSON representation of a comment on a file in Google Drive.
529 "status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
530 # - "open" - The comment is still open.
531 # - "resolved" - The comment has been resolved by one of its replies.
532 "selfLink": "A String", # A link back to this comment.
533 "kind": "drive#comment", # This is always drive#comment.
534 "author": { # The JSON template for a user. # The user who wrote this comment.
535 "picture": { # The user's profile picture.
536 "url": "A String", # A URL that points to a profile picture of this user.
537 },
538 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]539 "displayName": "A String", # A plain text displayable name for this user.
540 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]541 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
542 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]543 },
544 "deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
545 "replies": [ # Replies to this post.
546 { # A JSON representation of a reply to a comment on a file in Google Drive.
547 "kind": "drive#commentReply", # This is always drive#commentReply.
548 "author": { # The JSON template for a user. # The user who wrote this reply.
549 "picture": { # The user's profile picture.
550 "url": "A String", # A URL that points to a profile picture of this user.
551 },
552 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]553 "displayName": "A String", # A plain text displayable name for this user.
554 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]555 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
556 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]557 },
558 "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
559 "htmlContent": "A String", # HTML formatted content for this reply.
560 "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
561 "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
562 # - "resolve" - To resolve a comment.
563 # - "reopen" - To reopen (un-resolve) a comment.
564 "replyId": "A String", # The ID of the reply.
565 "modifiedDate": "A String", # The date when this reply was last modified.
566 "createdDate": "A String", # The date when this reply was first created.
567 },
568 ],
569 "htmlContent": "A String", # HTML formatted content for this comment.
570 "content": "A String", # The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content.
571 "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
572 "context": { # The context of the file which is being commented on.
573 "type": "A String", # The MIME type of the context snippet.
574 "value": "A String", # Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about.
575 },
576 "createdDate": "A String", # The date when this comment was first created.
577 "commentId": "A String", # The ID of the comment.
578 "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
579 "fileTitle": "A String", # The title of the file which this comment is addressing.
580 "fileId": "A String", # The file which this comment is addressing.
581 }
582
583
584Returns:
585 An object of the form:
586
587 { # A JSON representation of a comment on a file in Google Drive.
588 "status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
589 # - "open" - The comment is still open.
590 # - "resolved" - The comment has been resolved by one of its replies.
591 "selfLink": "A String", # A link back to this comment.
592 "kind": "drive#comment", # This is always drive#comment.
593 "author": { # The JSON template for a user. # The user who wrote this comment.
594 "picture": { # The user's profile picture.
595 "url": "A String", # A URL that points to a profile picture of this user.
596 },
597 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]598 "displayName": "A String", # A plain text displayable name for this user.
599 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]600 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
601 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]602 },
603 "deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
604 "replies": [ # Replies to this post.
605 { # A JSON representation of a reply to a comment on a file in Google Drive.
606 "kind": "drive#commentReply", # This is always drive#commentReply.
607 "author": { # The JSON template for a user. # The user who wrote this reply.
608 "picture": { # The user's profile picture.
609 "url": "A String", # A URL that points to a profile picture of this user.
610 },
611 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]612 "displayName": "A String", # A plain text displayable name for this user.
613 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]614 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
615 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]616 },
617 "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
618 "htmlContent": "A String", # HTML formatted content for this reply.
619 "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
620 "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
621 # - "resolve" - To resolve a comment.
622 # - "reopen" - To reopen (un-resolve) a comment.
623 "replyId": "A String", # The ID of the reply.
624 "modifiedDate": "A String", # The date when this reply was last modified.
625 "createdDate": "A String", # The date when this reply was first created.
626 },
627 ],
628 "htmlContent": "A String", # HTML formatted content for this comment.
629 "content": "A String", # The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content.
630 "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
631 "context": { # The context of the file which is being commented on.
632 "type": "A String", # The MIME type of the context snippet.
633 "value": "A String", # Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about.
634 },
635 "createdDate": "A String", # The date when this comment was first created.
636 "commentId": "A String", # The ID of the comment.
637 "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
638 "fileTitle": "A String", # The title of the file which this comment is addressing.
639 "fileId": "A String", # The file which this comment is addressing.
640 }</pre>
641</div>
642
643</body></html>