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
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
|
<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="tasks_v1.html">Tasks API</a> . <a href="tasks_v1.tasks.html">tasks</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#clear">clear(tasklist)</a></code></p>
<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>
<p class="toc_element">
<code><a href="#delete">delete(tasklist, task)</a></code></p>
<p class="firstline">Deletes the specified task from the task list.</p>
<p class="toc_element">
<code><a href="#get">get(tasklist, task)</a></code></p>
<p class="firstline">Returns the specified task.</p>
<p class="toc_element">
<code><a href="#insert">insert(tasklist, body, parent=None, previous=None)</a></code></p>
<p class="firstline">Creates a new task on the specified task list.</p>
<p class="toc_element">
<code><a href="#list">list(tasklist, showCompleted=None, dueMin=None, dueMax=None, pageToken=None, updatedMin=None, showDeleted=None, completedMax=None, maxResults=None, completedMin=None, showHidden=None)</a></code></p>
<p class="firstline">Returns all tasks in the specified task list.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#move">move(tasklist, task, parent=None, previous=None)</a></code></p>
<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>
<p class="toc_element">
<code><a href="#patch">patch(tasklist, task, body)</a></code></p>
<p class="firstline">Updates the specified task. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(tasklist, task, body)</a></code></p>
<p class="firstline">Updates the specified task.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="clear">clear(tasklist)</code>
<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.
Args:
tasklist: string, Task list identifier. (required)
</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(tasklist, task)</code>
<pre>Deletes the specified task from the task list.
Args:
tasklist: string, Task list identifier. (required)
task: string, Task identifier. (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(tasklist, task)</code>
<pre>Returns the specified task.
Args:
tasklist: string, Task list identifier. (required)
task: string, Task identifier. (required)
Returns:
An object of the form:
{
"status": "A String", # Status of the task. This is either "needsAction" or "completed".
"kind": "tasks#task", # Type of the resource. This is always "tasks#task".
"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
"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.
"links": [ # Collection of links. This collection is read-only.
{
"type": "A String", # Type of the link, e.g. "email".
"link": "A String", # The URL.
"description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
},
],
"title": "A String", # Title of the task.
"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
"due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
"etag": "A String", # ETag of the resource.
"notes": "A String", # Notes describing the task. Optional.
"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.
"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.
"id": "A String", # Task identifier.
"selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(tasklist, body, parent=None, previous=None)</code>
<pre>Creates a new task on the specified task list.
Args:
tasklist: string, Task list identifier. (required)
body: object, The request body. (required)
The object takes the form of:
{
"status": "A String", # Status of the task. This is either "needsAction" or "completed".
"kind": "tasks#task", # Type of the resource. This is always "tasks#task".
"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
"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.
"links": [ # Collection of links. This collection is read-only.
{
"type": "A String", # Type of the link, e.g. "email".
"link": "A String", # The URL.
"description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
},
],
"title": "A String", # Title of the task.
"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
"due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
"etag": "A String", # ETag of the resource.
"notes": "A String", # Notes describing the task. Optional.
"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.
"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.
"id": "A String", # Task identifier.
"selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
}
parent: string, Parent task identifier. If the task is created at the top level, this parameter is omitted. Optional.
previous: string, Previous sibling task identifier. If the task is created at the first position among its siblings, this parameter is omitted. Optional.
Returns:
An object of the form:
{
"status": "A String", # Status of the task. This is either "needsAction" or "completed".
"kind": "tasks#task", # Type of the resource. This is always "tasks#task".
"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
"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.
"links": [ # Collection of links. This collection is read-only.
{
"type": "A String", # Type of the link, e.g. "email".
"link": "A String", # The URL.
"description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
},
],
"title": "A String", # Title of the task.
"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
"due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
"etag": "A String", # ETag of the resource.
"notes": "A String", # Notes describing the task. Optional.
"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.
"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.
"id": "A String", # Task identifier.
"selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(tasklist, showCompleted=None, dueMin=None, dueMax=None, pageToken=None, updatedMin=None, showDeleted=None, completedMax=None, maxResults=None, completedMin=None, showHidden=None)</code>
<pre>Returns all tasks in the specified task list.
Args:
tasklist: string, Task list identifier. (required)
showCompleted: boolean, Flag indicating whether completed tasks are returned in the result. Optional. The default is True.
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.
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.
pageToken: string, Token specifying the result page to return. Optional.
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.
showDeleted: boolean, Flag indicating whether deleted tasks are returned in the result. Optional. The default is False.
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.
maxResults: string, Maximum number of task lists returned on one page. Optional. The default is 100.
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.
showHidden: boolean, Flag indicating whether hidden tasks are returned in the result. Optional. The default is False.
Returns:
An object of the form:
{
"nextPageToken": "A String", # Token used to access the next page of this result.
"items": [ # Collection of tasks.
{
"status": "A String", # Status of the task. This is either "needsAction" or "completed".
"kind": "tasks#task", # Type of the resource. This is always "tasks#task".
"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
"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.
"links": [ # Collection of links. This collection is read-only.
{
"type": "A String", # Type of the link, e.g. "email".
"link": "A String", # The URL.
"description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
},
],
"title": "A String", # Title of the task.
"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
"due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
"etag": "A String", # ETag of the resource.
"notes": "A String", # Notes describing the task. Optional.
"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.
"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.
"id": "A String", # Task identifier.
"selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
},
],
"kind": "tasks#tasks", # Type of the resource. This is always "tasks#tasks".
"etag": "A String", # ETag of the resource.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</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="move">move(tasklist, task, parent=None, previous=None)</code>
<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.
Args:
tasklist: string, Task list identifier. (required)
task: string, Task identifier. (required)
parent: string, New parent task identifier. If the task is moved to the top level, this parameter is omitted. Optional.
previous: string, New previous sibling task identifier. If the task is moved to the first position among its siblings, this parameter is omitted. Optional.
Returns:
An object of the form:
{
"status": "A String", # Status of the task. This is either "needsAction" or "completed".
"kind": "tasks#task", # Type of the resource. This is always "tasks#task".
"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
"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.
"links": [ # Collection of links. This collection is read-only.
{
"type": "A String", # Type of the link, e.g. "email".
"link": "A String", # The URL.
"description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
},
],
"title": "A String", # Title of the task.
"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
"due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
"etag": "A String", # ETag of the resource.
"notes": "A String", # Notes describing the task. Optional.
"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.
"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.
"id": "A String", # Task identifier.
"selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(tasklist, task, body)</code>
<pre>Updates the specified task. This method supports patch semantics.
Args:
tasklist: string, Task list identifier. (required)
task: string, Task identifier. (required)
body: object, The request body. (required)
The object takes the form of:
{
"status": "A String", # Status of the task. This is either "needsAction" or "completed".
"kind": "tasks#task", # Type of the resource. This is always "tasks#task".
"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
"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.
"links": [ # Collection of links. This collection is read-only.
{
"type": "A String", # Type of the link, e.g. "email".
"link": "A String", # The URL.
"description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
},
],
"title": "A String", # Title of the task.
"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
"due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
"etag": "A String", # ETag of the resource.
"notes": "A String", # Notes describing the task. Optional.
"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.
"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.
"id": "A String", # Task identifier.
"selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
}
Returns:
An object of the form:
{
"status": "A String", # Status of the task. This is either "needsAction" or "completed".
"kind": "tasks#task", # Type of the resource. This is always "tasks#task".
"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
"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.
"links": [ # Collection of links. This collection is read-only.
{
"type": "A String", # Type of the link, e.g. "email".
"link": "A String", # The URL.
"description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
},
],
"title": "A String", # Title of the task.
"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
"due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
"etag": "A String", # ETag of the resource.
"notes": "A String", # Notes describing the task. Optional.
"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.
"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.
"id": "A String", # Task identifier.
"selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(tasklist, task, body)</code>
<pre>Updates the specified task.
Args:
tasklist: string, Task list identifier. (required)
task: string, Task identifier. (required)
body: object, The request body. (required)
The object takes the form of:
{
"status": "A String", # Status of the task. This is either "needsAction" or "completed".
"kind": "tasks#task", # Type of the resource. This is always "tasks#task".
"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
"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.
"links": [ # Collection of links. This collection is read-only.
{
"type": "A String", # Type of the link, e.g. "email".
"link": "A String", # The URL.
"description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
},
],
"title": "A String", # Title of the task.
"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
"due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
"etag": "A String", # ETag of the resource.
"notes": "A String", # Notes describing the task. Optional.
"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.
"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.
"id": "A String", # Task identifier.
"selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
}
Returns:
An object of the form:
{
"status": "A String", # Status of the task. This is either "needsAction" or "completed".
"kind": "tasks#task", # Type of the resource. This is always "tasks#task".
"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
"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.
"links": [ # Collection of links. This collection is read-only.
{
"type": "A String", # Type of the link, e.g. "email".
"link": "A String", # The URL.
"description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
},
],
"title": "A String", # Title of the task.
"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
"due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
"etag": "A String", # ETag of the resource.
"notes": "A String", # Notes describing the task. Optional.
"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.
"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.
"id": "A String", # Task identifier.
"selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
}</pre>
</div>
</body></html>
|
