Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f7b648f5281e17dfee86fe8eb048d5ff0a19ca81 / . / docs / dyn / drive_v2.comments.html
blob: 945d2c4bb37bac593b62e28cf7d75178677d74dc [file] [log] [blame]
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[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.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]122 "status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]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.
132 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
133 "displayName": "A String", # A plain text displayable name for this user.
134 },
135 "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.
136 "replies": [ # Replies to this post.
137 { # A JSON representation of a reply to a comment on a file in Google Drive.
138 "kind": "drive#commentReply", # This is always drive#commentReply.
139 "author": { # The JSON template for a user. # The user who wrote this reply.
140 "picture": { # The user's profile picture.
141 "url": "A String", # A URL that points to a profile picture of this user.
142 },
143 "kind": "drive#user", # This is always drive#user.
144 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
145 "displayName": "A String", # A plain text displayable name for this user.
146 },
147 "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.
148 "htmlContent": "A String", # HTML formatted content for this reply.
149 "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).
150 "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:
151 # - "resolve" - To resolve a comment.
152 # - "reopen" - To reopen (un-resolve) a comment.
153 "replyId": "A String", # The ID of the reply.
154 "modifiedDate": "A String", # The date when this reply was last modified.
155 "createdDate": "A String", # The date when this reply was first created.
156 },
157 ],
158 "htmlContent": "A String", # HTML formatted content for this comment.
159 "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.
160 "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
161 "context": { # The context of the file which is being commented on.
162 "type": "A String", # The MIME type of the context snippet.
163 "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.
164 },
165 "createdDate": "A String", # The date when this comment was first created.
166 "commentId": "A String", # The ID of the comment.
167 "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.
168 "fileTitle": "A String", # The title of the file which this comment is addressing.
169 "fileId": "A String", # The file which this comment is addressing.
170 }</pre>
171</div>
172
173<div class="method">
174 <code class="details" id="insert">insert(fileId, body)</code>
175 <pre>Creates a new comment on the given file.
176
177Args:
178 fileId: string, The ID of the file. (required)
179 body: object, The request body. (required)
180 The object takes the form of:
181
182{ # A JSON representation of a comment on a file in Google Drive.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]183 "status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]184 # - "open" - The comment is still open.
185 # - "resolved" - The comment has been resolved by one of its replies.
186 "selfLink": "A String", # A link back to this comment.
187 "kind": "drive#comment", # This is always drive#comment.
188 "author": { # The JSON template for a user. # The user who wrote this comment.
189 "picture": { # The user's profile picture.
190 "url": "A String", # A URL that points to a profile picture of this user.
191 },
192 "kind": "drive#user", # This is always drive#user.
193 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
194 "displayName": "A String", # A plain text displayable name for this user.
195 },
196 "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.
197 "replies": [ # Replies to this post.
198 { # A JSON representation of a reply to a comment on a file in Google Drive.
199 "kind": "drive#commentReply", # This is always drive#commentReply.
200 "author": { # The JSON template for a user. # The user who wrote this reply.
201 "picture": { # The user's profile picture.
202 "url": "A String", # A URL that points to a profile picture of this user.
203 },
204 "kind": "drive#user", # This is always drive#user.
205 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
206 "displayName": "A String", # A plain text displayable name for this user.
207 },
208 "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.
209 "htmlContent": "A String", # HTML formatted content for this reply.
210 "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).
211 "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:
212 # - "resolve" - To resolve a comment.
213 # - "reopen" - To reopen (un-resolve) a comment.
214 "replyId": "A String", # The ID of the reply.
215 "modifiedDate": "A String", # The date when this reply was last modified.
216 "createdDate": "A String", # The date when this reply was first created.
217 },
218 ],
219 "htmlContent": "A String", # HTML formatted content for this comment.
220 "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.
221 "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
222 "context": { # The context of the file which is being commented on.
223 "type": "A String", # The MIME type of the context snippet.
224 "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.
225 },
226 "createdDate": "A String", # The date when this comment was first created.
227 "commentId": "A String", # The ID of the comment.
228 "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.
229 "fileTitle": "A String", # The title of the file which this comment is addressing.
230 "fileId": "A String", # The file which this comment is addressing.
231 }
232
233
234Returns:
235 An object of the form:
236
237 { # A JSON representation of a comment on a file in Google Drive.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]238 "status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]239 # - "open" - The comment is still open.
240 # - "resolved" - The comment has been resolved by one of its replies.
241 "selfLink": "A String", # A link back to this comment.
242 "kind": "drive#comment", # This is always drive#comment.
243 "author": { # The JSON template for a user. # The user who wrote this comment.
244 "picture": { # The user's profile picture.
245 "url": "A String", # A URL that points to a profile picture of this user.
246 },
247 "kind": "drive#user", # This is always drive#user.
248 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
249 "displayName": "A String", # A plain text displayable name for this user.
250 },
251 "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.
252 "replies": [ # Replies to this post.
253 { # A JSON representation of a reply to a comment on a file in Google Drive.
254 "kind": "drive#commentReply", # This is always drive#commentReply.
255 "author": { # The JSON template for a user. # The user who wrote this reply.
256 "picture": { # The user's profile picture.
257 "url": "A String", # A URL that points to a profile picture of this user.
258 },
259 "kind": "drive#user", # This is always drive#user.
260 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
261 "displayName": "A String", # A plain text displayable name for this user.
262 },
263 "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.
264 "htmlContent": "A String", # HTML formatted content for this reply.
265 "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).
266 "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:
267 # - "resolve" - To resolve a comment.
268 # - "reopen" - To reopen (un-resolve) a comment.
269 "replyId": "A String", # The ID of the reply.
270 "modifiedDate": "A String", # The date when this reply was last modified.
271 "createdDate": "A String", # The date when this reply was first created.
272 },
273 ],
274 "htmlContent": "A String", # HTML formatted content for this comment.
275 "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.
276 "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
277 "context": { # The context of the file which is being commented on.
278 "type": "A String", # The MIME type of the context snippet.
279 "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.
280 },
281 "createdDate": "A String", # The date when this comment was first created.
282 "commentId": "A String", # The ID of the comment.
283 "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.
284 "fileTitle": "A String", # The title of the file which this comment is addressing.
285 "fileId": "A String", # The file which this comment is addressing.
286 }</pre>
287</div>
288
289<div class="method">
290 <code class="details" id="list">list(fileId, includeDeleted=None, pageToken=None, updatedMin=None, maxResults=None)</code>
291 <pre>Lists a file's comments.
292
293Args:
294 fileId: string, The ID of the file. (required)
295 includeDeleted: boolean, If set, all comments and replies, including deleted comments and replies (with content stripped) will be returned.
296 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.
297 updatedMin: string, Only discussions that were updated after this timestamp will be returned. Formatted as an RFC 3339 timestamp.
298 maxResults: integer, The maximum number of discussions to include in the response, used for paging.
299
300Returns:
301 An object of the form:
302
303 { # A JSON representation of a list of comments on a file in Google Drive.
304 "nextPageToken": "A String", # The token to use to request the next page of results.
305 "items": [ # List of comments.
306 { # A JSON representation of a comment on a file in Google Drive.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]307 "status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]308 # - "open" - The comment is still open.
309 # - "resolved" - The comment has been resolved by one of its replies.
310 "selfLink": "A String", # A link back to this comment.
311 "kind": "drive#comment", # This is always drive#comment.
312 "author": { # The JSON template for a user. # The user who wrote this comment.
313 "picture": { # The user's profile picture.
314 "url": "A String", # A URL that points to a profile picture of this user.
315 },
316 "kind": "drive#user", # This is always drive#user.
317 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
318 "displayName": "A String", # A plain text displayable name for this user.
319 },
320 "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.
321 "replies": [ # Replies to this post.
322 { # A JSON representation of a reply to a comment on a file in Google Drive.
323 "kind": "drive#commentReply", # This is always drive#commentReply.
324 "author": { # The JSON template for a user. # The user who wrote this reply.
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.
329 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
330 "displayName": "A String", # A plain text displayable name for this user.
331 },
332 "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.
333 "htmlContent": "A String", # HTML formatted content for this reply.
334 "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).
335 "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:
336 # - "resolve" - To resolve a comment.
337 # - "reopen" - To reopen (un-resolve) a comment.
338 "replyId": "A String", # The ID of the reply.
339 "modifiedDate": "A String", # The date when this reply was last modified.
340 "createdDate": "A String", # The date when this reply was first created.
341 },
342 ],
343 "htmlContent": "A String", # HTML formatted content for this comment.
344 "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.
345 "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
346 "context": { # The context of the file which is being commented on.
347 "type": "A String", # The MIME type of the context snippet.
348 "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.
349 },
350 "createdDate": "A String", # The date when this comment was first created.
351 "commentId": "A String", # The ID of the comment.
352 "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.
353 "fileTitle": "A String", # The title of the file which this comment is addressing.
354 "fileId": "A String", # The file which this comment is addressing.
355 },
356 ],
357 "kind": "drive#commentList", # This is always drive#commentList.
358 }</pre>
359</div>
360
361<div class="method">
362 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
363 <pre>Retrieves the next page of results.
364
365Args:
366 previous_request: The request for the previous page. (required)
367 previous_response: The response from the request for the previous page. (required)
368
369Returns:
370 A request object that you can call 'execute()' on to request the next
371 page. Returns None if there are no more items in the collection.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]372 </pre>
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]373</div>
374
375<div class="method">
376 <code class="details" id="patch">patch(fileId, commentId, body)</code>
377 <pre>Updates an existing comment. This method supports patch semantics.
378
379Args:
380 fileId: string, The ID of the file. (required)
381 commentId: string, The ID of the comment. (required)
382 body: object, The request body. (required)
383 The object takes the form of:
384
385{ # A JSON representation of a comment on a file in Google Drive.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]386 "status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]387 # - "open" - The comment is still open.
388 # - "resolved" - The comment has been resolved by one of its replies.
389 "selfLink": "A String", # A link back to this comment.
390 "kind": "drive#comment", # This is always drive#comment.
391 "author": { # The JSON template for a user. # The user who wrote this comment.
392 "picture": { # The user's profile picture.
393 "url": "A String", # A URL that points to a profile picture of this user.
394 },
395 "kind": "drive#user", # This is always drive#user.
396 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
397 "displayName": "A String", # A plain text displayable name for this user.
398 },
399 "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.
400 "replies": [ # Replies to this post.
401 { # A JSON representation of a reply to a comment on a file in Google Drive.
402 "kind": "drive#commentReply", # This is always drive#commentReply.
403 "author": { # The JSON template for a user. # The user who wrote this reply.
404 "picture": { # The user's profile picture.
405 "url": "A String", # A URL that points to a profile picture of this user.
406 },
407 "kind": "drive#user", # This is always drive#user.
408 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
409 "displayName": "A String", # A plain text displayable name for this user.
410 },
411 "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.
412 "htmlContent": "A String", # HTML formatted content for this reply.
413 "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).
414 "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:
415 # - "resolve" - To resolve a comment.
416 # - "reopen" - To reopen (un-resolve) a comment.
417 "replyId": "A String", # The ID of the reply.
418 "modifiedDate": "A String", # The date when this reply was last modified.
419 "createdDate": "A String", # The date when this reply was first created.
420 },
421 ],
422 "htmlContent": "A String", # HTML formatted content for this comment.
423 "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.
424 "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
425 "context": { # The context of the file which is being commented on.
426 "type": "A String", # The MIME type of the context snippet.
427 "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.
428 },
429 "createdDate": "A String", # The date when this comment was first created.
430 "commentId": "A String", # The ID of the comment.
431 "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.
432 "fileTitle": "A String", # The title of the file which this comment is addressing.
433 "fileId": "A String", # The file which this comment is addressing.
434 }
435
436
437Returns:
438 An object of the form:
439
440 { # A JSON representation of a comment on a file in Google Drive.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]441 "status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]442 # - "open" - The comment is still open.
443 # - "resolved" - The comment has been resolved by one of its replies.
444 "selfLink": "A String", # A link back to this comment.
445 "kind": "drive#comment", # This is always drive#comment.
446 "author": { # The JSON template for a user. # The user who wrote this comment.
447 "picture": { # The user's profile picture.
448 "url": "A String", # A URL that points to a profile picture of this user.
449 },
450 "kind": "drive#user", # This is always drive#user.
451 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
452 "displayName": "A String", # A plain text displayable name for this user.
453 },
454 "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.
455 "replies": [ # Replies to this post.
456 { # A JSON representation of a reply to a comment on a file in Google Drive.
457 "kind": "drive#commentReply", # This is always drive#commentReply.
458 "author": { # The JSON template for a user. # The user who wrote this reply.
459 "picture": { # The user's profile picture.
460 "url": "A String", # A URL that points to a profile picture of this user.
461 },
462 "kind": "drive#user", # This is always drive#user.
463 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
464 "displayName": "A String", # A plain text displayable name for this user.
465 },
466 "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.
467 "htmlContent": "A String", # HTML formatted content for this reply.
468 "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).
469 "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:
470 # - "resolve" - To resolve a comment.
471 # - "reopen" - To reopen (un-resolve) a comment.
472 "replyId": "A String", # The ID of the reply.
473 "modifiedDate": "A String", # The date when this reply was last modified.
474 "createdDate": "A String", # The date when this reply was first created.
475 },
476 ],
477 "htmlContent": "A String", # HTML formatted content for this comment.
478 "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.
479 "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
480 "context": { # The context of the file which is being commented on.
481 "type": "A String", # The MIME type of the context snippet.
482 "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.
483 },
484 "createdDate": "A String", # The date when this comment was first created.
485 "commentId": "A String", # The ID of the comment.
486 "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.
487 "fileTitle": "A String", # The title of the file which this comment is addressing.
488 "fileId": "A String", # The file which this comment is addressing.
489 }</pre>
490</div>
491
492<div class="method">
493 <code class="details" id="update">update(fileId, commentId, body)</code>
494 <pre>Updates an existing comment.
495
496Args:
497 fileId: string, The ID of the file. (required)
498 commentId: string, The ID of the comment. (required)
499 body: object, The request body. (required)
500 The object takes the form of:
501
502{ # A JSON representation of a comment on a file in Google Drive.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]503 "status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]504 # - "open" - The comment is still open.
505 # - "resolved" - The comment has been resolved by one of its replies.
506 "selfLink": "A String", # A link back to this comment.
507 "kind": "drive#comment", # This is always drive#comment.
508 "author": { # The JSON template for a user. # The user who wrote this comment.
509 "picture": { # The user's profile picture.
510 "url": "A String", # A URL that points to a profile picture of this user.
511 },
512 "kind": "drive#user", # This is always drive#user.
513 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
514 "displayName": "A String", # A plain text displayable name for this user.
515 },
516 "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.
517 "replies": [ # Replies to this post.
518 { # A JSON representation of a reply to a comment on a file in Google Drive.
519 "kind": "drive#commentReply", # This is always drive#commentReply.
520 "author": { # The JSON template for a user. # The user who wrote this reply.
521 "picture": { # The user's profile picture.
522 "url": "A String", # A URL that points to a profile picture of this user.
523 },
524 "kind": "drive#user", # This is always drive#user.
525 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
526 "displayName": "A String", # A plain text displayable name for this user.
527 },
528 "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.
529 "htmlContent": "A String", # HTML formatted content for this reply.
530 "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).
531 "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:
532 # - "resolve" - To resolve a comment.
533 # - "reopen" - To reopen (un-resolve) a comment.
534 "replyId": "A String", # The ID of the reply.
535 "modifiedDate": "A String", # The date when this reply was last modified.
536 "createdDate": "A String", # The date when this reply was first created.
537 },
538 ],
539 "htmlContent": "A String", # HTML formatted content for this comment.
540 "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.
541 "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
542 "context": { # The context of the file which is being commented on.
543 "type": "A String", # The MIME type of the context snippet.
544 "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.
545 },
546 "createdDate": "A String", # The date when this comment was first created.
547 "commentId": "A String", # The ID of the comment.
548 "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.
549 "fileTitle": "A String", # The title of the file which this comment is addressing.
550 "fileId": "A String", # The file which this comment is addressing.
551 }
552
553
554Returns:
555 An object of the form:
556
557 { # A JSON representation of a comment on a file in Google Drive.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]558 "status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]559 # - "open" - The comment is still open.
560 # - "resolved" - The comment has been resolved by one of its replies.
561 "selfLink": "A String", # A link back to this comment.
562 "kind": "drive#comment", # This is always drive#comment.
563 "author": { # The JSON template for a user. # The user who wrote this comment.
564 "picture": { # The user's profile picture.
565 "url": "A String", # A URL that points to a profile picture of this user.
566 },
567 "kind": "drive#user", # This is always drive#user.
568 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
569 "displayName": "A String", # A plain text displayable name for this user.
570 },
571 "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.
572 "replies": [ # Replies to this post.
573 { # A JSON representation of a reply to a comment on a file in Google Drive.
574 "kind": "drive#commentReply", # This is always drive#commentReply.
575 "author": { # The JSON template for a user. # The user who wrote this reply.
576 "picture": { # The user's profile picture.
577 "url": "A String", # A URL that points to a profile picture of this user.
578 },
579 "kind": "drive#user", # This is always drive#user.
580 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
581 "displayName": "A String", # A plain text displayable name for this user.
582 },
583 "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.
584 "htmlContent": "A String", # HTML formatted content for this reply.
585 "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).
586 "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:
587 # - "resolve" - To resolve a comment.
588 # - "reopen" - To reopen (un-resolve) a comment.
589 "replyId": "A String", # The ID of the reply.
590 "modifiedDate": "A String", # The date when this reply was last modified.
591 "createdDate": "A String", # The date when this reply was first created.
592 },
593 ],
594 "htmlContent": "A String", # HTML formatted content for this comment.
595 "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.
596 "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
597 "context": { # The context of the file which is being commented on.
598 "type": "A String", # The MIME type of the context snippet.
599 "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.
600 },
601 "createdDate": "A String", # The date when this comment was first created.
602 "commentId": "A String", # The ID of the comment.
603 "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.
604 "fileTitle": "A String", # The title of the file which this comment is addressing.
605 "fileId": "A String", # The file which this comment is addressing.
606 }</pre>
607</div>
608
609</body></html>