Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c2228be4630e279e02a25b51566a0f93b67aa499 / . / docs / dyn / tasks_v1.tasks.html
blob: 799b68af1f3762fa7a88ef76bdcf455bfcb1e104 [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">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]78 <code><a href="#clear">clear(tasklist, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]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="#close">close()</a></code></p>
82<p class="firstline">Close httplib2 connections.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]83<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]84 <code><a href="#delete">delete(tasklist, task, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]85<p class="firstline">Deletes the specified task from the task list.</p>
86<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]87 <code><a href="#get">get(tasklist, task, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]88<p class="firstline">Returns the specified task.</p>
89<p class="toc_element">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]90 <code><a href="#insert">insert(tasklist, body=None, parent=None, previous=None, x__xgafv=None)</a></code></p>
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]91<p class="firstline">Creates a new task on the specified task list.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]92<p class="toc_element">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]93 <code><a href="#list">list(tasklist, showCompleted=None, showDeleted=None, updatedMin=None, maxResults=None, showHidden=None, pageToken=None, completedMax=None, dueMax=None, completedMin=None, dueMin=None, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]94<p class="firstline">Returns all tasks in the specified task list.</p>
95<p class="toc_element">
96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<p class="toc_element">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]99 <code><a href="#move">move(tasklist, task, parent=None, previous=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]100<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>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]101<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]102 <code><a href="#patch">patch(tasklist, task, body=None, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]103<p class="firstline">Updates the specified task. This method supports patch semantics.</p>
104<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]105 <code><a href="#update">update(tasklist, task, body=None, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]106<p class="firstline">Updates the specified task.</p>
107<h3>Method Details</h3>
108<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]109 <code class="details" id="clear">clear(tasklist, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]110 <pre>Clears all completed tasks from the specified task list. The affected tasks will be marked as &#x27;hidden&#x27; and no longer be returned by default when retrieving all tasks for a task list.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]111
112Args:
113 tasklist: string, Task list identifier. (required)
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]114 x__xgafv: string, V1 error format.
115 Allowed values
116 1 - v1 error format
117 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]118</pre>
119</div>
120
121<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]122 <code class="details" id="close">close()</code>
123 <pre>Close httplib2 connections.</pre>
124</div>
125
126<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]127 <code class="details" id="delete">delete(tasklist, task, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]128 <pre>Deletes the specified task from the task list.
129
130Args:
131 tasklist: string, Task list identifier. (required)
132 task: string, Task identifier. (required)
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]133 x__xgafv: string, V1 error format.
134 Allowed values
135 1 - v1 error format
136 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]137</pre>
138</div>
139
140<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]141 <code class="details" id="get">get(tasklist, task, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]142 <pre>Returns the specified task.
143
144Args:
145 tasklist: string, Task list identifier. (required)
146 task: string, Task identifier. (required)
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]147 x__xgafv: string, V1 error format.
148 Allowed values
149 1 - v1 error format
150 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]151
152Returns:
153 An object of the form:
154
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]155 { # LINT.IfChange
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]156 &quot;updated&quot;: &quot;A String&quot;, # Last modification time of the task (as a RFC 3339 timestamp).
157 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
158 &quot;links&quot;: [ # Collection of links. This collection is read-only.
159 {
160 &quot;description&quot;: &quot;A String&quot;, # The description. In HTML speak: Everything between &lt;a&gt; and &lt;/a&gt;.
161 &quot;link&quot;: &quot;A String&quot;, # The URL.
162 &quot;type&quot;: &quot;A String&quot;, # Type of the link, e.g. &quot;email&quot;.
163 },
164 ],
165 &quot;title&quot;: &quot;A String&quot;, # Title of the task.
166 &quot;deleted&quot;: True or False, # Flag indicating whether the task has been deleted. The default is False.
167 &quot;id&quot;: &quot;A String&quot;, # Task identifier.
168 &quot;completed&quot;: &quot;A String&quot;, # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
169 &quot;selfLink&quot;: &quot;A String&quot;, # URL pointing to this task. Used to retrieve, update, or delete this task.
170 &quot;position&quot;: &quot;A String&quot;, # 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&#x27;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 &quot;move&quot; method to move the task to another position.
171 &quot;notes&quot;: &quot;A String&quot;, # Notes describing the task. Optional.
172 &quot;kind&quot;: &quot;A String&quot;, # Type of the resource. This is always &quot;tasks#task&quot;.
173 &quot;parent&quot;: &quot;A String&quot;, # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the &quot;move&quot; method to move the task under a different parent or to the top level.
174 &quot;due&quot;: &quot;A String&quot;, # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only records date information; the time portion of the timestamp is discarded when setting the due date. It isn&#x27;t possible to read or write the time that a task is due via the API.
175 &quot;hidden&quot;: 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.
176 &quot;status&quot;: &quot;A String&quot;, # Status of the task. This is either &quot;needsAction&quot; or &quot;completed&quot;.
177 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]178</div>
179
180<div class="method">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]181 <code class="details" id="insert">insert(tasklist, body=None, parent=None, previous=None, x__xgafv=None)</code>
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]182 <pre>Creates a new task on the specified task list.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]183
184Args:
185 tasklist: string, Task list identifier. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]186 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]187 The object takes the form of:
188
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]189{ # LINT.IfChange
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]190 &quot;updated&quot;: &quot;A String&quot;, # Last modification time of the task (as a RFC 3339 timestamp).
191 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
192 &quot;links&quot;: [ # Collection of links. This collection is read-only.
193 {
194 &quot;description&quot;: &quot;A String&quot;, # The description. In HTML speak: Everything between &lt;a&gt; and &lt;/a&gt;.
195 &quot;link&quot;: &quot;A String&quot;, # The URL.
196 &quot;type&quot;: &quot;A String&quot;, # Type of the link, e.g. &quot;email&quot;.
197 },
198 ],
199 &quot;title&quot;: &quot;A String&quot;, # Title of the task.
200 &quot;deleted&quot;: True or False, # Flag indicating whether the task has been deleted. The default is False.
201 &quot;id&quot;: &quot;A String&quot;, # Task identifier.
202 &quot;completed&quot;: &quot;A String&quot;, # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
203 &quot;selfLink&quot;: &quot;A String&quot;, # URL pointing to this task. Used to retrieve, update, or delete this task.
204 &quot;position&quot;: &quot;A String&quot;, # 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&#x27;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 &quot;move&quot; method to move the task to another position.
205 &quot;notes&quot;: &quot;A String&quot;, # Notes describing the task. Optional.
206 &quot;kind&quot;: &quot;A String&quot;, # Type of the resource. This is always &quot;tasks#task&quot;.
207 &quot;parent&quot;: &quot;A String&quot;, # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the &quot;move&quot; method to move the task under a different parent or to the top level.
208 &quot;due&quot;: &quot;A String&quot;, # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only records date information; the time portion of the timestamp is discarded when setting the due date. It isn&#x27;t possible to read or write the time that a task is due via the API.
209 &quot;hidden&quot;: 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.
210 &quot;status&quot;: &quot;A String&quot;, # Status of the task. This is either &quot;needsAction&quot; or &quot;completed&quot;.
211 }
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]212
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]213 parent: string, Parent task identifier. If the task is created at the top level, this parameter is omitted. Optional.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]214 previous: string, Previous sibling task identifier. If the task is created at the first position among its siblings, this parameter is omitted. Optional.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]215 x__xgafv: string, V1 error format.
216 Allowed values
217 1 - v1 error format
218 2 - v2 error format
219
220Returns:
221 An object of the form:
222
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]223 { # LINT.IfChange
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]224 &quot;updated&quot;: &quot;A String&quot;, # Last modification time of the task (as a RFC 3339 timestamp).
225 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
226 &quot;links&quot;: [ # Collection of links. This collection is read-only.
227 {
228 &quot;description&quot;: &quot;A String&quot;, # The description. In HTML speak: Everything between &lt;a&gt; and &lt;/a&gt;.
229 &quot;link&quot;: &quot;A String&quot;, # The URL.
230 &quot;type&quot;: &quot;A String&quot;, # Type of the link, e.g. &quot;email&quot;.
231 },
232 ],
233 &quot;title&quot;: &quot;A String&quot;, # Title of the task.
234 &quot;deleted&quot;: True or False, # Flag indicating whether the task has been deleted. The default is False.
235 &quot;id&quot;: &quot;A String&quot;, # Task identifier.
236 &quot;completed&quot;: &quot;A String&quot;, # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
237 &quot;selfLink&quot;: &quot;A String&quot;, # URL pointing to this task. Used to retrieve, update, or delete this task.
238 &quot;position&quot;: &quot;A String&quot;, # 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&#x27;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 &quot;move&quot; method to move the task to another position.
239 &quot;notes&quot;: &quot;A String&quot;, # Notes describing the task. Optional.
240 &quot;kind&quot;: &quot;A String&quot;, # Type of the resource. This is always &quot;tasks#task&quot;.
241 &quot;parent&quot;: &quot;A String&quot;, # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the &quot;move&quot; method to move the task under a different parent or to the top level.
242 &quot;due&quot;: &quot;A String&quot;, # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only records date information; the time portion of the timestamp is discarded when setting the due date. It isn&#x27;t possible to read or write the time that a task is due via the API.
243 &quot;hidden&quot;: 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.
244 &quot;status&quot;: &quot;A String&quot;, # Status of the task. This is either &quot;needsAction&quot; or &quot;completed&quot;.
245 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]246</div>
247
248<div class="method">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]249 <code class="details" id="list">list(tasklist, showCompleted=None, showDeleted=None, updatedMin=None, maxResults=None, showHidden=None, pageToken=None, completedMax=None, dueMax=None, completedMin=None, dueMin=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]250 <pre>Returns all tasks in the specified task list.
251
252Args:
253 tasklist: string, Task list identifier. (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]254 showCompleted: boolean, Flag indicating whether completed tasks are returned in the result. Optional. The default is True. Note that showHidden must also be True to show tasks completed in first party clients, such as the web UI and Google&#x27;s mobile apps.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]255 showDeleted: boolean, Flag indicating whether deleted tasks are returned in the result. Optional. The default is False.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]256 updatedMin: string, Lower bound for a task&#x27;s last modification time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by last modification time.
257 maxResults: integer, Maximum number of task lists returned on one page. Optional. The default is 20 (max allowed: 100).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]258 showHidden: boolean, Flag indicating whether hidden tasks are returned in the result. Optional. The default is False.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]259 pageToken: string, Token specifying the result page to return. Optional.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]260 completedMax: string, Upper bound for a task&#x27;s completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]261 dueMax: string, Upper bound for a task&#x27;s due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date.
262 completedMin: string, Lower bound for a task&#x27;s completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date.
263 dueMin: string, Lower bound for a task&#x27;s due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]264 x__xgafv: string, V1 error format.
265 Allowed values
266 1 - v1 error format
267 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]268
269Returns:
270 An object of the form:
271
272 {
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]273 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]274 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token used to access the next page of this result.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]275 &quot;kind&quot;: &quot;A String&quot;, # Type of the resource. This is always &quot;tasks#tasks&quot;.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]276 &quot;items&quot;: [ # Collection of tasks.
277 { # LINT.IfChange
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]278 &quot;updated&quot;: &quot;A String&quot;, # Last modification time of the task (as a RFC 3339 timestamp).
279 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
280 &quot;links&quot;: [ # Collection of links. This collection is read-only.
281 {
282 &quot;description&quot;: &quot;A String&quot;, # The description. In HTML speak: Everything between &lt;a&gt; and &lt;/a&gt;.
283 &quot;link&quot;: &quot;A String&quot;, # The URL.
284 &quot;type&quot;: &quot;A String&quot;, # Type of the link, e.g. &quot;email&quot;.
285 },
286 ],
287 &quot;title&quot;: &quot;A String&quot;, # Title of the task.
288 &quot;deleted&quot;: True or False, # Flag indicating whether the task has been deleted. The default is False.
289 &quot;id&quot;: &quot;A String&quot;, # Task identifier.
290 &quot;completed&quot;: &quot;A String&quot;, # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
291 &quot;selfLink&quot;: &quot;A String&quot;, # URL pointing to this task. Used to retrieve, update, or delete this task.
292 &quot;position&quot;: &quot;A String&quot;, # 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&#x27;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 &quot;move&quot; method to move the task to another position.
293 &quot;notes&quot;: &quot;A String&quot;, # Notes describing the task. Optional.
294 &quot;kind&quot;: &quot;A String&quot;, # Type of the resource. This is always &quot;tasks#task&quot;.
295 &quot;parent&quot;: &quot;A String&quot;, # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the &quot;move&quot; method to move the task under a different parent or to the top level.
296 &quot;due&quot;: &quot;A String&quot;, # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only records date information; the time portion of the timestamp is discarded when setting the due date. It isn&#x27;t possible to read or write the time that a task is due via the API.
297 &quot;hidden&quot;: 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.
298 &quot;status&quot;: &quot;A String&quot;, # Status of the task. This is either &quot;needsAction&quot; or &quot;completed&quot;.
299 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]300 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]301 }</pre>
302</div>
303
304<div class="method">
305 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
306 <pre>Retrieves the next page of results.
307
308Args:
309 previous_request: The request for the previous page. (required)
310 previous_response: The response from the request for the previous page. (required)
311
312Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]313 A request object that you can call &#x27;execute()&#x27; on to request the next
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]314 page. Returns None if there are no more items in the collection.
315 </pre>
316</div>
317
318<div class="method">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]319 <code class="details" id="move">move(tasklist, task, parent=None, previous=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]320 <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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]321
322Args:
323 tasklist: string, Task list identifier. (required)
324 task: string, Task identifier. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]325 parent: string, New parent task identifier. If the task is moved to the top level, this parameter is omitted. Optional.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]326 previous: string, New previous sibling task identifier. If the task is moved to the first position among its siblings, this parameter is omitted. Optional.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]327 x__xgafv: string, V1 error format.
328 Allowed values
329 1 - v1 error format
330 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]331
332Returns:
333 An object of the form:
334
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]335 { # LINT.IfChange
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]336 &quot;updated&quot;: &quot;A String&quot;, # Last modification time of the task (as a RFC 3339 timestamp).
337 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
338 &quot;links&quot;: [ # Collection of links. This collection is read-only.
339 {
340 &quot;description&quot;: &quot;A String&quot;, # The description. In HTML speak: Everything between &lt;a&gt; and &lt;/a&gt;.
341 &quot;link&quot;: &quot;A String&quot;, # The URL.
342 &quot;type&quot;: &quot;A String&quot;, # Type of the link, e.g. &quot;email&quot;.
343 },
344 ],
345 &quot;title&quot;: &quot;A String&quot;, # Title of the task.
346 &quot;deleted&quot;: True or False, # Flag indicating whether the task has been deleted. The default is False.
347 &quot;id&quot;: &quot;A String&quot;, # Task identifier.
348 &quot;completed&quot;: &quot;A String&quot;, # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
349 &quot;selfLink&quot;: &quot;A String&quot;, # URL pointing to this task. Used to retrieve, update, or delete this task.
350 &quot;position&quot;: &quot;A String&quot;, # 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&#x27;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 &quot;move&quot; method to move the task to another position.
351 &quot;notes&quot;: &quot;A String&quot;, # Notes describing the task. Optional.
352 &quot;kind&quot;: &quot;A String&quot;, # Type of the resource. This is always &quot;tasks#task&quot;.
353 &quot;parent&quot;: &quot;A String&quot;, # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the &quot;move&quot; method to move the task under a different parent or to the top level.
354 &quot;due&quot;: &quot;A String&quot;, # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only records date information; the time portion of the timestamp is discarded when setting the due date. It isn&#x27;t possible to read or write the time that a task is due via the API.
355 &quot;hidden&quot;: 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.
356 &quot;status&quot;: &quot;A String&quot;, # Status of the task. This is either &quot;needsAction&quot; or &quot;completed&quot;.
357 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]358</div>
359
360<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]361 <code class="details" id="patch">patch(tasklist, task, body=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]362 <pre>Updates the specified task. This method supports patch semantics.
363
364Args:
365 tasklist: string, Task list identifier. (required)
366 task: string, Task identifier. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]367 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]368 The object takes the form of:
369
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]370{ # LINT.IfChange
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]371 &quot;updated&quot;: &quot;A String&quot;, # Last modification time of the task (as a RFC 3339 timestamp).
372 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
373 &quot;links&quot;: [ # Collection of links. This collection is read-only.
374 {
375 &quot;description&quot;: &quot;A String&quot;, # The description. In HTML speak: Everything between &lt;a&gt; and &lt;/a&gt;.
376 &quot;link&quot;: &quot;A String&quot;, # The URL.
377 &quot;type&quot;: &quot;A String&quot;, # Type of the link, e.g. &quot;email&quot;.
378 },
379 ],
380 &quot;title&quot;: &quot;A String&quot;, # Title of the task.
381 &quot;deleted&quot;: True or False, # Flag indicating whether the task has been deleted. The default is False.
382 &quot;id&quot;: &quot;A String&quot;, # Task identifier.
383 &quot;completed&quot;: &quot;A String&quot;, # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
384 &quot;selfLink&quot;: &quot;A String&quot;, # URL pointing to this task. Used to retrieve, update, or delete this task.
385 &quot;position&quot;: &quot;A String&quot;, # 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&#x27;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 &quot;move&quot; method to move the task to another position.
386 &quot;notes&quot;: &quot;A String&quot;, # Notes describing the task. Optional.
387 &quot;kind&quot;: &quot;A String&quot;, # Type of the resource. This is always &quot;tasks#task&quot;.
388 &quot;parent&quot;: &quot;A String&quot;, # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the &quot;move&quot; method to move the task under a different parent or to the top level.
389 &quot;due&quot;: &quot;A String&quot;, # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only records date information; the time portion of the timestamp is discarded when setting the due date. It isn&#x27;t possible to read or write the time that a task is due via the API.
390 &quot;hidden&quot;: 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.
391 &quot;status&quot;: &quot;A String&quot;, # Status of the task. This is either &quot;needsAction&quot; or &quot;completed&quot;.
392 }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]393
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]394 x__xgafv: string, V1 error format.
395 Allowed values
396 1 - v1 error format
397 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]398
399Returns:
400 An object of the form:
401
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]402 { # LINT.IfChange
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]403 &quot;updated&quot;: &quot;A String&quot;, # Last modification time of the task (as a RFC 3339 timestamp).
404 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
405 &quot;links&quot;: [ # Collection of links. This collection is read-only.
406 {
407 &quot;description&quot;: &quot;A String&quot;, # The description. In HTML speak: Everything between &lt;a&gt; and &lt;/a&gt;.
408 &quot;link&quot;: &quot;A String&quot;, # The URL.
409 &quot;type&quot;: &quot;A String&quot;, # Type of the link, e.g. &quot;email&quot;.
410 },
411 ],
412 &quot;title&quot;: &quot;A String&quot;, # Title of the task.
413 &quot;deleted&quot;: True or False, # Flag indicating whether the task has been deleted. The default is False.
414 &quot;id&quot;: &quot;A String&quot;, # Task identifier.
415 &quot;completed&quot;: &quot;A String&quot;, # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
416 &quot;selfLink&quot;: &quot;A String&quot;, # URL pointing to this task. Used to retrieve, update, or delete this task.
417 &quot;position&quot;: &quot;A String&quot;, # 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&#x27;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 &quot;move&quot; method to move the task to another position.
418 &quot;notes&quot;: &quot;A String&quot;, # Notes describing the task. Optional.
419 &quot;kind&quot;: &quot;A String&quot;, # Type of the resource. This is always &quot;tasks#task&quot;.
420 &quot;parent&quot;: &quot;A String&quot;, # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the &quot;move&quot; method to move the task under a different parent or to the top level.
421 &quot;due&quot;: &quot;A String&quot;, # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only records date information; the time portion of the timestamp is discarded when setting the due date. It isn&#x27;t possible to read or write the time that a task is due via the API.
422 &quot;hidden&quot;: 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.
423 &quot;status&quot;: &quot;A String&quot;, # Status of the task. This is either &quot;needsAction&quot; or &quot;completed&quot;.
424 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]425</div>
426
427<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]428 <code class="details" id="update">update(tasklist, task, body=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]429 <pre>Updates the specified task.
430
431Args:
432 tasklist: string, Task list identifier. (required)
433 task: string, Task identifier. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]434 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]435 The object takes the form of:
436
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]437{ # LINT.IfChange
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]438 &quot;updated&quot;: &quot;A String&quot;, # Last modification time of the task (as a RFC 3339 timestamp).
439 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
440 &quot;links&quot;: [ # Collection of links. This collection is read-only.
441 {
442 &quot;description&quot;: &quot;A String&quot;, # The description. In HTML speak: Everything between &lt;a&gt; and &lt;/a&gt;.
443 &quot;link&quot;: &quot;A String&quot;, # The URL.
444 &quot;type&quot;: &quot;A String&quot;, # Type of the link, e.g. &quot;email&quot;.
445 },
446 ],
447 &quot;title&quot;: &quot;A String&quot;, # Title of the task.
448 &quot;deleted&quot;: True or False, # Flag indicating whether the task has been deleted. The default is False.
449 &quot;id&quot;: &quot;A String&quot;, # Task identifier.
450 &quot;completed&quot;: &quot;A String&quot;, # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
451 &quot;selfLink&quot;: &quot;A String&quot;, # URL pointing to this task. Used to retrieve, update, or delete this task.
452 &quot;position&quot;: &quot;A String&quot;, # 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&#x27;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 &quot;move&quot; method to move the task to another position.
453 &quot;notes&quot;: &quot;A String&quot;, # Notes describing the task. Optional.
454 &quot;kind&quot;: &quot;A String&quot;, # Type of the resource. This is always &quot;tasks#task&quot;.
455 &quot;parent&quot;: &quot;A String&quot;, # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the &quot;move&quot; method to move the task under a different parent or to the top level.
456 &quot;due&quot;: &quot;A String&quot;, # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only records date information; the time portion of the timestamp is discarded when setting the due date. It isn&#x27;t possible to read or write the time that a task is due via the API.
457 &quot;hidden&quot;: 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.
458 &quot;status&quot;: &quot;A String&quot;, # Status of the task. This is either &quot;needsAction&quot; or &quot;completed&quot;.
459 }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]460
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]461 x__xgafv: string, V1 error format.
462 Allowed values
463 1 - v1 error format
464 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]465
466Returns:
467 An object of the form:
468
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]469 { # LINT.IfChange
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]470 &quot;updated&quot;: &quot;A String&quot;, # Last modification time of the task (as a RFC 3339 timestamp).
471 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
472 &quot;links&quot;: [ # Collection of links. This collection is read-only.
473 {
474 &quot;description&quot;: &quot;A String&quot;, # The description. In HTML speak: Everything between &lt;a&gt; and &lt;/a&gt;.
475 &quot;link&quot;: &quot;A String&quot;, # The URL.
476 &quot;type&quot;: &quot;A String&quot;, # Type of the link, e.g. &quot;email&quot;.
477 },
478 ],
479 &quot;title&quot;: &quot;A String&quot;, # Title of the task.
480 &quot;deleted&quot;: True or False, # Flag indicating whether the task has been deleted. The default is False.
481 &quot;id&quot;: &quot;A String&quot;, # Task identifier.
482 &quot;completed&quot;: &quot;A String&quot;, # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
483 &quot;selfLink&quot;: &quot;A String&quot;, # URL pointing to this task. Used to retrieve, update, or delete this task.
484 &quot;position&quot;: &quot;A String&quot;, # 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&#x27;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 &quot;move&quot; method to move the task to another position.
485 &quot;notes&quot;: &quot;A String&quot;, # Notes describing the task. Optional.
486 &quot;kind&quot;: &quot;A String&quot;, # Type of the resource. This is always &quot;tasks#task&quot;.
487 &quot;parent&quot;: &quot;A String&quot;, # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the &quot;move&quot; method to move the task under a different parent or to the top level.
488 &quot;due&quot;: &quot;A String&quot;, # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only records date information; the time portion of the timestamp is discarded when setting the due date. It isn&#x27;t possible to read or write the time that a task is due via the API.
489 &quot;hidden&quot;: 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.
490 &quot;status&quot;: &quot;A String&quot;, # Status of the task. This is either &quot;needsAction&quot; or &quot;completed&quot;.
491 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]492</div>
493
494</body></html>