Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / df61397973d36909a46fc4c3bf0e006dbb69f79a / . / docs / dyn / drive_v2.replies.html
blob: a4a7b63f1af1a2daa92dd4a2fa8c0a69d2ea790b [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="drive_v2.html">Drive API</a> . <a href="drive_v2.replies.html">replies</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(fileId, commentId, replyId)</a></code></p>
79<p class="firstline">Deletes a reply.</p>
80<p class="toc_element">
81 <code><a href="#get">get(fileId, commentId, replyId, includeDeleted=None)</a></code></p>
82<p class="firstline">Gets a reply.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(fileId, commentId, body)</a></code></p>
85<p class="firstline">Creates a new reply to the given comment.</p>
86<p class="toc_element">
87 <code><a href="#list">list(fileId, commentId, includeDeleted=None, pageToken=None, maxResults=None)</a></code></p>
88<p class="firstline">Lists all of the replies to a comment.</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, replyId, body)</a></code></p>
94<p class="firstline">Updates an existing reply. This method supports patch semantics.</p>
95<p class="toc_element">
96 <code><a href="#update">update(fileId, commentId, replyId, body)</a></code></p>
97<p class="firstline">Updates an existing reply.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="delete">delete(fileId, commentId, replyId)</code>
101 <pre>Deletes a reply.
102
103Args:
104 fileId: string, The ID of the file. (required)
105 commentId: string, The ID of the comment. (required)
106 replyId: string, The ID of the reply. (required)
107</pre>
108</div>
109
110<div class="method">
111 <code class="details" id="get">get(fileId, commentId, replyId, includeDeleted=None)</code>
112 <pre>Gets a reply.
113
114Args:
115 fileId: string, The ID of the file. (required)
116 commentId: string, The ID of the comment. (required)
117 replyId: string, The ID of the reply. (required)
118 includeDeleted: boolean, If set, this will succeed when retrieving a deleted reply.
119
120Returns:
121 An object of the form:
122
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]123 { # A comment on a file in Google Drive.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]124 "kind": "drive#commentReply", # This is always drive#commentReply.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]125 "author": { # Information about a Drive user. # The user who wrote this reply.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]126 "picture": { # The user's profile picture.
127 "url": "A String", # A URL that points to a profile picture of this user.
128 },
129 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]130 "displayName": "A String", # A plain text displayable name for this user.
131 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]132 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
133 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]134 },
135 "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.
136 "htmlContent": "A String", # HTML formatted content for this reply.
137 "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).
138 "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:
139 # - "resolve" - To resolve a comment.
140 # - "reopen" - To reopen (un-resolve) a comment.
141 "replyId": "A String", # The ID of the reply.
142 "modifiedDate": "A String", # The date when this reply was last modified.
143 "createdDate": "A String", # The date when this reply was first created.
144 }</pre>
145</div>
146
147<div class="method">
148 <code class="details" id="insert">insert(fileId, commentId, body)</code>
149 <pre>Creates a new reply to the given comment.
150
151Args:
152 fileId: string, The ID of the file. (required)
153 commentId: string, The ID of the comment. (required)
154 body: object, The request body. (required)
155 The object takes the form of:
156
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]157{ # A comment on a file in Google Drive.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]158 "kind": "drive#commentReply", # This is always drive#commentReply.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]159 "author": { # Information about a Drive user. # The user who wrote this reply.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]160 "picture": { # The user's profile picture.
161 "url": "A String", # A URL that points to a profile picture of this user.
162 },
163 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]164 "displayName": "A String", # A plain text displayable name for this user.
165 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]166 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
167 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]168 },
169 "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.
170 "htmlContent": "A String", # HTML formatted content for this reply.
171 "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).
172 "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:
173 # - "resolve" - To resolve a comment.
174 # - "reopen" - To reopen (un-resolve) a comment.
175 "replyId": "A String", # The ID of the reply.
176 "modifiedDate": "A String", # The date when this reply was last modified.
177 "createdDate": "A String", # The date when this reply was first created.
178}
179
180
181Returns:
182 An object of the form:
183
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]184 { # A comment on a file in Google Drive.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]185 "kind": "drive#commentReply", # This is always drive#commentReply.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]186 "author": { # Information about a Drive user. # The user who wrote this reply.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]187 "picture": { # The user's profile picture.
188 "url": "A String", # A URL that points to a profile picture of this user.
189 },
190 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]191 "displayName": "A String", # A plain text displayable name for this user.
192 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]193 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
194 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]195 },
196 "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.
197 "htmlContent": "A String", # HTML formatted content for this reply.
198 "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).
199 "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:
200 # - "resolve" - To resolve a comment.
201 # - "reopen" - To reopen (un-resolve) a comment.
202 "replyId": "A String", # The ID of the reply.
203 "modifiedDate": "A String", # The date when this reply was last modified.
204 "createdDate": "A String", # The date when this reply was first created.
205 }</pre>
206</div>
207
208<div class="method">
209 <code class="details" id="list">list(fileId, commentId, includeDeleted=None, pageToken=None, maxResults=None)</code>
210 <pre>Lists all of the replies to a comment.
211
212Args:
213 fileId: string, The ID of the file. (required)
214 commentId: string, The ID of the comment. (required)
215 includeDeleted: boolean, If set, all replies, including deleted replies (with content stripped) will be returned.
216 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.
217 maxResults: integer, The maximum number of replies to include in the response, used for paging.
218
219Returns:
220 An object of the form:
221
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]222 { # A list of replies to a comment on a file in Google Drive.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]223 "nextPageToken": "A String", # The token to use to request the next page of results.
224 "items": [ # List of reply.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]225 { # A comment on a file in Google Drive.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]226 "kind": "drive#commentReply", # This is always drive#commentReply.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]227 "author": { # Information about a Drive user. # The user who wrote this reply.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]228 "picture": { # The user's profile picture.
229 "url": "A String", # A URL that points to a profile picture of this user.
230 },
231 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]232 "displayName": "A String", # A plain text displayable name for this user.
233 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]234 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
235 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]236 },
237 "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.
238 "htmlContent": "A String", # HTML formatted content for this reply.
239 "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).
240 "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:
241 # - "resolve" - To resolve a comment.
242 # - "reopen" - To reopen (un-resolve) a comment.
243 "replyId": "A String", # The ID of the reply.
244 "modifiedDate": "A String", # The date when this reply was last modified.
245 "createdDate": "A String", # The date when this reply was first created.
246 },
247 ],
248 "kind": "drive#commentReplyList", # This is always drive#commentReplyList.
249 "selfLink": "A String", # A link back to this list.
250 "nextLink": "A String", # A link to the next page of replies.
251 }</pre>
252</div>
253
254<div class="method">
255 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
256 <pre>Retrieves the next page of results.
257
258Args:
259 previous_request: The request for the previous page. (required)
260 previous_response: The response from the request for the previous page. (required)
261
262Returns:
263 A request object that you can call 'execute()' on to request the next
264 page. Returns None if there are no more items in the collection.
265 </pre>
266</div>
267
268<div class="method">
269 <code class="details" id="patch">patch(fileId, commentId, replyId, body)</code>
270 <pre>Updates an existing reply. This method supports patch semantics.
271
272Args:
273 fileId: string, The ID of the file. (required)
274 commentId: string, The ID of the comment. (required)
275 replyId: string, The ID of the reply. (required)
276 body: object, The request body. (required)
277 The object takes the form of:
278
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]279{ # A comment on a file in Google Drive.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]280 "kind": "drive#commentReply", # This is always drive#commentReply.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]281 "author": { # Information about a Drive user. # The user who wrote this reply.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]282 "picture": { # The user's profile picture.
283 "url": "A String", # A URL that points to a profile picture of this user.
284 },
285 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]286 "displayName": "A String", # A plain text displayable name for this user.
287 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]288 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
289 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]290 },
291 "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.
292 "htmlContent": "A String", # HTML formatted content for this reply.
293 "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).
294 "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:
295 # - "resolve" - To resolve a comment.
296 # - "reopen" - To reopen (un-resolve) a comment.
297 "replyId": "A String", # The ID of the reply.
298 "modifiedDate": "A String", # The date when this reply was last modified.
299 "createdDate": "A String", # The date when this reply was first created.
300}
301
302
303Returns:
304 An object of the form:
305
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]306 { # A comment on a file in Google Drive.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]307 "kind": "drive#commentReply", # This is always drive#commentReply.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]308 "author": { # Information about a Drive user. # The user who wrote this reply.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]309 "picture": { # The user's profile picture.
310 "url": "A String", # A URL that points to a profile picture of this user.
311 },
312 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]313 "displayName": "A String", # A plain text displayable name for this user.
314 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]315 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
316 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]317 },
318 "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.
319 "htmlContent": "A String", # HTML formatted content for this reply.
320 "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).
321 "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:
322 # - "resolve" - To resolve a comment.
323 # - "reopen" - To reopen (un-resolve) a comment.
324 "replyId": "A String", # The ID of the reply.
325 "modifiedDate": "A String", # The date when this reply was last modified.
326 "createdDate": "A String", # The date when this reply was first created.
327 }</pre>
328</div>
329
330<div class="method">
331 <code class="details" id="update">update(fileId, commentId, replyId, body)</code>
332 <pre>Updates an existing reply.
333
334Args:
335 fileId: string, The ID of the file. (required)
336 commentId: string, The ID of the comment. (required)
337 replyId: string, The ID of the reply. (required)
338 body: object, The request body. (required)
339 The object takes the form of:
340
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]341{ # A comment on a file in Google Drive.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]342 "kind": "drive#commentReply", # This is always drive#commentReply.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]343 "author": { # Information about a Drive user. # The user who wrote this reply.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]344 "picture": { # The user's profile picture.
345 "url": "A String", # A URL that points to a profile picture of this user.
346 },
347 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]348 "displayName": "A String", # A plain text displayable name for this user.
349 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]350 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
351 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]352 },
353 "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.
354 "htmlContent": "A String", # HTML formatted content for this reply.
355 "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).
356 "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:
357 # - "resolve" - To resolve a comment.
358 # - "reopen" - To reopen (un-resolve) a comment.
359 "replyId": "A String", # The ID of the reply.
360 "modifiedDate": "A String", # The date when this reply was last modified.
361 "createdDate": "A String", # The date when this reply was first created.
362}
363
364
365Returns:
366 An object of the form:
367
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]368 { # A comment on a file in Google Drive.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]369 "kind": "drive#commentReply", # This is always drive#commentReply.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]370 "author": { # Information about a Drive user. # The user who wrote this reply.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]371 "picture": { # The user's profile picture.
372 "url": "A String", # A URL that points to a profile picture of this user.
373 },
374 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]375 "displayName": "A String", # A plain text displayable name for this user.
376 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]377 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
378 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]379 },
380 "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.
381 "htmlContent": "A String", # HTML formatted content for this reply.
382 "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).
383 "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:
384 # - "resolve" - To resolve a comment.
385 # - "reopen" - To reopen (un-resolve) a comment.
386 "replyId": "A String", # The ID of the reply.
387 "modifiedDate": "A String", # The date when this reply was last modified.
388 "createdDate": "A String", # The date when this reply was first created.
389 }</pre>
390</div>
391
392</body></html>