Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / drive_v3.replies.html
blob: 65ecd0cf52ef5c318596a0cf4e91da3163888e26 [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.replies.html">replies</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#create">create(fileId, commentId, body=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]79<p class="firstline">Creates a new reply to a comment.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(fileId, commentId, replyId)</a></code></p>
82<p class="firstline">Deletes a reply.</p>
83<p class="toc_element">
84 <code><a href="#get">get(fileId, commentId, replyId, includeDeleted=None)</a></code></p>
85<p class="firstline">Gets a reply by ID.</p>
86<p class="toc_element">
87 <code><a href="#list">list(fileId, commentId, includeDeleted=None, pageToken=None, pageSize=None)</a></code></p>
88<p class="firstline">Lists a comment's replies.</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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]93 <code><a href="#update">update(fileId, commentId, replyId, body=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]94<p class="firstline">Updates a reply with patch semantics.</p>
95<h3>Method Details</h3>
96<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]97 <code class="details" id="create">create(fileId, commentId, body=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]98 <pre>Creates a new reply to a comment.
99
100Args:
101 fileId: string, The ID of the file. (required)
102 commentId: string, The ID of the comment. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]103 body: object, The request body.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]104 The object takes the form of:
105
106{ # A reply to a comment on a file.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]107 "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]108 "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]109 "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]110 "me": True or False, # Whether this user is the requesting user.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]111 "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]112 "displayName": "A String", # A plain text displayable name for this user.
113 "permissionId": "A String", # The user's ID as visible in Permission resources.
114 "emailAddress": "A String", # 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.
115 "photoLink": "A String", # A link to the user's profile photo, if available.
116 },
117 "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
118 "htmlContent": "A String", # The content of the reply with HTML formatting.
119 "content": "A String", # 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.
120 "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
121 "action": "A String", # The action the reply performed to the parent comment. Valid values are:
122 # - resolve
123 # - reopen
124 "id": "A String", # The ID of the reply.
125}
126
127
128Returns:
129 An object of the form:
130
131 { # A reply to a comment on a file.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]132 "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]133 "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]134 "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]135 "me": True or False, # Whether this user is the requesting user.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]136 "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]137 "displayName": "A String", # A plain text displayable name for this user.
138 "permissionId": "A String", # The user's ID as visible in Permission resources.
139 "emailAddress": "A String", # 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.
140 "photoLink": "A String", # A link to the user's profile photo, if available.
141 },
142 "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
143 "htmlContent": "A String", # The content of the reply with HTML formatting.
144 "content": "A String", # 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.
145 "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
146 "action": "A String", # The action the reply performed to the parent comment. Valid values are:
147 # - resolve
148 # - reopen
149 "id": "A String", # The ID of the reply.
150 }</pre>
151</div>
152
153<div class="method">
154 <code class="details" id="delete">delete(fileId, commentId, replyId)</code>
155 <pre>Deletes a reply.
156
157Args:
158 fileId: string, The ID of the file. (required)
159 commentId: string, The ID of the comment. (required)
160 replyId: string, The ID of the reply. (required)
161</pre>
162</div>
163
164<div class="method">
165 <code class="details" id="get">get(fileId, commentId, replyId, includeDeleted=None)</code>
166 <pre>Gets a reply by ID.
167
168Args:
169 fileId: string, The ID of the file. (required)
170 commentId: string, The ID of the comment. (required)
171 replyId: string, The ID of the reply. (required)
172 includeDeleted: boolean, Whether to return deleted replies. Deleted replies will not include their original content.
173
174Returns:
175 An object of the form:
176
177 { # A reply to a comment on a file.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]178 "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]179 "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]180 "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]181 "me": True or False, # Whether this user is the requesting user.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]182 "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]183 "displayName": "A String", # A plain text displayable name for this user.
184 "permissionId": "A String", # The user's ID as visible in Permission resources.
185 "emailAddress": "A String", # 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.
186 "photoLink": "A String", # A link to the user's profile photo, if available.
187 },
188 "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
189 "htmlContent": "A String", # The content of the reply with HTML formatting.
190 "content": "A String", # 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.
191 "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
192 "action": "A String", # The action the reply performed to the parent comment. Valid values are:
193 # - resolve
194 # - reopen
195 "id": "A String", # The ID of the reply.
196 }</pre>
197</div>
198
199<div class="method">
200 <code class="details" id="list">list(fileId, commentId, includeDeleted=None, pageToken=None, pageSize=None)</code>
201 <pre>Lists a comment's replies.
202
203Args:
204 fileId: string, The ID of the file. (required)
205 commentId: string, The ID of the comment. (required)
206 includeDeleted: boolean, Whether to include deleted replies. Deleted replies will not include their original content.
207 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.
208 pageSize: integer, The maximum number of replies to return per page.
209
210Returns:
211 An object of the form:
212
213 { # A list of replies to a comment on a file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]214 "nextPageToken": "A String", # 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.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]215 "kind": "drive#replyList", # Identifies what kind of resource this is. Value: the fixed string "drive#replyList".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]216 "replies": [ # The list of replies. 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]217 { # A reply to a comment on a file.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]218 "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]219 "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]220 "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]221 "me": True or False, # Whether this user is the requesting user.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]222 "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]223 "displayName": "A String", # A plain text displayable name for this user.
224 "permissionId": "A String", # The user's ID as visible in Permission resources.
225 "emailAddress": "A String", # 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.
226 "photoLink": "A String", # A link to the user's profile photo, if available.
227 },
228 "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
229 "htmlContent": "A String", # The content of the reply with HTML formatting.
230 "content": "A String", # 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.
231 "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
232 "action": "A String", # The action the reply performed to the parent comment. Valid values are:
233 # - resolve
234 # - reopen
235 "id": "A String", # The ID of the reply.
236 },
237 ],
238 }</pre>
239</div>
240
241<div class="method">
242 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
243 <pre>Retrieves the next page of results.
244
245Args:
246 previous_request: The request for the previous page. (required)
247 previous_response: The response from the request for the previous page. (required)
248
249Returns:
250 A request object that you can call 'execute()' on to request the next
251 page. Returns None if there are no more items in the collection.
252 </pre>
253</div>
254
255<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]256 <code class="details" id="update">update(fileId, commentId, replyId, body=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]257 <pre>Updates a reply with patch semantics.
258
259Args:
260 fileId: string, The ID of the file. (required)
261 commentId: string, The ID of the comment. (required)
262 replyId: string, The ID of the reply. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]263 body: object, The request body.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]264 The object takes the form of:
265
266{ # A reply to a comment on a file.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]267 "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]268 "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]269 "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]270 "me": True or False, # Whether this user is the requesting user.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]271 "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]272 "displayName": "A String", # A plain text displayable name for this user.
273 "permissionId": "A String", # The user's ID as visible in Permission resources.
274 "emailAddress": "A String", # 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.
275 "photoLink": "A String", # A link to the user's profile photo, if available.
276 },
277 "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
278 "htmlContent": "A String", # The content of the reply with HTML formatting.
279 "content": "A String", # 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.
280 "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
281 "action": "A String", # The action the reply performed to the parent comment. Valid values are:
282 # - resolve
283 # - reopen
284 "id": "A String", # The ID of the reply.
285}
286
287
288Returns:
289 An object of the form:
290
291 { # A reply to a comment on a file.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]292 "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]293 "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]294 "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]295 "me": True or False, # Whether this user is the requesting user.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]296 "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]297 "displayName": "A String", # A plain text displayable name for this user.
298 "permissionId": "A String", # The user's ID as visible in Permission resources.
299 "emailAddress": "A String", # 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 "photoLink": "A String", # A link to the user's profile photo, if available.
301 },
302 "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
303 "htmlContent": "A String", # The content of the reply with HTML formatting.
304 "content": "A String", # 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.
305 "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
306 "action": "A String", # The action the reply performed to the parent comment. Valid values are:
307 # - resolve
308 # - reopen
309 "id": "A String", # The ID of the reply.
310 }</pre>
311</div>
312
313</body></html>