Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 614db98bf45b9da1f29c35a9d942536111e99d41 / . / docs / dyn / tasks_v1.tasks.html
blob: d5808334f69b3a7363a9d3058401fabb4173dfee [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame^]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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, showCompleted=None, dueMin=None, dueMax=None, pageToken=None, updatedMin=None, showDeleted=None, completedMax=None, maxResults=None, completedMin=None, showHidden=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
109Args:
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
118Args:
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
128Args:
129 tasklist: string, Task list identifier. (required)
130 task: string, Task identifier. (required)
131
132Returns:
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 "links": [ # Collection of links. This collection is read-only.
141 {
142 "type": "A String", # Type of the link, e.g. "email".
143 "link": "A String", # The URL.
144 "description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
145 },
146 ],
147 "title": "A String", # Title of the task.
148 "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
149 "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
150 "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
151 "etag": "A String", # ETag of the resource.
152 "notes": "A String", # Notes describing the task. Optional.
153 "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.
154 "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.
155 "id": "A String", # Task identifier.
156 "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
157 }</pre>
158</div>
159
160<div class="method">
161 <code class="details" id="insert">insert(tasklist, body, parent=None, previous=None)</code>
162 <pre>Creates a new task on the specified task list.
163
164Args:
165 tasklist: string, Task list identifier. (required)
166 body: object, The request body. (required)
167 The object takes the form of:
168
169{
170 "status": "A String", # Status of the task. This is either "needsAction" or "completed".
171 "kind": "tasks#task", # Type of the resource. This is always "tasks#task".
172 "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
173 "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.
174 "links": [ # Collection of links. This collection is read-only.
175 {
176 "type": "A String", # Type of the link, e.g. "email".
177 "link": "A String", # The URL.
178 "description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
179 },
180 ],
181 "title": "A String", # Title of the task.
182 "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
183 "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
184 "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
185 "etag": "A String", # ETag of the resource.
186 "notes": "A String", # Notes describing the task. Optional.
187 "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.
188 "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.
189 "id": "A String", # Task identifier.
190 "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
191 }
192
193 parent: string, Parent task identifier. If the task is created at the top level, this parameter is omitted. Optional.
194 previous: string, Previous sibling task identifier. If the task is created at the first position among its siblings, this parameter is omitted. Optional.
195
196Returns:
197 An object of the form:
198
199 {
200 "status": "A String", # Status of the task. This is either "needsAction" or "completed".
201 "kind": "tasks#task", # Type of the resource. This is always "tasks#task".
202 "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
203 "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.
204 "links": [ # Collection of links. This collection is read-only.
205 {
206 "type": "A String", # Type of the link, e.g. "email".
207 "link": "A String", # The URL.
208 "description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
209 },
210 ],
211 "title": "A String", # Title of the task.
212 "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
213 "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
214 "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
215 "etag": "A String", # ETag of the resource.
216 "notes": "A String", # Notes describing the task. Optional.
217 "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.
218 "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.
219 "id": "A String", # Task identifier.
220 "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
221 }</pre>
222</div>
223
224<div class="method">
225 <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>
226 <pre>Returns all tasks in the specified task list.
227
228Args:
229 tasklist: string, Task list identifier. (required)
230 showCompleted: boolean, Flag indicating whether completed tasks are returned in the result. Optional. The default is True.
231 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.
232 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.
233 pageToken: string, Token specifying the result page to return. Optional.
234 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.
235 showDeleted: boolean, Flag indicating whether deleted tasks are returned in the result. Optional. The default is False.
236 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.
237 maxResults: string, Maximum number of task lists returned on one page. Optional. The default is 100.
238 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.
239 showHidden: boolean, Flag indicating whether hidden tasks are returned in the result. Optional. The default is False.
240
241Returns:
242 An object of the form:
243
244 {
245 "nextPageToken": "A String", # Token used to access the next page of this result.
246 "items": [ # Collection of tasks.
247 {
248 "status": "A String", # Status of the task. This is either "needsAction" or "completed".
249 "kind": "tasks#task", # Type of the resource. This is always "tasks#task".
250 "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
251 "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.
252 "links": [ # Collection of links. This collection is read-only.
253 {
254 "type": "A String", # Type of the link, e.g. "email".
255 "link": "A String", # The URL.
256 "description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
257 },
258 ],
259 "title": "A String", # Title of the task.
260 "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
261 "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
262 "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
263 "etag": "A String", # ETag of the resource.
264 "notes": "A String", # Notes describing the task. Optional.
265 "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.
266 "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.
267 "id": "A String", # Task identifier.
268 "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
269 },
270 ],
271 "kind": "tasks#tasks", # Type of the resource. This is always "tasks#tasks".
272 "etag": "A String", # ETag of the resource.
273 }</pre>
274</div>
275
276<div class="method">
277 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
278 <pre>Retrieves the next page of results.
279
280Args:
281 previous_request: The request for the previous page. (required)
282 previous_response: The response from the request for the previous page. (required)
283
284Returns:
285 A request object that you can call 'execute()' on to request the next
286 page. Returns None if there are no more items in the collection.
287 </pre>
288</div>
289
290<div class="method">
291 <code class="details" id="move">move(tasklist, task, parent=None, previous=None)</code>
292 <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.
293
294Args:
295 tasklist: string, Task list identifier. (required)
296 task: string, Task identifier. (required)
297 parent: string, New parent task identifier. If the task is moved to the top level, this parameter is omitted. Optional.
298 previous: string, New previous sibling task identifier. If the task is moved to the first position among its siblings, this parameter is omitted. Optional.
299
300Returns:
301 An object of the form:
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 "links": [ # Collection of links. This collection is read-only.
309 {
310 "type": "A String", # Type of the link, e.g. "email".
311 "link": "A String", # The URL.
312 "description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
313 },
314 ],
315 "title": "A String", # Title of the task.
316 "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
317 "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
318 "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
319 "etag": "A String", # ETag of the resource.
320 "notes": "A String", # Notes describing the task. Optional.
321 "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.
322 "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.
323 "id": "A String", # Task identifier.
324 "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
325 }</pre>
326</div>
327
328<div class="method">
329 <code class="details" id="patch">patch(tasklist, task, body)</code>
330 <pre>Updates the specified task. This method supports patch semantics.
331
332Args:
333 tasklist: string, Task list identifier. (required)
334 task: string, Task identifier. (required)
335 body: object, The request body. (required)
336 The object takes the form of:
337
338{
339 "status": "A String", # Status of the task. This is either "needsAction" or "completed".
340 "kind": "tasks#task", # Type of the resource. This is always "tasks#task".
341 "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
342 "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.
343 "links": [ # Collection of links. This collection is read-only.
344 {
345 "type": "A String", # Type of the link, e.g. "email".
346 "link": "A String", # The URL.
347 "description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
348 },
349 ],
350 "title": "A String", # Title of the task.
351 "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
352 "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
353 "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
354 "etag": "A String", # ETag of the resource.
355 "notes": "A String", # Notes describing the task. Optional.
356 "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.
357 "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.
358 "id": "A String", # Task identifier.
359 "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
360 }
361
362
363Returns:
364 An object of the form:
365
366 {
367 "status": "A String", # Status of the task. This is either "needsAction" or "completed".
368 "kind": "tasks#task", # Type of the resource. This is always "tasks#task".
369 "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
370 "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.
371 "links": [ # Collection of links. This collection is read-only.
372 {
373 "type": "A String", # Type of the link, e.g. "email".
374 "link": "A String", # The URL.
375 "description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
376 },
377 ],
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<div class="method">
392 <code class="details" id="update">update(tasklist, task, body)</code>
393 <pre>Updates the specified task.
394
395Args:
396 tasklist: string, Task list identifier. (required)
397 task: string, Task identifier. (required)
398 body: object, The request body. (required)
399 The object takes the form of:
400
401{
402 "status": "A String", # Status of the task. This is either "needsAction" or "completed".
403 "kind": "tasks#task", # Type of the resource. This is always "tasks#task".
404 "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
405 "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.
406 "links": [ # Collection of links. This collection is read-only.
407 {
408 "type": "A String", # Type of the link, e.g. "email".
409 "link": "A String", # The URL.
410 "description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
411 },
412 ],
413 "title": "A String", # Title of the task.
414 "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
415 "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
416 "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
417 "etag": "A String", # ETag of the resource.
418 "notes": "A String", # Notes describing the task. Optional.
419 "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.
420 "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.
421 "id": "A String", # Task identifier.
422 "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
423 }
424
425
426Returns:
427 An object of the form:
428
429 {
430 "status": "A String", # Status of the task. This is either "needsAction" or "completed".
431 "kind": "tasks#task", # Type of the resource. This is always "tasks#task".
432 "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
433 "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.
434 "links": [ # Collection of links. This collection is read-only.
435 {
436 "type": "A String", # Type of the link, e.g. "email".
437 "link": "A String", # The URL.
438 "description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
439 },
440 ],
441 "title": "A String", # Title of the task.
442 "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
443 "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
444 "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
445 "etag": "A String", # ETag of the resource.
446 "notes": "A String", # Notes describing the task. Optional.
447 "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.
448 "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.
449 "id": "A String", # Task identifier.
450 "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
451 }</pre>
452</div>
453
454</body></html>