Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3e17f8990db54bec16c48c319072799a14f5a53f / . / docs / dyn / drive_v3.comments.html
blob: f23f236ddab91d37a5e2a0af354a69ed29131622 [file] [log] [blame]
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[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_v3.html">Drive API</a> . <a href="drive_v3.comments.html">comments</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]81 <code><a href="#create">create(fileId, body=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]82<p class="firstline">Creates a new comment on a file.</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(fileId, commentId)</a></code></p>
85<p class="firstline">Deletes a comment.</p>
86<p class="toc_element">
87 <code><a href="#get">get(fileId, commentId, includeDeleted=None)</a></code></p>
88<p class="firstline">Gets a comment by ID.</p>
89<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]90 <code><a href="#list">list(fileId, includeDeleted=None, pageSize=None, pageToken=None, startModifiedTime=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]91<p class="firstline">Lists a file's comments.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]96 <code><a href="#update">update(fileId, commentId, body=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]97<p class="firstline">Updates a comment with patch semantics.</p>
98<h3>Method Details</h3>
99<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102</div>
103
104<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]105 <code class="details" id="create">create(fileId, body=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]106 <pre>Creates a new comment on a file.
107
108Args:
109 fileId: string, The ID of the file. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]110 body: object, The request body.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]111 The object takes the form of:
112
113{ # A comment on a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]114 &quot;anchor&quot;: &quot;A String&quot;, # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
115 &quot;author&quot;: { # Information about a Drive user. # The author of the comment. The author&#x27;s email address and permission ID will not be populated.
116 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
117 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
118 &quot;kind&quot;: &quot;drive#user&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;drive#user&quot;.
119 &quot;me&quot;: True or False, # Whether this user is the requesting user.
120 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in Permission resources.
121 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the user&#x27;s profile photo, if available.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]122 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]123 &quot;content&quot;: &quot;A String&quot;, # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
124 &quot;createdTime&quot;: &quot;A String&quot;, # The time at which the comment was created (RFC 3339 date-time).
125 &quot;deleted&quot;: True or False, # Whether the comment has been deleted. A deleted comment has no content.
126 &quot;htmlContent&quot;: &quot;A String&quot;, # The content of the comment with HTML formatting.
127 &quot;id&quot;: &quot;A String&quot;, # The ID of the comment.
128 &quot;kind&quot;: &quot;drive#comment&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;drive#comment&quot;.
129 &quot;modifiedTime&quot;: &quot;A String&quot;, # The last time the comment or any of its replies was modified (RFC 3339 date-time).
130 &quot;quotedFileContent&quot;: { # The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.
131 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the quoted content.
132 &quot;value&quot;: &quot;A String&quot;, # The quoted content itself. This is interpreted as plain text if set through the API.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]133 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]134 &quot;replies&quot;: [ # The full list of replies to the comment in chronological order.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]135 { # A reply to a comment on a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]136 &quot;action&quot;: &quot;A String&quot;, # The action the reply performed to the parent comment. Valid values are:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]137 # - resolve
138 # - reopen
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]139 &quot;author&quot;: { # Information about a Drive user. # The author of the reply. The author&#x27;s email address and permission ID will not be populated.
140 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
141 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
142 &quot;kind&quot;: &quot;drive#user&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;drive#user&quot;.
143 &quot;me&quot;: True or False, # Whether this user is the requesting user.
144 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in Permission resources.
145 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the user&#x27;s profile photo, if available.
146 },
147 &quot;content&quot;: &quot;A String&quot;, # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
148 &quot;createdTime&quot;: &quot;A String&quot;, # The time at which the reply was created (RFC 3339 date-time).
149 &quot;deleted&quot;: True or False, # Whether the reply has been deleted. A deleted reply has no content.
150 &quot;htmlContent&quot;: &quot;A String&quot;, # The content of the reply with HTML formatting.
151 &quot;id&quot;: &quot;A String&quot;, # The ID of the reply.
152 &quot;kind&quot;: &quot;drive#reply&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;drive#reply&quot;.
153 &quot;modifiedTime&quot;: &quot;A String&quot;, # The last time the reply was modified (RFC 3339 date-time).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]154 },
155 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]156 &quot;resolved&quot;: True or False, # Whether the comment has been resolved by one of its replies.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]157 }
158
159
160Returns:
161 An object of the form:
162
163 { # A comment on a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]164 &quot;anchor&quot;: &quot;A String&quot;, # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
165 &quot;author&quot;: { # Information about a Drive user. # The author of the comment. The author&#x27;s email address and permission ID will not be populated.
166 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
167 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
168 &quot;kind&quot;: &quot;drive#user&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;drive#user&quot;.
169 &quot;me&quot;: True or False, # Whether this user is the requesting user.
170 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in Permission resources.
171 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the user&#x27;s profile photo, if available.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]172 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]173 &quot;content&quot;: &quot;A String&quot;, # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
174 &quot;createdTime&quot;: &quot;A String&quot;, # The time at which the comment was created (RFC 3339 date-time).
175 &quot;deleted&quot;: True or False, # Whether the comment has been deleted. A deleted comment has no content.
176 &quot;htmlContent&quot;: &quot;A String&quot;, # The content of the comment with HTML formatting.
177 &quot;id&quot;: &quot;A String&quot;, # The ID of the comment.
178 &quot;kind&quot;: &quot;drive#comment&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;drive#comment&quot;.
179 &quot;modifiedTime&quot;: &quot;A String&quot;, # The last time the comment or any of its replies was modified (RFC 3339 date-time).
180 &quot;quotedFileContent&quot;: { # The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.
181 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the quoted content.
182 &quot;value&quot;: &quot;A String&quot;, # The quoted content itself. This is interpreted as plain text if set through the API.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]183 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]184 &quot;replies&quot;: [ # The full list of replies to the comment in chronological order.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]185 { # A reply to a comment on a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]186 &quot;action&quot;: &quot;A String&quot;, # The action the reply performed to the parent comment. Valid values are:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]187 # - resolve
188 # - reopen
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]189 &quot;author&quot;: { # Information about a Drive user. # The author of the reply. The author&#x27;s email address and permission ID will not be populated.
190 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
191 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
192 &quot;kind&quot;: &quot;drive#user&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;drive#user&quot;.
193 &quot;me&quot;: True or False, # Whether this user is the requesting user.
194 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in Permission resources.
195 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the user&#x27;s profile photo, if available.
196 },
197 &quot;content&quot;: &quot;A String&quot;, # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
198 &quot;createdTime&quot;: &quot;A String&quot;, # The time at which the reply was created (RFC 3339 date-time).
199 &quot;deleted&quot;: True or False, # Whether the reply has been deleted. A deleted reply has no content.
200 &quot;htmlContent&quot;: &quot;A String&quot;, # The content of the reply with HTML formatting.
201 &quot;id&quot;: &quot;A String&quot;, # The ID of the reply.
202 &quot;kind&quot;: &quot;drive#reply&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;drive#reply&quot;.
203 &quot;modifiedTime&quot;: &quot;A String&quot;, # The last time the reply was modified (RFC 3339 date-time).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]204 },
205 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]206 &quot;resolved&quot;: True or False, # Whether the comment has been resolved by one of its replies.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]207 }</pre>
208</div>
209
210<div class="method">
211 <code class="details" id="delete">delete(fileId, commentId)</code>
212 <pre>Deletes a comment.
213
214Args:
215 fileId: string, The ID of the file. (required)
216 commentId: string, The ID of the comment. (required)
217</pre>
218</div>
219
220<div class="method">
221 <code class="details" id="get">get(fileId, commentId, includeDeleted=None)</code>
222 <pre>Gets a comment by ID.
223
224Args:
225 fileId: string, The ID of the file. (required)
226 commentId: string, The ID of the comment. (required)
227 includeDeleted: boolean, Whether to return deleted comments. Deleted comments will not include their original content.
228
229Returns:
230 An object of the form:
231
232 { # A comment on a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]233 &quot;anchor&quot;: &quot;A String&quot;, # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
234 &quot;author&quot;: { # Information about a Drive user. # The author of the comment. The author&#x27;s email address and permission ID will not be populated.
235 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
236 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
237 &quot;kind&quot;: &quot;drive#user&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;drive#user&quot;.
238 &quot;me&quot;: True or False, # Whether this user is the requesting user.
239 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in Permission resources.
240 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the user&#x27;s profile photo, if available.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]241 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]242 &quot;content&quot;: &quot;A String&quot;, # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
243 &quot;createdTime&quot;: &quot;A String&quot;, # The time at which the comment was created (RFC 3339 date-time).
244 &quot;deleted&quot;: True or False, # Whether the comment has been deleted. A deleted comment has no content.
245 &quot;htmlContent&quot;: &quot;A String&quot;, # The content of the comment with HTML formatting.
246 &quot;id&quot;: &quot;A String&quot;, # The ID of the comment.
247 &quot;kind&quot;: &quot;drive#comment&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;drive#comment&quot;.
248 &quot;modifiedTime&quot;: &quot;A String&quot;, # The last time the comment or any of its replies was modified (RFC 3339 date-time).
249 &quot;quotedFileContent&quot;: { # The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.
250 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the quoted content.
251 &quot;value&quot;: &quot;A String&quot;, # The quoted content itself. This is interpreted as plain text if set through the API.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]252 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]253 &quot;replies&quot;: [ # The full list of replies to the comment in chronological order.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]254 { # A reply to a comment on a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]255 &quot;action&quot;: &quot;A String&quot;, # The action the reply performed to the parent comment. Valid values are:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]256 # - resolve
257 # - reopen
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]258 &quot;author&quot;: { # Information about a Drive user. # The author of the reply. The author&#x27;s email address and permission ID will not be populated.
259 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
260 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
261 &quot;kind&quot;: &quot;drive#user&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;drive#user&quot;.
262 &quot;me&quot;: True or False, # Whether this user is the requesting user.
263 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in Permission resources.
264 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the user&#x27;s profile photo, if available.
265 },
266 &quot;content&quot;: &quot;A String&quot;, # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
267 &quot;createdTime&quot;: &quot;A String&quot;, # The time at which the reply was created (RFC 3339 date-time).
268 &quot;deleted&quot;: True or False, # Whether the reply has been deleted. A deleted reply has no content.
269 &quot;htmlContent&quot;: &quot;A String&quot;, # The content of the reply with HTML formatting.
270 &quot;id&quot;: &quot;A String&quot;, # The ID of the reply.
271 &quot;kind&quot;: &quot;drive#reply&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;drive#reply&quot;.
272 &quot;modifiedTime&quot;: &quot;A String&quot;, # The last time the reply was modified (RFC 3339 date-time).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]273 },
274 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]275 &quot;resolved&quot;: True or False, # Whether the comment has been resolved by one of its replies.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]276 }</pre>
277</div>
278
279<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]280 <code class="details" id="list">list(fileId, includeDeleted=None, pageSize=None, pageToken=None, startModifiedTime=None)</code>
281 <pre>Lists a file&#x27;s comments.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]282
283Args:
284 fileId: string, The ID of the file. (required)
285 includeDeleted: boolean, Whether to include deleted comments. Deleted comments will not include their original content.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]286 pageSize: integer, The maximum number of comments to return per page.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]287 pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of &#x27;nextPageToken&#x27; from the previous response.
288 startModifiedTime: string, The minimum value of &#x27;modifiedTime&#x27; for the result comments (RFC 3339 date-time).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]289
290Returns:
291 An object of the form:
292
293 { # A list of comments on a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]294 &quot;comments&quot;: [ # The list of comments. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]295 { # A comment on a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]296 &quot;anchor&quot;: &quot;A String&quot;, # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
297 &quot;author&quot;: { # Information about a Drive user. # The author of the comment. The author&#x27;s email address and permission ID will not be populated.
298 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
299 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
300 &quot;kind&quot;: &quot;drive#user&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;drive#user&quot;.
301 &quot;me&quot;: True or False, # Whether this user is the requesting user.
302 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in Permission resources.
303 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the user&#x27;s profile photo, if available.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]304 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]305 &quot;content&quot;: &quot;A String&quot;, # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
306 &quot;createdTime&quot;: &quot;A String&quot;, # The time at which the comment was created (RFC 3339 date-time).
307 &quot;deleted&quot;: True or False, # Whether the comment has been deleted. A deleted comment has no content.
308 &quot;htmlContent&quot;: &quot;A String&quot;, # The content of the comment with HTML formatting.
309 &quot;id&quot;: &quot;A String&quot;, # The ID of the comment.
310 &quot;kind&quot;: &quot;drive#comment&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;drive#comment&quot;.
311 &quot;modifiedTime&quot;: &quot;A String&quot;, # The last time the comment or any of its replies was modified (RFC 3339 date-time).
312 &quot;quotedFileContent&quot;: { # The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.
313 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the quoted content.
314 &quot;value&quot;: &quot;A String&quot;, # The quoted content itself. This is interpreted as plain text if set through the API.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]315 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]316 &quot;replies&quot;: [ # The full list of replies to the comment in chronological order.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]317 { # A reply to a comment on a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]318 &quot;action&quot;: &quot;A String&quot;, # The action the reply performed to the parent comment. Valid values are:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]319 # - resolve
320 # - reopen
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]321 &quot;author&quot;: { # Information about a Drive user. # The author of the reply. The author&#x27;s email address and permission ID will not be populated.
322 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
323 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
324 &quot;kind&quot;: &quot;drive#user&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;drive#user&quot;.
325 &quot;me&quot;: True or False, # Whether this user is the requesting user.
326 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in Permission resources.
327 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the user&#x27;s profile photo, if available.
328 },
329 &quot;content&quot;: &quot;A String&quot;, # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
330 &quot;createdTime&quot;: &quot;A String&quot;, # The time at which the reply was created (RFC 3339 date-time).
331 &quot;deleted&quot;: True or False, # Whether the reply has been deleted. A deleted reply has no content.
332 &quot;htmlContent&quot;: &quot;A String&quot;, # The content of the reply with HTML formatting.
333 &quot;id&quot;: &quot;A String&quot;, # The ID of the reply.
334 &quot;kind&quot;: &quot;drive#reply&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;drive#reply&quot;.
335 &quot;modifiedTime&quot;: &quot;A String&quot;, # The last time the reply was modified (RFC 3339 date-time).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]336 },
337 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]338 &quot;resolved&quot;: True or False, # Whether the comment has been resolved by one of its replies.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]339 },
340 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]341 &quot;kind&quot;: &quot;drive#commentList&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;drive#commentList&quot;.
342 &quot;nextPageToken&quot;: &quot;A String&quot;, # The page token for the next page of comments. This will be absent if the end of the comments list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]343 }</pre>
344</div>
345
346<div class="method">
347 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
348 <pre>Retrieves the next page of results.
349
350Args:
351 previous_request: The request for the previous page. (required)
352 previous_response: The response from the request for the previous page. (required)
353
354Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]355 A request object that you can call &#x27;execute()&#x27; on to request the next
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]356 page. Returns None if there are no more items in the collection.
357 </pre>
358</div>
359
360<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]361 <code class="details" id="update">update(fileId, commentId, body=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]362 <pre>Updates a comment with patch semantics.
363
364Args:
365 fileId: string, The ID of the file. (required)
366 commentId: string, The ID of the comment. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]367 body: object, The request body.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]368 The object takes the form of:
369
370{ # A comment on a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]371 &quot;anchor&quot;: &quot;A String&quot;, # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
372 &quot;author&quot;: { # Information about a Drive user. # The author of the comment. The author&#x27;s email address and permission ID will not be populated.
373 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
374 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
375 &quot;kind&quot;: &quot;drive#user&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;drive#user&quot;.
376 &quot;me&quot;: True or False, # Whether this user is the requesting user.
377 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in Permission resources.
378 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the user&#x27;s profile photo, if available.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]379 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]380 &quot;content&quot;: &quot;A String&quot;, # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
381 &quot;createdTime&quot;: &quot;A String&quot;, # The time at which the comment was created (RFC 3339 date-time).
382 &quot;deleted&quot;: True or False, # Whether the comment has been deleted. A deleted comment has no content.
383 &quot;htmlContent&quot;: &quot;A String&quot;, # The content of the comment with HTML formatting.
384 &quot;id&quot;: &quot;A String&quot;, # The ID of the comment.
385 &quot;kind&quot;: &quot;drive#comment&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;drive#comment&quot;.
386 &quot;modifiedTime&quot;: &quot;A String&quot;, # The last time the comment or any of its replies was modified (RFC 3339 date-time).
387 &quot;quotedFileContent&quot;: { # The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.
388 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the quoted content.
389 &quot;value&quot;: &quot;A String&quot;, # The quoted content itself. This is interpreted as plain text if set through the API.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]390 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]391 &quot;replies&quot;: [ # The full list of replies to the comment in chronological order.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]392 { # A reply to a comment on a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]393 &quot;action&quot;: &quot;A String&quot;, # The action the reply performed to the parent comment. Valid values are:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]394 # - resolve
395 # - reopen
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]396 &quot;author&quot;: { # Information about a Drive user. # The author of the reply. The author&#x27;s email address and permission ID will not be populated.
397 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
398 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
399 &quot;kind&quot;: &quot;drive#user&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;drive#user&quot;.
400 &quot;me&quot;: True or False, # Whether this user is the requesting user.
401 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in Permission resources.
402 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the user&#x27;s profile photo, if available.
403 },
404 &quot;content&quot;: &quot;A String&quot;, # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
405 &quot;createdTime&quot;: &quot;A String&quot;, # The time at which the reply was created (RFC 3339 date-time).
406 &quot;deleted&quot;: True or False, # Whether the reply has been deleted. A deleted reply has no content.
407 &quot;htmlContent&quot;: &quot;A String&quot;, # The content of the reply with HTML formatting.
408 &quot;id&quot;: &quot;A String&quot;, # The ID of the reply.
409 &quot;kind&quot;: &quot;drive#reply&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;drive#reply&quot;.
410 &quot;modifiedTime&quot;: &quot;A String&quot;, # The last time the reply was modified (RFC 3339 date-time).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]411 },
412 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]413 &quot;resolved&quot;: True or False, # Whether the comment has been resolved by one of its replies.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]414 }
415
416
417Returns:
418 An object of the form:
419
420 { # A comment on a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]421 &quot;anchor&quot;: &quot;A String&quot;, # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
422 &quot;author&quot;: { # Information about a Drive user. # The author of the comment. The author&#x27;s email address and permission ID will not be populated.
423 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
424 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
425 &quot;kind&quot;: &quot;drive#user&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;drive#user&quot;.
426 &quot;me&quot;: True or False, # Whether this user is the requesting user.
427 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in Permission resources.
428 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the user&#x27;s profile photo, if available.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]429 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]430 &quot;content&quot;: &quot;A String&quot;, # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
431 &quot;createdTime&quot;: &quot;A String&quot;, # The time at which the comment was created (RFC 3339 date-time).
432 &quot;deleted&quot;: True or False, # Whether the comment has been deleted. A deleted comment has no content.
433 &quot;htmlContent&quot;: &quot;A String&quot;, # The content of the comment with HTML formatting.
434 &quot;id&quot;: &quot;A String&quot;, # The ID of the comment.
435 &quot;kind&quot;: &quot;drive#comment&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;drive#comment&quot;.
436 &quot;modifiedTime&quot;: &quot;A String&quot;, # The last time the comment or any of its replies was modified (RFC 3339 date-time).
437 &quot;quotedFileContent&quot;: { # The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.
438 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the quoted content.
439 &quot;value&quot;: &quot;A String&quot;, # The quoted content itself. This is interpreted as plain text if set through the API.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]440 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]441 &quot;replies&quot;: [ # The full list of replies to the comment in chronological order.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]442 { # A reply to a comment on a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]443 &quot;action&quot;: &quot;A String&quot;, # The action the reply performed to the parent comment. Valid values are:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]444 # - resolve
445 # - reopen
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]446 &quot;author&quot;: { # Information about a Drive user. # The author of the reply. The author&#x27;s email address and permission ID will not be populated.
447 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
448 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
449 &quot;kind&quot;: &quot;drive#user&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;drive#user&quot;.
450 &quot;me&quot;: True or False, # Whether this user is the requesting user.
451 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in Permission resources.
452 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the user&#x27;s profile photo, if available.
453 },
454 &quot;content&quot;: &quot;A String&quot;, # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
455 &quot;createdTime&quot;: &quot;A String&quot;, # The time at which the reply was created (RFC 3339 date-time).
456 &quot;deleted&quot;: True or False, # Whether the reply has been deleted. A deleted reply has no content.
457 &quot;htmlContent&quot;: &quot;A String&quot;, # The content of the reply with HTML formatting.
458 &quot;id&quot;: &quot;A String&quot;, # The ID of the reply.
459 &quot;kind&quot;: &quot;drive#reply&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;drive#reply&quot;.
460 &quot;modifiedTime&quot;: &quot;A String&quot;, # The last time the reply was modified (RFC 3339 date-time).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]461 },
462 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]463 &quot;resolved&quot;: True or False, # Whether the comment has been resolved by one of its replies.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]464 }</pre>
465</div>
466
467</body></html>