Debian Codegraph @

docs/dyn/drive_v3.replies.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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">Google Drive API</a> . <a href="drive_v3.replies.html">replies</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#create">create(fileId, commentId, body=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Creates a reply to a comment. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments).</p>
83 <p class="toc_element">
84 <code><a href="#delete">delete(fileId, commentId, replyId, x__xgafv=None)</a></code></p>
85 <p class="firstline">Deletes a reply. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments).</p>
86 <p class="toc_element">
87 <code><a href="#get">get(fileId, commentId, replyId, includeDeleted=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Gets a reply by ID. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments).</p>
89 <p class="toc_element">
90 <code><a href="#list">list(fileId, commentId, includeDeleted=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Lists a comment's replies. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments).</p>
92 <p class="toc_element">
93 <code><a href="#list_next">list_next()</a></code></p>
94 <p class="firstline">Retrieves the next page of results.</p>
95 <p class="toc_element">
96 <code><a href="#update">update(fileId, commentId, replyId, body=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Updates a reply with patch semantics. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments).</p>
98 <h3>Method Details</h3>
99 <div class="method">
100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102 </div>
103
104 <div class="method">
105 <code class="details" id="create">create(fileId, commentId, body=None, x__xgafv=None)</code>
106 <pre>Creates a reply to a comment. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments).
107
108 Args:
109 fileId: string, The ID of the file. (required)
110 commentId: string, The ID of the comment. (required)
111 body: object, The request body.
112 The object takes the form of:
113
114 { # A reply to a comment on a file. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply.
115 &quot;action&quot;: &quot;A String&quot;, # The action the reply performed to the parent comment. The supported values are: * `resolve` * `reopen`
116 &quot;assigneeEmailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user assigned to this comment. If no user is assigned, the field is unset.
117 &quot;author&quot;: { # Information about a Drive user. # Output only. The author of the reply. The author&#x27;s email address and permission ID won&#x27;t be populated.
118 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
119 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. 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.
120 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
121 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
122 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
123 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
124 },
125 &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 field is required by the `create` method if no `action` value is specified.
126 &quot;createdTime&quot;: &quot;A String&quot;, # The time at which the reply was created (RFC 3339 date-time).
127 &quot;deleted&quot;: True or False, # Output only. Whether the reply has been deleted. A deleted reply has no content.
128 &quot;htmlContent&quot;: &quot;A String&quot;, # Output only. The content of the reply with HTML formatting.
129 &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of the reply.
130 &quot;kind&quot;: &quot;drive#reply&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `&quot;drive#reply&quot;`.
131 &quot;mentionedEmailAddresses&quot;: [ # Output only. A list of email addresses for users mentioned in this comment. If no users are mentioned, the list is empty.
132 &quot;A String&quot;,
133 ],
134 &quot;modifiedTime&quot;: &quot;A String&quot;, # The last time the reply was modified (RFC 3339 date-time).
135 }
136
137 x__xgafv: string, V1 error format.
138 Allowed values
139 1 - v1 error format
140 2 - v2 error format
141
142 Returns:
143 An object of the form:
144
145 { # A reply to a comment on a file. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply.
146 &quot;action&quot;: &quot;A String&quot;, # The action the reply performed to the parent comment. The supported values are: * `resolve` * `reopen`
147 &quot;assigneeEmailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user assigned to this comment. If no user is assigned, the field is unset.
148 &quot;author&quot;: { # Information about a Drive user. # Output only. The author of the reply. The author&#x27;s email address and permission ID won&#x27;t be populated.
149 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
150 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. 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.
151 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
152 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
153 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
154 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
155 },
156 &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 field is required by the `create` method if no `action` value is specified.
157 &quot;createdTime&quot;: &quot;A String&quot;, # The time at which the reply was created (RFC 3339 date-time).
158 &quot;deleted&quot;: True or False, # Output only. Whether the reply has been deleted. A deleted reply has no content.
159 &quot;htmlContent&quot;: &quot;A String&quot;, # Output only. The content of the reply with HTML formatting.
160 &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of the reply.
161 &quot;kind&quot;: &quot;drive#reply&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `&quot;drive#reply&quot;`.
162 &quot;mentionedEmailAddresses&quot;: [ # Output only. A list of email addresses for users mentioned in this comment. If no users are mentioned, the list is empty.
163 &quot;A String&quot;,
164 ],
165 &quot;modifiedTime&quot;: &quot;A String&quot;, # The last time the reply was modified (RFC 3339 date-time).
166 }</pre>
167 </div>
168
169 <div class="method">
170 <code class="details" id="delete">delete(fileId, commentId, replyId, x__xgafv=None)</code>
171 <pre>Deletes a reply. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments).
172
173 Args:
174 fileId: string, The ID of the file. (required)
175 commentId: string, The ID of the comment. (required)
176 replyId: string, The ID of the reply. (required)
177 x__xgafv: string, V1 error format.
178 Allowed values
179 1 - v1 error format
180 2 - v2 error format
181 </pre>
182 </div>
183
184 <div class="method">
185 <code class="details" id="get">get(fileId, commentId, replyId, includeDeleted=None, x__xgafv=None)</code>
186 <pre>Gets a reply by ID. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments).
187
188 Args:
189 fileId: string, The ID of the file. (required)
190 commentId: string, The ID of the comment. (required)
191 replyId: string, The ID of the reply. (required)
192 includeDeleted: boolean, Whether to return deleted replies. Deleted replies don&#x27;t include their original content.
193 x__xgafv: string, V1 error format.
194 Allowed values
195 1 - v1 error format
196 2 - v2 error format
197
198 Returns:
199 An object of the form:
200
201 { # A reply to a comment on a file. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply.
202 &quot;action&quot;: &quot;A String&quot;, # The action the reply performed to the parent comment. The supported values are: * `resolve` * `reopen`
203 &quot;assigneeEmailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user assigned to this comment. If no user is assigned, the field is unset.
204 &quot;author&quot;: { # Information about a Drive user. # Output only. The author of the reply. The author&#x27;s email address and permission ID won&#x27;t be populated.
205 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
206 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. 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.
207 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
208 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
209 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
210 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
211 },
212 &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 field is required by the `create` method if no `action` value is specified.
213 &quot;createdTime&quot;: &quot;A String&quot;, # The time at which the reply was created (RFC 3339 date-time).
214 &quot;deleted&quot;: True or False, # Output only. Whether the reply has been deleted. A deleted reply has no content.
215 &quot;htmlContent&quot;: &quot;A String&quot;, # Output only. The content of the reply with HTML formatting.
216 &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of the reply.
217 &quot;kind&quot;: &quot;drive#reply&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `&quot;drive#reply&quot;`.
218 &quot;mentionedEmailAddresses&quot;: [ # Output only. A list of email addresses for users mentioned in this comment. If no users are mentioned, the list is empty.
219 &quot;A String&quot;,
220 ],
221 &quot;modifiedTime&quot;: &quot;A String&quot;, # The last time the reply was modified (RFC 3339 date-time).
222 }</pre>
223 </div>
224
225 <div class="method">
226 <code class="details" id="list">list(fileId, commentId, includeDeleted=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
227 <pre>Lists a comment&#x27;s replies. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments).
228
229 Args:
230 fileId: string, The ID of the file. (required)
231 commentId: string, The ID of the comment. (required)
232 includeDeleted: boolean, Whether to include deleted replies. Deleted replies don&#x27;t include their original content.
233 pageSize: integer, The maximum number of replies to return per page.
234 pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response.
235 x__xgafv: string, V1 error format.
236 Allowed values
237 1 - v1 error format
238 2 - v2 error format
239
240 Returns:
241 An object of the form:
242
243 { # A list of replies to a comment on a file.
244 &quot;kind&quot;: &quot;drive#replyList&quot;, # Identifies what kind of resource this is. Value: the fixed string `&quot;drive#replyList&quot;`.
245 &quot;nextPageToken&quot;: &quot;A String&quot;, # The page token for the next page of replies. This will be absent if the end of the replies 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. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.
246 &quot;replies&quot;: [ # The list of replies. If `nextPageToken` is populated, then this list may be incomplete and an additional page of results should be fetched.
247 { # A reply to a comment on a file. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply.
248 &quot;action&quot;: &quot;A String&quot;, # The action the reply performed to the parent comment. The supported values are: * `resolve` * `reopen`
249 &quot;assigneeEmailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user assigned to this comment. If no user is assigned, the field is unset.
250 &quot;author&quot;: { # Information about a Drive user. # Output only. The author of the reply. The author&#x27;s email address and permission ID won&#x27;t be populated.
251 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
252 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. 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.
253 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
254 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
255 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
256 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
257 },
258 &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 field is required by the `create` method if no `action` value is specified.
259 &quot;createdTime&quot;: &quot;A String&quot;, # The time at which the reply was created (RFC 3339 date-time).
260 &quot;deleted&quot;: True or False, # Output only. Whether the reply has been deleted. A deleted reply has no content.
261 &quot;htmlContent&quot;: &quot;A String&quot;, # Output only. The content of the reply with HTML formatting.
262 &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of the reply.
263 &quot;kind&quot;: &quot;drive#reply&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `&quot;drive#reply&quot;`.
264 &quot;mentionedEmailAddresses&quot;: [ # Output only. A list of email addresses for users mentioned in this comment. If no users are mentioned, the list is empty.
265 &quot;A String&quot;,
266 ],
267 &quot;modifiedTime&quot;: &quot;A String&quot;, # The last time the reply was modified (RFC 3339 date-time).
268 },
269 ],
270 }</pre>
271 </div>
272
273 <div class="method">
274 <code class="details" id="list_next">list_next()</code>
275 <pre>Retrieves the next page of results.
276
277 Args:
278 previous_request: The request for the previous page. (required)
279 previous_response: The response from the request for the previous page. (required)
280
281 Returns:
282 A request object that you can call &#x27;execute()&#x27; on to request the next
283 page. Returns None if there are no more items in the collection.
284 </pre>
285 </div>
286
287 <div class="method">
288 <code class="details" id="update">update(fileId, commentId, replyId, body=None, x__xgafv=None)</code>
289 <pre>Updates a reply with patch semantics. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments).
290
291 Args:
292 fileId: string, The ID of the file. (required)
293 commentId: string, The ID of the comment. (required)
294 replyId: string, The ID of the reply. (required)
295 body: object, The request body.
296 The object takes the form of:
297
298 { # A reply to a comment on a file. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply.
299 &quot;action&quot;: &quot;A String&quot;, # The action the reply performed to the parent comment. The supported values are: * `resolve` * `reopen`
300 &quot;assigneeEmailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user assigned to this comment. If no user is assigned, the field is unset.
301 &quot;author&quot;: { # Information about a Drive user. # Output only. The author of the reply. The author&#x27;s email address and permission ID won&#x27;t be populated.
302 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
303 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. 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.
304 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
305 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
306 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
307 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
308 },
309 &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 field is required by the `create` method if no `action` value is specified.
310 &quot;createdTime&quot;: &quot;A String&quot;, # The time at which the reply was created (RFC 3339 date-time).
311 &quot;deleted&quot;: True or False, # Output only. Whether the reply has been deleted. A deleted reply has no content.
312 &quot;htmlContent&quot;: &quot;A String&quot;, # Output only. The content of the reply with HTML formatting.
313 &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of the reply.
314 &quot;kind&quot;: &quot;drive#reply&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `&quot;drive#reply&quot;`.
315 &quot;mentionedEmailAddresses&quot;: [ # Output only. A list of email addresses for users mentioned in this comment. If no users are mentioned, the list is empty.
316 &quot;A String&quot;,
317 ],
318 &quot;modifiedTime&quot;: &quot;A String&quot;, # The last time the reply was modified (RFC 3339 date-time).
319 }
320
321 x__xgafv: string, V1 error format.
322 Allowed values
323 1 - v1 error format
324 2 - v2 error format
325
326 Returns:
327 An object of the form:
328
329 { # A reply to a comment on a file. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply.
330 &quot;action&quot;: &quot;A String&quot;, # The action the reply performed to the parent comment. The supported values are: * `resolve` * `reopen`
331 &quot;assigneeEmailAddress&quot;: &quot;A String&quot;, # Output only. The email address of the user assigned to this comment. If no user is assigned, the field is unset.
332 &quot;author&quot;: { # Information about a Drive user. # Output only. The author of the reply. The author&#x27;s email address and permission ID won&#x27;t be populated.
333 &quot;displayName&quot;: &quot;A String&quot;, # Output only. A plain text displayable name for this user.
334 &quot;emailAddress&quot;: &quot;A String&quot;, # Output only. 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.
335 &quot;kind&quot;: &quot;drive#user&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
336 &quot;me&quot;: True or False, # Output only. Whether this user is the requesting user.
337 &quot;permissionId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s ID as visible in Permission resources.
338 &quot;photoLink&quot;: &quot;A String&quot;, # Output only. A link to the user&#x27;s profile photo, if available.
339 },
340 &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 field is required by the `create` method if no `action` value is specified.
341 &quot;createdTime&quot;: &quot;A String&quot;, # The time at which the reply was created (RFC 3339 date-time).
342 &quot;deleted&quot;: True or False, # Output only. Whether the reply has been deleted. A deleted reply has no content.
343 &quot;htmlContent&quot;: &quot;A String&quot;, # Output only. The content of the reply with HTML formatting.
344 &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of the reply.
345 &quot;kind&quot;: &quot;drive#reply&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string `&quot;drive#reply&quot;`.
346 &quot;mentionedEmailAddresses&quot;: [ # Output only. A list of email addresses for users mentioned in this comment. If no users are mentioned, the list is empty.
347 &quot;A String&quot;,
348 ],
349 &quot;modifiedTime&quot;: &quot;A String&quot;, # The last time the reply was modified (RFC 3339 date-time).
350 }</pre>
351 </div>
352
353 </body></html>