Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b1cc515b93bef725389ac86401366b6f7a98b0c8 / . / docs / dyn / drive_v2.replies.html
blob: e3936404741bd2dd1bfc69cc491043110b91af8c [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
123 { # A JSON representation of a reply to a comment on a file in Google Drive.
124 "kind": "drive#commentReply", # This is always drive#commentReply.
125 "author": { # The JSON template for a user. # The user who wrote this reply.
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.
130 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
131 "displayName": "A String", # A plain text displayable name for this user.
132 "permissionId": "A String", # The user's ID as visible in the permissions collection.
133 },
134 "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.
135 "htmlContent": "A String", # HTML formatted content for this reply.
136 "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).
137 "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:
138 # - "resolve" - To resolve a comment.
139 # - "reopen" - To reopen (un-resolve) a comment.
140 "replyId": "A String", # The ID of the reply.
141 "modifiedDate": "A String", # The date when this reply was last modified.
142 "createdDate": "A String", # The date when this reply was first created.
143 }</pre>
144</div>
145
146<div class="method">
147 <code class="details" id="insert">insert(fileId, commentId, body)</code>
148 <pre>Creates a new reply to the given comment.
149
150Args:
151 fileId: string, The ID of the file. (required)
152 commentId: string, The ID of the comment. (required)
153 body: object, The request body. (required)
154 The object takes the form of:
155
156{ # A JSON representation of a reply to a comment on a file in Google Drive.
157 "kind": "drive#commentReply", # This is always drive#commentReply.
158 "author": { # The JSON template for a user. # The user who wrote this reply.
159 "picture": { # The user's profile picture.
160 "url": "A String", # A URL that points to a profile picture of this user.
161 },
162 "kind": "drive#user", # This is always drive#user.
163 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
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.
166 },
167 "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.
168 "htmlContent": "A String", # HTML formatted content for this reply.
169 "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).
170 "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:
171 # - "resolve" - To resolve a comment.
172 # - "reopen" - To reopen (un-resolve) a comment.
173 "replyId": "A String", # The ID of the reply.
174 "modifiedDate": "A String", # The date when this reply was last modified.
175 "createdDate": "A String", # The date when this reply was first created.
176}
177
178
179Returns:
180 An object of the form:
181
182 { # A JSON representation of a reply to a comment on a file in Google Drive.
183 "kind": "drive#commentReply", # This is always drive#commentReply.
184 "author": { # The JSON template for a user. # The user who wrote this reply.
185 "picture": { # The user's profile picture.
186 "url": "A String", # A URL that points to a profile picture of this user.
187 },
188 "kind": "drive#user", # This is always drive#user.
189 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
190 "displayName": "A String", # A plain text displayable name for this user.
191 "permissionId": "A String", # The user's ID as visible in the permissions collection.
192 },
193 "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.
194 "htmlContent": "A String", # HTML formatted content for this reply.
195 "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).
196 "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:
197 # - "resolve" - To resolve a comment.
198 # - "reopen" - To reopen (un-resolve) a comment.
199 "replyId": "A String", # The ID of the reply.
200 "modifiedDate": "A String", # The date when this reply was last modified.
201 "createdDate": "A String", # The date when this reply was first created.
202 }</pre>
203</div>
204
205<div class="method">
206 <code class="details" id="list">list(fileId, commentId, includeDeleted=None, pageToken=None, maxResults=None)</code>
207 <pre>Lists all of the replies to a comment.
208
209Args:
210 fileId: string, The ID of the file. (required)
211 commentId: string, The ID of the comment. (required)
212 includeDeleted: boolean, If set, all replies, including deleted replies (with content stripped) will be returned.
213 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.
214 maxResults: integer, The maximum number of replies to include in the response, used for paging.
215
216Returns:
217 An object of the form:
218
219 { # A JSON representation of a list of replies to a comment on a file in Google Drive.
220 "nextPageToken": "A String", # The token to use to request the next page of results.
221 "items": [ # List of reply.
222 { # A JSON representation of a reply to a comment on a file in Google Drive.
223 "kind": "drive#commentReply", # This is always drive#commentReply.
224 "author": { # The JSON template for a user. # The user who wrote this reply.
225 "picture": { # The user's profile picture.
226 "url": "A String", # A URL that points to a profile picture of this user.
227 },
228 "kind": "drive#user", # This is always drive#user.
229 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
230 "displayName": "A String", # A plain text displayable name for this user.
231 "permissionId": "A String", # The user's ID as visible in the permissions collection.
232 },
233 "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.
234 "htmlContent": "A String", # HTML formatted content for this reply.
235 "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).
236 "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:
237 # - "resolve" - To resolve a comment.
238 # - "reopen" - To reopen (un-resolve) a comment.
239 "replyId": "A String", # The ID of the reply.
240 "modifiedDate": "A String", # The date when this reply was last modified.
241 "createdDate": "A String", # The date when this reply was first created.
242 },
243 ],
244 "kind": "drive#commentReplyList", # This is always drive#commentReplyList.
245 "selfLink": "A String", # A link back to this list.
246 "nextLink": "A String", # A link to the next page of replies.
247 }</pre>
248</div>
249
250<div class="method">
251 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
252 <pre>Retrieves the next page of results.
253
254Args:
255 previous_request: The request for the previous page. (required)
256 previous_response: The response from the request for the previous page. (required)
257
258Returns:
259 A request object that you can call 'execute()' on to request the next
260 page. Returns None if there are no more items in the collection.
261 </pre>
262</div>
263
264<div class="method">
265 <code class="details" id="patch">patch(fileId, commentId, replyId, body)</code>
266 <pre>Updates an existing reply. This method supports patch semantics.
267
268Args:
269 fileId: string, The ID of the file. (required)
270 commentId: string, The ID of the comment. (required)
271 replyId: string, The ID of the reply. (required)
272 body: object, The request body. (required)
273 The object takes the form of:
274
275{ # A JSON representation of a reply to a comment on a file in Google Drive.
276 "kind": "drive#commentReply", # This is always drive#commentReply.
277 "author": { # The JSON template for a user. # The user who wrote this reply.
278 "picture": { # The user's profile picture.
279 "url": "A String", # A URL that points to a profile picture of this user.
280 },
281 "kind": "drive#user", # This is always drive#user.
282 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
283 "displayName": "A String", # A plain text displayable name for this user.
284 "permissionId": "A String", # The user's ID as visible in the permissions collection.
285 },
286 "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.
287 "htmlContent": "A String", # HTML formatted content for this reply.
288 "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).
289 "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:
290 # - "resolve" - To resolve a comment.
291 # - "reopen" - To reopen (un-resolve) a comment.
292 "replyId": "A String", # The ID of the reply.
293 "modifiedDate": "A String", # The date when this reply was last modified.
294 "createdDate": "A String", # The date when this reply was first created.
295}
296
297
298Returns:
299 An object of the form:
300
301 { # A JSON representation of a reply to a comment on a file in Google Drive.
302 "kind": "drive#commentReply", # This is always drive#commentReply.
303 "author": { # The JSON template for a user. # The user who wrote this reply.
304 "picture": { # The user's profile picture.
305 "url": "A String", # A URL that points to a profile picture of this user.
306 },
307 "kind": "drive#user", # This is always drive#user.
308 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
309 "displayName": "A String", # A plain text displayable name for this user.
310 "permissionId": "A String", # The user's ID as visible in the permissions collection.
311 },
312 "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.
313 "htmlContent": "A String", # HTML formatted content for this reply.
314 "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).
315 "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:
316 # - "resolve" - To resolve a comment.
317 # - "reopen" - To reopen (un-resolve) a comment.
318 "replyId": "A String", # The ID of the reply.
319 "modifiedDate": "A String", # The date when this reply was last modified.
320 "createdDate": "A String", # The date when this reply was first created.
321 }</pre>
322</div>
323
324<div class="method">
325 <code class="details" id="update">update(fileId, commentId, replyId, body)</code>
326 <pre>Updates an existing reply.
327
328Args:
329 fileId: string, The ID of the file. (required)
330 commentId: string, The ID of the comment. (required)
331 replyId: string, The ID of the reply. (required)
332 body: object, The request body. (required)
333 The object takes the form of:
334
335{ # A JSON representation of a reply to a comment on a file in Google Drive.
336 "kind": "drive#commentReply", # This is always drive#commentReply.
337 "author": { # The JSON template for a user. # The user who wrote this reply.
338 "picture": { # The user's profile picture.
339 "url": "A String", # A URL that points to a profile picture of this user.
340 },
341 "kind": "drive#user", # This is always drive#user.
342 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
343 "displayName": "A String", # A plain text displayable name for this user.
344 "permissionId": "A String", # The user's ID as visible in the permissions collection.
345 },
346 "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.
347 "htmlContent": "A String", # HTML formatted content for this reply.
348 "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).
349 "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:
350 # - "resolve" - To resolve a comment.
351 # - "reopen" - To reopen (un-resolve) a comment.
352 "replyId": "A String", # The ID of the reply.
353 "modifiedDate": "A String", # The date when this reply was last modified.
354 "createdDate": "A String", # The date when this reply was first created.
355}
356
357
358Returns:
359 An object of the form:
360
361 { # A JSON representation of a reply to a comment on a file in Google Drive.
362 "kind": "drive#commentReply", # This is always drive#commentReply.
363 "author": { # The JSON template for a user. # The user who wrote this reply.
364 "picture": { # The user's profile picture.
365 "url": "A String", # A URL that points to a profile picture of this user.
366 },
367 "kind": "drive#user", # This is always drive#user.
368 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
369 "displayName": "A String", # A plain text displayable name for this user.
370 "permissionId": "A String", # The user's ID as visible in the permissions collection.
371 },
372 "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.
373 "htmlContent": "A String", # HTML formatted content for this reply.
374 "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).
375 "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:
376 # - "resolve" - To resolve a comment.
377 # - "reopen" - To reopen (un-resolve) a comment.
378 "replyId": "A String", # The ID of the reply.
379 "modifiedDate": "A String", # The date when this reply was last modified.
380 "createdDate": "A String", # The date when this reply was first created.
381 }</pre>
382</div>
383
384</body></html>