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