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