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"> 78 <code><a href="#clear">clear(tasklist)</a></code></p> 79 <p class="firstline">Clears all completed tasks from the specified task list. The affected tasks will be marked as 'hidden' and no longer be returned by default when retrieving all tasks for a task list.</p> 80 <p class="toc_element"> 81 <code><a href="#delete">delete(tasklist, task)</a></code></p> 82 <p class="firstline">Deletes the specified task from the task list.</p> 83 <p class="toc_element"> 84 <code><a href="#get">get(tasklist, task)</a></code></p> 85 <p class="firstline">Returns the specified task.</p> 86 <p class="toc_element"> 87 <code><a href="#insert">insert(tasklist, body, parent=None, previous=None)</a></code></p> 88 <p class="firstline">Creates a new task on the specified task list.</p> 89 <p class="toc_element"> 90 <code><a href="#list">list(tasklist, dueMax=None, pageToken=None, updatedMin=None, maxResults=None, completedMin=None, showDeleted=None, completedMax=None, showHidden=None, showCompleted=None, dueMin=None)</a></code></p> 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"> 96 <code><a href="#move">move(tasklist, task, parent=None, previous=None)</a></code></p> 97 <p class="firstline">Moves the specified task to another position in the task list. This can include putting it as a child task under a new parent and/or move it to a different position among its sibling tasks.</p> 98 <p class="toc_element"> 99 <code><a href="#patch">patch(tasklist, task, body)</a></code></p> 100 <p class="firstline">Updates the specified task. This method supports patch semantics.</p> 101 <p class="toc_element"> 102 <code><a href="#update">update(tasklist, task, body)</a></code></p> 103 <p class="firstline">Updates the specified task.</p> 104 <h3>Method Details</h3> 105 <div class="method"> 106 <code class="details" id="clear">clear(tasklist)</code> 107 <pre>Clears all completed tasks from the specified task list. The affected tasks will be marked as 'hidden' and no longer be returned by default when retrieving all tasks for a task list. 108 109 Args: 110 tasklist: string, Task list identifier. (required) 111 </pre> 112 </div> 113 114 <div class="method"> 115 <code class="details" id="delete">delete(tasklist, task)</code> 116 <pre>Deletes the specified task from the task list. 117 118 Args: 119 tasklist: string, Task list identifier. (required) 120 task: string, Task identifier. (required) 121 </pre> 122 </div> 123 124 <div class="method"> 125 <code class="details" id="get">get(tasklist, task)</code> 126 <pre>Returns the specified task. 127 128 Args: 129 tasklist: string, Task list identifier. (required) 130 task: string, Task identifier. (required) 131 132 Returns: 133 An object of the form: 134 135 { 136 "status": "A String", # Status of the task. This is either "needsAction" or "completed". 137 "kind": "tasks#task", # Type of the resource. This is always "tasks#task". 138 "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp). 139 "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level. 140 "title": "A String", # Title of the task. 141 "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False. 142 "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed. 143 "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. 144 "etag": "A String", # ETag of the resource. 145 "notes": "A String", # Notes describing the task. Optional. 146 "position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position. 147 "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only. 148 "id": "A String", # Task identifier. 149 "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task. 150 }</pre> 151 </div> 152 153 <div class="method"> 154 <code class="details" id="insert">insert(tasklist, body, parent=None, previous=None)</code> 155 <pre>Creates a new task on the specified task list. 156 157 Args: 158 tasklist: string, Task list identifier. (required) 159 body: object, The request body. (required) 160 The object takes the form of: 161 162 { 163 "status": "A String", # Status of the task. This is either "needsAction" or "completed". 164 "kind": "tasks#task", # Type of the resource. This is always "tasks#task". 165 "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp). 166 "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level. 167 "title": "A String", # Title of the task. 168 "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False. 169 "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed. 170 "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. 171 "etag": "A String", # ETag of the resource. 172 "notes": "A String", # Notes describing the task. Optional. 173 "position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position. 174 "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only. 175 "id": "A String", # Task identifier. 176 "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task. 177 } 178 179 parent: string, Parent task identifier. If the task is created at the top level, this parameter is omitted. Optional. 180 previous: string, Previous sibling task identifier. If the task is created at the first position among its siblings, this parameter is omitted. Optional. 181 182 Returns: 183 An object of the form: 184 185 { 186 "status": "A String", # Status of the task. This is either "needsAction" or "completed". 187 "kind": "tasks#task", # Type of the resource. This is always "tasks#task". 188 "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp). 189 "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level. 190 "title": "A String", # Title of the task. 191 "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False. 192 "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed. 193 "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. 194 "etag": "A String", # ETag of the resource. 195 "notes": "A String", # Notes describing the task. Optional. 196 "position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position. 197 "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only. 198 "id": "A String", # Task identifier. 199 "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task. 200 }</pre> 201 </div> 202 203 <div class="method"> 204 <code class="details" id="list">list(tasklist, dueMax=None, pageToken=None, updatedMin=None, maxResults=None, completedMin=None, showDeleted=None, completedMax=None, showHidden=None, showCompleted=None, dueMin=None)</code> 205 <pre>Returns all tasks in the specified task list. 206 207 Args: 208 tasklist: string, Task list identifier. (required) 209 dueMax: string, Upper bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date. 210 pageToken: string, Token specifying the result page to return. Optional. 211 updatedMin: string, Lower bound for a task's last modification time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by last modification time. 212 maxResults: integer, Maximum number of task lists returned on one page. Optional. The default is 100. 213 completedMin: string, Lower bound for a task's completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date. 214 showDeleted: boolean, Flag indicating whether deleted tasks are returned in the result. Optional. The default is False. 215 completedMax: string, Upper bound for a task's completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date. 216 showHidden: boolean, Flag indicating whether hidden tasks are returned in the result. Optional. The default is False. 217 showCompleted: boolean, Flag indicating whether completed tasks are returned in the result. Optional. The default is True. 218 dueMin: string, Lower bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date. 219 220 Returns: 221 An object of the form: 222 223 { 224 "nextPageToken": "A String", # Token used to access the next page of this result. 225 "items": [ # Collection of tasks. 226 { 227 "status": "A String", # Status of the task. This is either "needsAction" or "completed". 228 "kind": "tasks#task", # Type of the resource. This is always "tasks#task". 229 "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp). 230 "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level. 231 "title": "A String", # Title of the task. 232 "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False. 233 "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed. 234 "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. 235 "etag": "A String", # ETag of the resource. 236 "notes": "A String", # Notes describing the task. Optional. 237 "position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position. 238 "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only. 239 "id": "A String", # Task identifier. 240 "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task. 241 }, 242 ], 243 "kind": "tasks#tasks", # Type of the resource. This is always "tasks#tasks". 244 "etag": "A String", # ETag of the resource. 245 }</pre> 246 </div> 247 248 <div class="method"> 249 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 250 <pre>Retrieves the next page of results. 251 252 Args: 253 previous_request: The request for the previous page. (required) 254 previous_response: The response from the request for the previous page. (required) 255 256 Returns: 257 A request object that you can call 'execute()' on to request the next 258 page. Returns None if there are no more items in the collection. 259 </pre> 260 </div> 261 262 <div class="method"> 263 <code class="details" id="move">move(tasklist, task, parent=None, previous=None)</code> 264 <pre>Moves the specified task to another position in the task list. This can include putting it as a child task under a new parent and/or move it to a different position among its sibling tasks. 265 266 Args: 267 tasklist: string, Task list identifier. (required) 268 task: string, Task identifier. (required) 269 parent: string, New parent task identifier. If the task is moved to the top level, this parameter is omitted. Optional. 270 previous: string, New previous sibling task identifier. If the task is moved to the first position among its siblings, this parameter is omitted. Optional. 271 272 Returns: 273 An object of the form: 274 275 { 276 "status": "A String", # Status of the task. This is either "needsAction" or "completed". 277 "kind": "tasks#task", # Type of the resource. This is always "tasks#task". 278 "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp). 279 "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level. 280 "title": "A String", # Title of the task. 281 "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False. 282 "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed. 283 "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. 284 "etag": "A String", # ETag of the resource. 285 "notes": "A String", # Notes describing the task. Optional. 286 "position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position. 287 "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only. 288 "id": "A String", # Task identifier. 289 "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task. 290 }</pre> 291 </div> 292 293 <div class="method"> 294 <code class="details" id="patch">patch(tasklist, task, body)</code> 295 <pre>Updates the specified task. This method supports patch semantics. 296 297 Args: 298 tasklist: string, Task list identifier. (required) 299 task: string, Task identifier. (required) 300 body: object, The request body. (required) 301 The object takes the form of: 302 303 { 304 "status": "A String", # Status of the task. This is either "needsAction" or "completed". 305 "kind": "tasks#task", # Type of the resource. This is always "tasks#task". 306 "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp). 307 "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level. 308 "title": "A String", # Title of the task. 309 "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False. 310 "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed. 311 "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. 312 "etag": "A String", # ETag of the resource. 313 "notes": "A String", # Notes describing the task. Optional. 314 "position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position. 315 "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only. 316 "id": "A String", # Task identifier. 317 "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task. 318 } 319 320 321 Returns: 322 An object of the form: 323 324 { 325 "status": "A String", # Status of the task. This is either "needsAction" or "completed". 326 "kind": "tasks#task", # Type of the resource. This is always "tasks#task". 327 "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp). 328 "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level. 329 "title": "A String", # Title of the task. 330 "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False. 331 "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed. 332 "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. 333 "etag": "A String", # ETag of the resource. 334 "notes": "A String", # Notes describing the task. Optional. 335 "position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position. 336 "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only. 337 "id": "A String", # Task identifier. 338 "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task. 339 }</pre> 340 </div> 341 342 <div class="method"> 343 <code class="details" id="update">update(tasklist, task, body)</code> 344 <pre>Updates the specified task. 345 346 Args: 347 tasklist: string, Task list identifier. (required) 348 task: string, Task identifier. (required) 349 body: object, The request body. (required) 350 The object takes the form of: 351 352 { 353 "status": "A String", # Status of the task. This is either "needsAction" or "completed". 354 "kind": "tasks#task", # Type of the resource. This is always "tasks#task". 355 "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp). 356 "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level. 357 "title": "A String", # Title of the task. 358 "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False. 359 "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed. 360 "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. 361 "etag": "A String", # ETag of the resource. 362 "notes": "A String", # Notes describing the task. Optional. 363 "position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position. 364 "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only. 365 "id": "A String", # Task identifier. 366 "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task. 367 } 368 369 370 Returns: 371 An object of the form: 372 373 { 374 "status": "A String", # Status of the task. This is either "needsAction" or "completed". 375 "kind": "tasks#task", # Type of the resource. This is always "tasks#task". 376 "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp). 377 "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level. 378 "title": "A String", # Title of the task. 379 "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False. 380 "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed. 381 "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. 382 "etag": "A String", # ETag of the resource. 383 "notes": "A String", # Notes describing the task. Optional. 384 "position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position. 385 "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only. 386 "id": "A String", # Task identifier. 387 "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task. 388 }</pre> 389 </div> 390 391 </body></html>
