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