John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [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="tasks_v1.html">Tasks API</a> . <a href="tasks_v1.tasks.html">tasks</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 78 | <code><a href="#clear">clear(tasklist, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Clears all completed tasks from the specified task list. The affected tasks</p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 80 | <p class="toc_element"> |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 81 | <code><a href="#delete">delete(tasklist, task, x__xgafv=None)</a></code></p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 82 | <p class="firstline">Deletes the specified task from the task list.</p> |
| 83 | <p class="toc_element"> |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 84 | <code><a href="#get">get(tasklist, task, x__xgafv=None)</a></code></p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 85 | <p class="firstline">Returns the specified task.</p> |
| 86 | <p class="toc_element"> |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 87 | <code><a href="#insert">insert(tasklist, body=None, parent=None, previous=None, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Creates a new task on the specified task list.</p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 89 | <p class="toc_element"> |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 90 | <code><a href="#list">list(tasklist, completedMin=None, updatedMin=None, dueMin=None, showHidden=None, showCompleted=None, maxResults=None, pageToken=None, dueMax=None, completedMax=None, showDeleted=None, x__xgafv=None)</a></code></p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 91 | <p class="firstline">Returns all tasks in the specified task list.</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"> |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 96 | <code><a href="#move">move(tasklist, task, parent=None, previous=None, x__xgafv=None)</a></code></p> |
| 97 | <p class="firstline">Moves the specified task to another position in the task list. This can</p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 98 | <p class="toc_element"> |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 99 | <code><a href="#patch">patch(tasklist, task, body=None, x__xgafv=None)</a></code></p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 100 | <p class="firstline">Updates the specified task. This method supports patch semantics.</p> |
| 101 | <p class="toc_element"> |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 102 | <code><a href="#update">update(tasklist, task, body=None, x__xgafv=None)</a></code></p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 103 | <p class="firstline">Updates the specified task.</p> |
| 104 | <h3>Method Details</h3> |
| 105 | <div class="method"> |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 106 | <code class="details" id="clear">clear(tasklist, x__xgafv=None)</code> |
| 107 | <pre>Clears all completed tasks from the specified task list. The affected tasks |
| 108 | will be marked as 'hidden' and no longer be returned by default when |
| 109 | retrieving all tasks for a task list. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 110 | |
| 111 | Args: |
| 112 | tasklist: string, Task list identifier. (required) |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 113 | x__xgafv: string, V1 error format. |
| 114 | Allowed values |
| 115 | 1 - v1 error format |
| 116 | 2 - v2 error format |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 117 | </pre> |
| 118 | </div> |
| 119 | |
| 120 | <div class="method"> |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 121 | <code class="details" id="delete">delete(tasklist, task, x__xgafv=None)</code> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 122 | <pre>Deletes the specified task from the task list. |
| 123 | |
| 124 | Args: |
| 125 | tasklist: string, Task list identifier. (required) |
| 126 | task: string, Task identifier. (required) |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 127 | x__xgafv: string, V1 error format. |
| 128 | Allowed values |
| 129 | 1 - v1 error format |
| 130 | 2 - v2 error format |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 131 | </pre> |
| 132 | </div> |
| 133 | |
| 134 | <div class="method"> |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 135 | <code class="details" id="get">get(tasklist, task, x__xgafv=None)</code> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 136 | <pre>Returns the specified task. |
| 137 | |
| 138 | Args: |
| 139 | tasklist: string, Task list identifier. (required) |
| 140 | task: string, Task identifier. (required) |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 141 | x__xgafv: string, V1 error format. |
| 142 | Allowed values |
| 143 | 1 - v1 error format |
| 144 | 2 - v2 error format |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 145 | |
| 146 | Returns: |
| 147 | An object of the form: |
| 148 | |
| 149 | { |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 150 | "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp). |
| 151 | "etag": "A String", # ETag of the resource. |
| 152 | "title": "A String", # Title of the task. |
| 153 | "kind": "A String", # Type of the resource. This is always "tasks#task". |
| 154 | "id": "A String", # Task identifier. |
| 155 | "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. |
| 156 | # This field is read-only. Use the "move" method to move the task under a |
| 157 | # different parent or to the top level. |
| 158 | "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task. |
| 159 | "notes": "A String", # Notes describing the task. Optional. |
| 160 | "status": "A String", # Status of the task. This is either "needsAction" or "completed". |
| 161 | "deleted": True or False, # Flag indicating whether the task has been deleted. The default is False. |
| 162 | "position": "A String", # String indicating the position of the task among its sibling tasks under |
| 163 | # the same parent task or at the top level. If this string is greater than |
| 164 | # another task's corresponding position string according to lexicographical |
| 165 | # ordering, the task is positioned after the other task under the same parent |
| 166 | # task (or at the top level). This field is read-only. Use the "move" method |
| 167 | # to move the task to another position. |
| 168 | "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only |
| 169 | # records date information; the time portion of the timestamp is discarded |
| 170 | # when setting the due date. It isn't possible to read or write the time that |
| 171 | # a task is due via the API. |
| 172 | "links": [ # Collection of links. This collection is read-only. |
| 173 | { |
| 174 | "type": "A String", # Type of the link, e.g. "email". |
| 175 | "link": "A String", # The URL. |
| 176 | "description": "A String", # The description. In HTML speak: Everything between &lt;a&gt; and |
| 177 | # &lt;/a&gt;. |
| 178 | }, |
| 179 | ], |
| 180 | "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is |
| 181 | # omitted if the task has not been completed. |
| 182 | "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task |
| 183 | # had been marked completed when the task list was last cleared. The default |
| 184 | # is False. This field is read-only. |
| 185 | }</pre> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 186 | </div> |
| 187 | |
| 188 | <div class="method"> |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 189 | <code class="details" id="insert">insert(tasklist, body=None, parent=None, previous=None, x__xgafv=None)</code> |
| 190 | <pre>Creates a new task on the specified task list. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 191 | |
| 192 | Args: |
| 193 | tasklist: string, Task list identifier. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 194 | body: object, The request body. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 195 | The object takes the form of: |
| 196 | |
| 197 | { |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 198 | "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp). |
| 199 | "etag": "A String", # ETag of the resource. |
| 200 | "title": "A String", # Title of the task. |
| 201 | "kind": "A String", # Type of the resource. This is always "tasks#task". |
| 202 | "id": "A String", # Task identifier. |
| 203 | "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. |
| 204 | # This field is read-only. Use the "move" method to move the task under a |
| 205 | # different parent or to the top level. |
| 206 | "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task. |
| 207 | "notes": "A String", # Notes describing the task. Optional. |
| 208 | "status": "A String", # Status of the task. This is either "needsAction" or "completed". |
| 209 | "deleted": True or False, # Flag indicating whether the task has been deleted. The default is False. |
| 210 | "position": "A String", # String indicating the position of the task among its sibling tasks under |
| 211 | # the same parent task or at the top level. If this string is greater than |
| 212 | # another task's corresponding position string according to lexicographical |
| 213 | # ordering, the task is positioned after the other task under the same parent |
| 214 | # task (or at the top level). This field is read-only. Use the "move" method |
| 215 | # to move the task to another position. |
| 216 | "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only |
| 217 | # records date information; the time portion of the timestamp is discarded |
| 218 | # when setting the due date. It isn't possible to read or write the time that |
| 219 | # a task is due via the API. |
| 220 | "links": [ # Collection of links. This collection is read-only. |
| 221 | { |
| 222 | "type": "A String", # Type of the link, e.g. "email". |
| 223 | "link": "A String", # The URL. |
| 224 | "description": "A String", # The description. In HTML speak: Everything between &lt;a&gt; and |
| 225 | # &lt;/a&gt;. |
| 226 | }, |
| 227 | ], |
| 228 | "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is |
| 229 | # omitted if the task has not been completed. |
| 230 | "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task |
| 231 | # had been marked completed when the task list was last cleared. The default |
| 232 | # is False. This field is read-only. |
| 233 | } |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 234 | |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 235 | parent: string, Parent task identifier. If the task is created at the top level, this |
| 236 | parameter is omitted. Optional. |
| 237 | previous: string, Previous sibling task identifier. If the task is created at the first |
| 238 | position among its siblings, this parameter is omitted. Optional. |
| 239 | x__xgafv: string, V1 error format. |
| 240 | Allowed values |
| 241 | 1 - v1 error format |
| 242 | 2 - v2 error format |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 243 | |
| 244 | Returns: |
| 245 | An object of the form: |
| 246 | |
| 247 | { |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 248 | "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp). |
| 249 | "etag": "A String", # ETag of the resource. |
| 250 | "title": "A String", # Title of the task. |
| 251 | "kind": "A String", # Type of the resource. This is always "tasks#task". |
| 252 | "id": "A String", # Task identifier. |
| 253 | "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. |
| 254 | # This field is read-only. Use the "move" method to move the task under a |
| 255 | # different parent or to the top level. |
| 256 | "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task. |
| 257 | "notes": "A String", # Notes describing the task. Optional. |
| 258 | "status": "A String", # Status of the task. This is either "needsAction" or "completed". |
| 259 | "deleted": True or False, # Flag indicating whether the task has been deleted. The default is False. |
| 260 | "position": "A String", # String indicating the position of the task among its sibling tasks under |
| 261 | # the same parent task or at the top level. If this string is greater than |
| 262 | # another task's corresponding position string according to lexicographical |
| 263 | # ordering, the task is positioned after the other task under the same parent |
| 264 | # task (or at the top level). This field is read-only. Use the "move" method |
| 265 | # to move the task to another position. |
| 266 | "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only |
| 267 | # records date information; the time portion of the timestamp is discarded |
| 268 | # when setting the due date. It isn't possible to read or write the time that |
| 269 | # a task is due via the API. |
| 270 | "links": [ # Collection of links. This collection is read-only. |
| 271 | { |
| 272 | "type": "A String", # Type of the link, e.g. "email". |
| 273 | "link": "A String", # The URL. |
| 274 | "description": "A String", # The description. In HTML speak: Everything between &lt;a&gt; and |
| 275 | # &lt;/a&gt;. |
| 276 | }, |
| 277 | ], |
| 278 | "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is |
| 279 | # omitted if the task has not been completed. |
| 280 | "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task |
| 281 | # had been marked completed when the task list was last cleared. The default |
| 282 | # is False. This field is read-only. |
| 283 | }</pre> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 284 | </div> |
| 285 | |
| 286 | <div class="method"> |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 287 | <code class="details" id="list">list(tasklist, completedMin=None, updatedMin=None, dueMin=None, showHidden=None, showCompleted=None, maxResults=None, pageToken=None, dueMax=None, completedMax=None, showDeleted=None, x__xgafv=None)</code> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 288 | <pre>Returns all tasks in the specified task list. |
| 289 | |
| 290 | Args: |
| 291 | tasklist: string, Task list identifier. (required) |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 292 | completedMin: string, Lower bound for a task's completion date (as a RFC 3339 timestamp) to |
| 293 | filter by. Optional. The default is not to filter by completion date. |
| 294 | updatedMin: string, Lower bound for a task's last modification time (as a RFC 3339 timestamp) |
| 295 | to filter by. Optional. The default is not to filter by last modification |
| 296 | time. |
| 297 | dueMin: string, Lower bound for a task's due date (as a RFC 3339 timestamp) to filter by. |
| 298 | Optional. The default is not to filter by due date. |
| 299 | showHidden: boolean, Flag indicating whether hidden tasks are returned in the result. Optional. |
| 300 | The default is False. |
| 301 | showCompleted: boolean, Flag indicating whether completed tasks are returned in the result. |
| 302 | Optional. The default is True. |
| 303 | maxResults: integer, Maximum number of task lists returned on one page. Optional. The default is |
| 304 | 20 (max allowed: 100). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 305 | pageToken: string, Token specifying the result page to return. Optional. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 306 | dueMax: string, Upper bound for a task's due date (as a RFC 3339 timestamp) to filter by. |
| 307 | Optional. The default is not to filter by due date. |
| 308 | completedMax: string, Upper bound for a task's completion date (as a RFC 3339 timestamp) to |
| 309 | filter by. Optional. The default is not to filter by completion date. |
| 310 | showDeleted: boolean, Flag indicating whether deleted tasks are returned in the result. Optional. |
| 311 | The default is False. |
| 312 | x__xgafv: string, V1 error format. |
| 313 | Allowed values |
| 314 | 1 - v1 error format |
| 315 | 2 - v2 error format |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 316 | |
| 317 | Returns: |
| 318 | An object of the form: |
| 319 | |
| 320 | { |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 321 | "nextPageToken": "A String", # Token used to access the next page of this result. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 322 | "etag": "A String", # ETag of the resource. |
| 323 | "items": [ # Collection of tasks. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 324 | { |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 325 | "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp). |
| 326 | "etag": "A String", # ETag of the resource. |
| 327 | "title": "A String", # Title of the task. |
| 328 | "kind": "A String", # Type of the resource. This is always "tasks#task". |
| 329 | "id": "A String", # Task identifier. |
| 330 | "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. |
| 331 | # This field is read-only. Use the "move" method to move the task under a |
| 332 | # different parent or to the top level. |
| 333 | "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task. |
| 334 | "notes": "A String", # Notes describing the task. Optional. |
| 335 | "status": "A String", # Status of the task. This is either "needsAction" or "completed". |
| 336 | "deleted": True or False, # Flag indicating whether the task has been deleted. The default is False. |
| 337 | "position": "A String", # String indicating the position of the task among its sibling tasks under |
| 338 | # the same parent task or at the top level. If this string is greater than |
| 339 | # another task's corresponding position string according to lexicographical |
| 340 | # ordering, the task is positioned after the other task under the same parent |
| 341 | # task (or at the top level). This field is read-only. Use the "move" method |
| 342 | # to move the task to another position. |
| 343 | "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only |
| 344 | # records date information; the time portion of the timestamp is discarded |
| 345 | # when setting the due date. It isn't possible to read or write the time that |
| 346 | # a task is due via the API. |
| 347 | "links": [ # Collection of links. This collection is read-only. |
| 348 | { |
| 349 | "type": "A String", # Type of the link, e.g. "email". |
| 350 | "link": "A String", # The URL. |
| 351 | "description": "A String", # The description. In HTML speak: Everything between &lt;a&gt; and |
| 352 | # &lt;/a&gt;. |
| 353 | }, |
| 354 | ], |
| 355 | "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is |
| 356 | # omitted if the task has not been completed. |
| 357 | "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task |
| 358 | # had been marked completed when the task list was last cleared. The default |
| 359 | # is False. This field is read-only. |
| 360 | }, |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 361 | ], |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 362 | "kind": "A String", # Type of the resource. This is always "tasks#tasks". |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 363 | }</pre> |
| 364 | </div> |
| 365 | |
| 366 | <div class="method"> |
| 367 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 368 | <pre>Retrieves the next page of results. |
| 369 | |
| 370 | Args: |
| 371 | previous_request: The request for the previous page. (required) |
| 372 | previous_response: The response from the request for the previous page. (required) |
| 373 | |
| 374 | Returns: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 375 | A request object that you can call 'execute()' on to request the next |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 376 | page. Returns None if there are no more items in the collection. |
| 377 | </pre> |
| 378 | </div> |
| 379 | |
| 380 | <div class="method"> |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 381 | <code class="details" id="move">move(tasklist, task, parent=None, previous=None, x__xgafv=None)</code> |
| 382 | <pre>Moves the specified task to another position in the task list. This can |
| 383 | include putting it as a child task under a new parent and/or move it to a |
| 384 | different position among its sibling tasks. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 385 | |
| 386 | Args: |
| 387 | tasklist: string, Task list identifier. (required) |
| 388 | task: string, Task identifier. (required) |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 389 | parent: string, New parent task identifier. If the task is moved to the top level, this |
| 390 | parameter is omitted. Optional. |
| 391 | previous: string, New previous sibling task identifier. If the task is moved to the first |
| 392 | position among its siblings, this parameter is omitted. Optional. |
| 393 | x__xgafv: string, V1 error format. |
| 394 | Allowed values |
| 395 | 1 - v1 error format |
| 396 | 2 - v2 error format |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 397 | |
| 398 | Returns: |
| 399 | An object of the form: |
| 400 | |
| 401 | { |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 402 | "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp). |
| 403 | "etag": "A String", # ETag of the resource. |
| 404 | "title": "A String", # Title of the task. |
| 405 | "kind": "A String", # Type of the resource. This is always "tasks#task". |
| 406 | "id": "A String", # Task identifier. |
| 407 | "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. |
| 408 | # This field is read-only. Use the "move" method to move the task under a |
| 409 | # different parent or to the top level. |
| 410 | "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task. |
| 411 | "notes": "A String", # Notes describing the task. Optional. |
| 412 | "status": "A String", # Status of the task. This is either "needsAction" or "completed". |
| 413 | "deleted": True or False, # Flag indicating whether the task has been deleted. The default is False. |
| 414 | "position": "A String", # String indicating the position of the task among its sibling tasks under |
| 415 | # the same parent task or at the top level. If this string is greater than |
| 416 | # another task's corresponding position string according to lexicographical |
| 417 | # ordering, the task is positioned after the other task under the same parent |
| 418 | # task (or at the top level). This field is read-only. Use the "move" method |
| 419 | # to move the task to another position. |
| 420 | "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only |
| 421 | # records date information; the time portion of the timestamp is discarded |
| 422 | # when setting the due date. It isn't possible to read or write the time that |
| 423 | # a task is due via the API. |
| 424 | "links": [ # Collection of links. This collection is read-only. |
| 425 | { |
| 426 | "type": "A String", # Type of the link, e.g. "email". |
| 427 | "link": "A String", # The URL. |
| 428 | "description": "A String", # The description. In HTML speak: Everything between &lt;a&gt; and |
| 429 | # &lt;/a&gt;. |
| 430 | }, |
| 431 | ], |
| 432 | "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is |
| 433 | # omitted if the task has not been completed. |
| 434 | "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task |
| 435 | # had been marked completed when the task list was last cleared. The default |
| 436 | # is False. This field is read-only. |
| 437 | }</pre> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 438 | </div> |
| 439 | |
| 440 | <div class="method"> |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 441 | <code class="details" id="patch">patch(tasklist, task, body=None, x__xgafv=None)</code> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 442 | <pre>Updates the specified task. This method supports patch semantics. |
| 443 | |
| 444 | Args: |
| 445 | tasklist: string, Task list identifier. (required) |
| 446 | task: string, Task identifier. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 447 | body: object, The request body. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 448 | The object takes the form of: |
| 449 | |
| 450 | { |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 451 | "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp). |
| 452 | "etag": "A String", # ETag of the resource. |
| 453 | "title": "A String", # Title of the task. |
| 454 | "kind": "A String", # Type of the resource. This is always "tasks#task". |
| 455 | "id": "A String", # Task identifier. |
| 456 | "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. |
| 457 | # This field is read-only. Use the "move" method to move the task under a |
| 458 | # different parent or to the top level. |
| 459 | "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task. |
| 460 | "notes": "A String", # Notes describing the task. Optional. |
| 461 | "status": "A String", # Status of the task. This is either "needsAction" or "completed". |
| 462 | "deleted": True or False, # Flag indicating whether the task has been deleted. The default is False. |
| 463 | "position": "A String", # String indicating the position of the task among its sibling tasks under |
| 464 | # the same parent task or at the top level. If this string is greater than |
| 465 | # another task's corresponding position string according to lexicographical |
| 466 | # ordering, the task is positioned after the other task under the same parent |
| 467 | # task (or at the top level). This field is read-only. Use the "move" method |
| 468 | # to move the task to another position. |
| 469 | "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only |
| 470 | # records date information; the time portion of the timestamp is discarded |
| 471 | # when setting the due date. It isn't possible to read or write the time that |
| 472 | # a task is due via the API. |
| 473 | "links": [ # Collection of links. This collection is read-only. |
| 474 | { |
| 475 | "type": "A String", # Type of the link, e.g. "email". |
| 476 | "link": "A String", # The URL. |
| 477 | "description": "A String", # The description. In HTML speak: Everything between &lt;a&gt; and |
| 478 | # &lt;/a&gt;. |
| 479 | }, |
| 480 | ], |
| 481 | "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is |
| 482 | # omitted if the task has not been completed. |
| 483 | "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task |
| 484 | # had been marked completed when the task list was last cleared. The default |
| 485 | # is False. This field is read-only. |
| 486 | } |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 487 | |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 488 | x__xgafv: string, V1 error format. |
| 489 | Allowed values |
| 490 | 1 - v1 error format |
| 491 | 2 - v2 error format |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 492 | |
| 493 | Returns: |
| 494 | An object of the form: |
| 495 | |
| 496 | { |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 497 | "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp). |
| 498 | "etag": "A String", # ETag of the resource. |
| 499 | "title": "A String", # Title of the task. |
| 500 | "kind": "A String", # Type of the resource. This is always "tasks#task". |
| 501 | "id": "A String", # Task identifier. |
| 502 | "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. |
| 503 | # This field is read-only. Use the "move" method to move the task under a |
| 504 | # different parent or to the top level. |
| 505 | "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task. |
| 506 | "notes": "A String", # Notes describing the task. Optional. |
| 507 | "status": "A String", # Status of the task. This is either "needsAction" or "completed". |
| 508 | "deleted": True or False, # Flag indicating whether the task has been deleted. The default is False. |
| 509 | "position": "A String", # String indicating the position of the task among its sibling tasks under |
| 510 | # the same parent task or at the top level. If this string is greater than |
| 511 | # another task's corresponding position string according to lexicographical |
| 512 | # ordering, the task is positioned after the other task under the same parent |
| 513 | # task (or at the top level). This field is read-only. Use the "move" method |
| 514 | # to move the task to another position. |
| 515 | "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only |
| 516 | # records date information; the time portion of the timestamp is discarded |
| 517 | # when setting the due date. It isn't possible to read or write the time that |
| 518 | # a task is due via the API. |
| 519 | "links": [ # Collection of links. This collection is read-only. |
| 520 | { |
| 521 | "type": "A String", # Type of the link, e.g. "email". |
| 522 | "link": "A String", # The URL. |
| 523 | "description": "A String", # The description. In HTML speak: Everything between &lt;a&gt; and |
| 524 | # &lt;/a&gt;. |
| 525 | }, |
| 526 | ], |
| 527 | "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is |
| 528 | # omitted if the task has not been completed. |
| 529 | "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task |
| 530 | # had been marked completed when the task list was last cleared. The default |
| 531 | # is False. This field is read-only. |
| 532 | }</pre> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 533 | </div> |
| 534 | |
| 535 | <div class="method"> |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 536 | <code class="details" id="update">update(tasklist, task, body=None, x__xgafv=None)</code> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 537 | <pre>Updates the specified task. |
| 538 | |
| 539 | Args: |
| 540 | tasklist: string, Task list identifier. (required) |
| 541 | task: string, Task identifier. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 542 | body: object, The request body. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 543 | The object takes the form of: |
| 544 | |
| 545 | { |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 546 | "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp). |
| 547 | "etag": "A String", # ETag of the resource. |
| 548 | "title": "A String", # Title of the task. |
| 549 | "kind": "A String", # Type of the resource. This is always "tasks#task". |
| 550 | "id": "A String", # Task identifier. |
| 551 | "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. |
| 552 | # This field is read-only. Use the "move" method to move the task under a |
| 553 | # different parent or to the top level. |
| 554 | "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task. |
| 555 | "notes": "A String", # Notes describing the task. Optional. |
| 556 | "status": "A String", # Status of the task. This is either "needsAction" or "completed". |
| 557 | "deleted": True or False, # Flag indicating whether the task has been deleted. The default is False. |
| 558 | "position": "A String", # String indicating the position of the task among its sibling tasks under |
| 559 | # the same parent task or at the top level. If this string is greater than |
| 560 | # another task's corresponding position string according to lexicographical |
| 561 | # ordering, the task is positioned after the other task under the same parent |
| 562 | # task (or at the top level). This field is read-only. Use the "move" method |
| 563 | # to move the task to another position. |
| 564 | "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only |
| 565 | # records date information; the time portion of the timestamp is discarded |
| 566 | # when setting the due date. It isn't possible to read or write the time that |
| 567 | # a task is due via the API. |
| 568 | "links": [ # Collection of links. This collection is read-only. |
| 569 | { |
| 570 | "type": "A String", # Type of the link, e.g. "email". |
| 571 | "link": "A String", # The URL. |
| 572 | "description": "A String", # The description. In HTML speak: Everything between &lt;a&gt; and |
| 573 | # &lt;/a&gt;. |
| 574 | }, |
| 575 | ], |
| 576 | "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is |
| 577 | # omitted if the task has not been completed. |
| 578 | "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task |
| 579 | # had been marked completed when the task list was last cleared. The default |
| 580 | # is False. This field is read-only. |
| 581 | } |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 582 | |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 583 | x__xgafv: string, V1 error format. |
| 584 | Allowed values |
| 585 | 1 - v1 error format |
| 586 | 2 - v2 error format |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 587 | |
| 588 | Returns: |
| 589 | An object of the form: |
| 590 | |
| 591 | { |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 592 | "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp). |
| 593 | "etag": "A String", # ETag of the resource. |
| 594 | "title": "A String", # Title of the task. |
| 595 | "kind": "A String", # Type of the resource. This is always "tasks#task". |
| 596 | "id": "A String", # Task identifier. |
| 597 | "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. |
| 598 | # This field is read-only. Use the "move" method to move the task under a |
| 599 | # different parent or to the top level. |
| 600 | "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task. |
| 601 | "notes": "A String", # Notes describing the task. Optional. |
| 602 | "status": "A String", # Status of the task. This is either "needsAction" or "completed". |
| 603 | "deleted": True or False, # Flag indicating whether the task has been deleted. The default is False. |
| 604 | "position": "A String", # String indicating the position of the task among its sibling tasks under |
| 605 | # the same parent task or at the top level. If this string is greater than |
| 606 | # another task's corresponding position string according to lexicographical |
| 607 | # ordering, the task is positioned after the other task under the same parent |
| 608 | # task (or at the top level). This field is read-only. Use the "move" method |
| 609 | # to move the task to another position. |
| 610 | "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only |
| 611 | # records date information; the time portion of the timestamp is discarded |
| 612 | # when setting the due date. It isn't possible to read or write the time that |
| 613 | # a task is due via the API. |
| 614 | "links": [ # Collection of links. This collection is read-only. |
| 615 | { |
| 616 | "type": "A String", # Type of the link, e.g. "email". |
| 617 | "link": "A String", # The URL. |
| 618 | "description": "A String", # The description. In HTML speak: Everything between &lt;a&gt; and |
| 619 | # &lt;/a&gt;. |
| 620 | }, |
| 621 | ], |
| 622 | "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is |
| 623 | # omitted if the task has not been completed. |
| 624 | "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task |
| 625 | # had been marked completed when the task list was last cleared. The default |
| 626 | # is False. This field is read-only. |
| 627 | }</pre> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 628 | </div> |
| 629 | |
| 630 | </body></html> |