blob: 407529a670b98f9140eae88889bdb5caea698282 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<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 -070078 <code><a href="#clear">clear(tasklist, x__xgafv=None)</a></code></p>
79<p class="firstline">Clears all completed tasks from the specified task list. The affected tasks</p>
John Asmuth614db982014-04-24 15:46:26 -040080<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070081 <code><a href="#delete">delete(tasklist, task, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040082<p class="firstline">Deletes the specified task from the task list.</p>
83<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070084 <code><a href="#get">get(tasklist, task, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040085<p class="firstline">Returns the specified task.</p>
86<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070087 <code><a href="#insert">insert(tasklist, body=None, parent=None, previous=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Creates a new task on the specified task list.</p>
John Asmuth614db982014-04-24 15:46:26 -040089<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070090 <code><a href="#list">list(tasklist, completedMin=None, updatedMin=None, dueMin=None, showHidden=None, showCompleted=None, maxResults=None, pageToken=None, dueMax=None, completedMax=None, showDeleted=None, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040091<p class="firstline">Returns all tasks in the specified task list.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070096 <code><a href="#move">move(tasklist, task, parent=None, previous=None, x__xgafv=None)</a></code></p>
97<p class="firstline">Moves the specified task to another position in the task list. This can</p>
John Asmuth614db982014-04-24 15:46:26 -040098<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070099 <code><a href="#patch">patch(tasklist, task, body=None, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400100<p class="firstline">Updates the specified task. This method supports patch semantics.</p>
101<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700102 <code><a href="#update">update(tasklist, task, body=None, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400103<p class="firstline">Updates the specified task.</p>
104<h3>Method Details</h3>
105<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700106 <code class="details" id="clear">clear(tasklist, x__xgafv=None)</code>
107 <pre>Clears all completed tasks from the specified task list. The affected tasks
108will be marked as &#x27;hidden&#x27; and no longer be returned by default when
109retrieving all tasks for a task list.
John Asmuth614db982014-04-24 15:46:26 -0400110
111Args:
112 tasklist: string, Task list identifier. (required)
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700113 x__xgafv: string, V1 error format.
114 Allowed values
115 1 - v1 error format
116 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400117</pre>
118</div>
119
120<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700121 <code class="details" id="delete">delete(tasklist, task, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400122 <pre>Deletes the specified task from the task list.
123
124Args:
125 tasklist: string, Task list identifier. (required)
126 task: string, Task identifier. (required)
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700127 x__xgafv: string, V1 error format.
128 Allowed values
129 1 - v1 error format
130 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400131</pre>
132</div>
133
134<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700135 <code class="details" id="get">get(tasklist, task, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400136 <pre>Returns the specified task.
137
138Args:
139 tasklist: string, Task list identifier. (required)
140 task: string, Task identifier. (required)
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700141 x__xgafv: string, V1 error format.
142 Allowed values
143 1 - v1 error format
144 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400145
146Returns:
147 An object of the form:
148
149 {
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700150 &quot;updated&quot;: &quot;A String&quot;, # Last modification time of the task (as a RFC 3339 timestamp).
151 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
152 &quot;title&quot;: &quot;A String&quot;, # Title of the task.
153 &quot;kind&quot;: &quot;A String&quot;, # Type of the resource. This is always &quot;tasks#task&quot;.
154 &quot;id&quot;: &quot;A String&quot;, # Task identifier.
155 &quot;parent&quot;: &quot;A String&quot;, # Parent task identifier. This field is omitted if it is a top-level task.
156 # This field is read-only. Use the &quot;move&quot; method to move the task under a
157 # different parent or to the top level.
158 &quot;selfLink&quot;: &quot;A String&quot;, # URL pointing to this task. Used to retrieve, update, or delete this task.
159 &quot;notes&quot;: &quot;A String&quot;, # Notes describing the task. Optional.
160 &quot;status&quot;: &quot;A String&quot;, # Status of the task. This is either &quot;needsAction&quot; or &quot;completed&quot;.
161 &quot;deleted&quot;: True or False, # Flag indicating whether the task has been deleted. The default is False.
162 &quot;position&quot;: &quot;A String&quot;, # String indicating the position of the task among its sibling tasks under
163 # the same parent task or at the top level. If this string is greater than
164 # another task&#x27;s corresponding position string according to lexicographical
165 # ordering, the task is positioned after the other task under the same parent
166 # task (or at the top level). This field is read-only. Use the &quot;move&quot; method
167 # to move the task to another position.
168 &quot;due&quot;: &quot;A String&quot;, # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only
169 # records date information; the time portion of the timestamp is discarded
170 # when setting the due date. It isn&#x27;t possible to read or write the time that
171 # a task is due via the API.
172 &quot;links&quot;: [ # Collection of links. This collection is read-only.
173 {
174 &quot;type&quot;: &quot;A String&quot;, # Type of the link, e.g. &quot;email&quot;.
175 &quot;link&quot;: &quot;A String&quot;, # The URL.
176 &quot;description&quot;: &quot;A String&quot;, # The description. In HTML speak: Everything between &amp;lt;a&amp;gt; and
177 # &amp;lt;/a&amp;gt;.
178 },
179 ],
180 &quot;completed&quot;: &quot;A String&quot;, # Completion date of the task (as a RFC 3339 timestamp). This field is
181 # omitted if the task has not been completed.
182 &quot;hidden&quot;: True or False, # Flag indicating whether the task is hidden. This is the case if the task
183 # had been marked completed when the task list was last cleared. The default
184 # is False. This field is read-only.
185 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400186</div>
187
188<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700189 <code class="details" id="insert">insert(tasklist, body=None, parent=None, previous=None, x__xgafv=None)</code>
190 <pre>Creates a new task on the specified task list.
John Asmuth614db982014-04-24 15:46:26 -0400191
192Args:
193 tasklist: string, Task list identifier. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700194 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400195 The object takes the form of:
196
197{
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700198 &quot;updated&quot;: &quot;A String&quot;, # Last modification time of the task (as a RFC 3339 timestamp).
199 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
200 &quot;title&quot;: &quot;A String&quot;, # Title of the task.
201 &quot;kind&quot;: &quot;A String&quot;, # Type of the resource. This is always &quot;tasks#task&quot;.
202 &quot;id&quot;: &quot;A String&quot;, # Task identifier.
203 &quot;parent&quot;: &quot;A String&quot;, # Parent task identifier. This field is omitted if it is a top-level task.
204 # This field is read-only. Use the &quot;move&quot; method to move the task under a
205 # different parent or to the top level.
206 &quot;selfLink&quot;: &quot;A String&quot;, # URL pointing to this task. Used to retrieve, update, or delete this task.
207 &quot;notes&quot;: &quot;A String&quot;, # Notes describing the task. Optional.
208 &quot;status&quot;: &quot;A String&quot;, # Status of the task. This is either &quot;needsAction&quot; or &quot;completed&quot;.
209 &quot;deleted&quot;: True or False, # Flag indicating whether the task has been deleted. The default is False.
210 &quot;position&quot;: &quot;A String&quot;, # String indicating the position of the task among its sibling tasks under
211 # the same parent task or at the top level. If this string is greater than
212 # another task&#x27;s corresponding position string according to lexicographical
213 # ordering, the task is positioned after the other task under the same parent
214 # task (or at the top level). This field is read-only. Use the &quot;move&quot; method
215 # to move the task to another position.
216 &quot;due&quot;: &quot;A String&quot;, # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only
217 # records date information; the time portion of the timestamp is discarded
218 # when setting the due date. It isn&#x27;t possible to read or write the time that
219 # a task is due via the API.
220 &quot;links&quot;: [ # Collection of links. This collection is read-only.
221 {
222 &quot;type&quot;: &quot;A String&quot;, # Type of the link, e.g. &quot;email&quot;.
223 &quot;link&quot;: &quot;A String&quot;, # The URL.
224 &quot;description&quot;: &quot;A String&quot;, # The description. In HTML speak: Everything between &amp;lt;a&amp;gt; and
225 # &amp;lt;/a&amp;gt;.
226 },
227 ],
228 &quot;completed&quot;: &quot;A String&quot;, # Completion date of the task (as a RFC 3339 timestamp). This field is
229 # omitted if the task has not been completed.
230 &quot;hidden&quot;: True or False, # Flag indicating whether the task is hidden. This is the case if the task
231 # had been marked completed when the task list was last cleared. The default
232 # is False. This field is read-only.
233 }
John Asmuth614db982014-04-24 15:46:26 -0400234
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700235 parent: string, Parent task identifier. If the task is created at the top level, this
236parameter is omitted. Optional.
237 previous: string, Previous sibling task identifier. If the task is created at the first
238position among its siblings, this parameter is omitted. Optional.
239 x__xgafv: string, V1 error format.
240 Allowed values
241 1 - v1 error format
242 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400243
244Returns:
245 An object of the form:
246
247 {
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700248 &quot;updated&quot;: &quot;A String&quot;, # Last modification time of the task (as a RFC 3339 timestamp).
249 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
250 &quot;title&quot;: &quot;A String&quot;, # Title of the task.
251 &quot;kind&quot;: &quot;A String&quot;, # Type of the resource. This is always &quot;tasks#task&quot;.
252 &quot;id&quot;: &quot;A String&quot;, # Task identifier.
253 &quot;parent&quot;: &quot;A String&quot;, # Parent task identifier. This field is omitted if it is a top-level task.
254 # This field is read-only. Use the &quot;move&quot; method to move the task under a
255 # different parent or to the top level.
256 &quot;selfLink&quot;: &quot;A String&quot;, # URL pointing to this task. Used to retrieve, update, or delete this task.
257 &quot;notes&quot;: &quot;A String&quot;, # Notes describing the task. Optional.
258 &quot;status&quot;: &quot;A String&quot;, # Status of the task. This is either &quot;needsAction&quot; or &quot;completed&quot;.
259 &quot;deleted&quot;: True or False, # Flag indicating whether the task has been deleted. The default is False.
260 &quot;position&quot;: &quot;A String&quot;, # String indicating the position of the task among its sibling tasks under
261 # the same parent task or at the top level. If this string is greater than
262 # another task&#x27;s corresponding position string according to lexicographical
263 # ordering, the task is positioned after the other task under the same parent
264 # task (or at the top level). This field is read-only. Use the &quot;move&quot; method
265 # to move the task to another position.
266 &quot;due&quot;: &quot;A String&quot;, # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only
267 # records date information; the time portion of the timestamp is discarded
268 # when setting the due date. It isn&#x27;t possible to read or write the time that
269 # a task is due via the API.
270 &quot;links&quot;: [ # Collection of links. This collection is read-only.
271 {
272 &quot;type&quot;: &quot;A String&quot;, # Type of the link, e.g. &quot;email&quot;.
273 &quot;link&quot;: &quot;A String&quot;, # The URL.
274 &quot;description&quot;: &quot;A String&quot;, # The description. In HTML speak: Everything between &amp;lt;a&amp;gt; and
275 # &amp;lt;/a&amp;gt;.
276 },
277 ],
278 &quot;completed&quot;: &quot;A String&quot;, # Completion date of the task (as a RFC 3339 timestamp). This field is
279 # omitted if the task has not been completed.
280 &quot;hidden&quot;: True or False, # Flag indicating whether the task is hidden. This is the case if the task
281 # had been marked completed when the task list was last cleared. The default
282 # is False. This field is read-only.
283 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400284</div>
285
286<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700287 <code class="details" id="list">list(tasklist, completedMin=None, updatedMin=None, dueMin=None, showHidden=None, showCompleted=None, maxResults=None, pageToken=None, dueMax=None, completedMax=None, showDeleted=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400288 <pre>Returns all tasks in the specified task list.
289
290Args:
291 tasklist: string, Task list identifier. (required)
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700292 completedMin: string, Lower bound for a task&#x27;s completion date (as a RFC 3339 timestamp) to
293filter by. Optional. The default is not to filter by completion date.
294 updatedMin: string, Lower bound for a task&#x27;s last modification time (as a RFC 3339 timestamp)
295to filter by. Optional. The default is not to filter by last modification
296time.
297 dueMin: string, Lower bound for a task&#x27;s due date (as a RFC 3339 timestamp) to filter by.
298Optional. The default is not to filter by due date.
299 showHidden: boolean, Flag indicating whether hidden tasks are returned in the result. Optional.
300The default is False.
301 showCompleted: boolean, Flag indicating whether completed tasks are returned in the result.
302Optional. The default is True.
303 maxResults: integer, Maximum number of task lists returned on one page. Optional. The default is
30420 (max allowed: 100).
Bu Sun Kim65020912020-05-20 12:08:20 -0700305 pageToken: string, Token specifying the result page to return. Optional.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700306 dueMax: string, Upper bound for a task&#x27;s due date (as a RFC 3339 timestamp) to filter by.
307Optional. The default is not to filter by due date.
308 completedMax: string, Upper bound for a task&#x27;s completion date (as a RFC 3339 timestamp) to
309filter by. Optional. The default is not to filter by completion date.
310 showDeleted: boolean, Flag indicating whether deleted tasks are returned in the result. Optional.
311The default is False.
312 x__xgafv: string, V1 error format.
313 Allowed values
314 1 - v1 error format
315 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400316
317Returns:
318 An object of the form:
319
320 {
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700321 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token used to access the next page of this result.
Bu Sun Kim65020912020-05-20 12:08:20 -0700322 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
323 &quot;items&quot;: [ # Collection of tasks.
John Asmuth614db982014-04-24 15:46:26 -0400324 {
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700325 &quot;updated&quot;: &quot;A String&quot;, # Last modification time of the task (as a RFC 3339 timestamp).
326 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
327 &quot;title&quot;: &quot;A String&quot;, # Title of the task.
328 &quot;kind&quot;: &quot;A String&quot;, # Type of the resource. This is always &quot;tasks#task&quot;.
329 &quot;id&quot;: &quot;A String&quot;, # Task identifier.
330 &quot;parent&quot;: &quot;A String&quot;, # Parent task identifier. This field is omitted if it is a top-level task.
331 # This field is read-only. Use the &quot;move&quot; method to move the task under a
332 # different parent or to the top level.
333 &quot;selfLink&quot;: &quot;A String&quot;, # URL pointing to this task. Used to retrieve, update, or delete this task.
334 &quot;notes&quot;: &quot;A String&quot;, # Notes describing the task. Optional.
335 &quot;status&quot;: &quot;A String&quot;, # Status of the task. This is either &quot;needsAction&quot; or &quot;completed&quot;.
336 &quot;deleted&quot;: True or False, # Flag indicating whether the task has been deleted. The default is False.
337 &quot;position&quot;: &quot;A String&quot;, # String indicating the position of the task among its sibling tasks under
338 # the same parent task or at the top level. If this string is greater than
339 # another task&#x27;s corresponding position string according to lexicographical
340 # ordering, the task is positioned after the other task under the same parent
341 # task (or at the top level). This field is read-only. Use the &quot;move&quot; method
342 # to move the task to another position.
343 &quot;due&quot;: &quot;A String&quot;, # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only
344 # records date information; the time portion of the timestamp is discarded
345 # when setting the due date. It isn&#x27;t possible to read or write the time that
346 # a task is due via the API.
347 &quot;links&quot;: [ # Collection of links. This collection is read-only.
348 {
349 &quot;type&quot;: &quot;A String&quot;, # Type of the link, e.g. &quot;email&quot;.
350 &quot;link&quot;: &quot;A String&quot;, # The URL.
351 &quot;description&quot;: &quot;A String&quot;, # The description. In HTML speak: Everything between &amp;lt;a&amp;gt; and
352 # &amp;lt;/a&amp;gt;.
353 },
354 ],
355 &quot;completed&quot;: &quot;A String&quot;, # Completion date of the task (as a RFC 3339 timestamp). This field is
356 # omitted if the task has not been completed.
357 &quot;hidden&quot;: True or False, # Flag indicating whether the task is hidden. This is the case if the task
358 # had been marked completed when the task list was last cleared. The default
359 # is False. This field is read-only.
360 },
John Asmuth614db982014-04-24 15:46:26 -0400361 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700362 &quot;kind&quot;: &quot;A String&quot;, # Type of the resource. This is always &quot;tasks#tasks&quot;.
John Asmuth614db982014-04-24 15:46:26 -0400363 }</pre>
364</div>
365
366<div class="method">
367 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
368 <pre>Retrieves the next page of results.
369
370Args:
371 previous_request: The request for the previous page. (required)
372 previous_response: The response from the request for the previous page. (required)
373
374Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700375 A request object that you can call &#x27;execute()&#x27; on to request the next
John Asmuth614db982014-04-24 15:46:26 -0400376 page. Returns None if there are no more items in the collection.
377 </pre>
378</div>
379
380<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700381 <code class="details" id="move">move(tasklist, task, parent=None, previous=None, x__xgafv=None)</code>
382 <pre>Moves the specified task to another position in the task list. This can
383include putting it as a child task under a new parent and/or move it to a
384different position among its sibling tasks.
John Asmuth614db982014-04-24 15:46:26 -0400385
386Args:
387 tasklist: string, Task list identifier. (required)
388 task: string, Task identifier. (required)
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700389 parent: string, New parent task identifier. If the task is moved to the top level, this
390parameter is omitted. Optional.
391 previous: string, New previous sibling task identifier. If the task is moved to the first
392position among its siblings, this parameter is omitted. Optional.
393 x__xgafv: string, V1 error format.
394 Allowed values
395 1 - v1 error format
396 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400397
398Returns:
399 An object of the form:
400
401 {
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700402 &quot;updated&quot;: &quot;A String&quot;, # Last modification time of the task (as a RFC 3339 timestamp).
403 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
404 &quot;title&quot;: &quot;A String&quot;, # Title of the task.
405 &quot;kind&quot;: &quot;A String&quot;, # Type of the resource. This is always &quot;tasks#task&quot;.
406 &quot;id&quot;: &quot;A String&quot;, # Task identifier.
407 &quot;parent&quot;: &quot;A String&quot;, # Parent task identifier. This field is omitted if it is a top-level task.
408 # This field is read-only. Use the &quot;move&quot; method to move the task under a
409 # different parent or to the top level.
410 &quot;selfLink&quot;: &quot;A String&quot;, # URL pointing to this task. Used to retrieve, update, or delete this task.
411 &quot;notes&quot;: &quot;A String&quot;, # Notes describing the task. Optional.
412 &quot;status&quot;: &quot;A String&quot;, # Status of the task. This is either &quot;needsAction&quot; or &quot;completed&quot;.
413 &quot;deleted&quot;: True or False, # Flag indicating whether the task has been deleted. The default is False.
414 &quot;position&quot;: &quot;A String&quot;, # String indicating the position of the task among its sibling tasks under
415 # the same parent task or at the top level. If this string is greater than
416 # another task&#x27;s corresponding position string according to lexicographical
417 # ordering, the task is positioned after the other task under the same parent
418 # task (or at the top level). This field is read-only. Use the &quot;move&quot; method
419 # to move the task to another position.
420 &quot;due&quot;: &quot;A String&quot;, # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only
421 # records date information; the time portion of the timestamp is discarded
422 # when setting the due date. It isn&#x27;t possible to read or write the time that
423 # a task is due via the API.
424 &quot;links&quot;: [ # Collection of links. This collection is read-only.
425 {
426 &quot;type&quot;: &quot;A String&quot;, # Type of the link, e.g. &quot;email&quot;.
427 &quot;link&quot;: &quot;A String&quot;, # The URL.
428 &quot;description&quot;: &quot;A String&quot;, # The description. In HTML speak: Everything between &amp;lt;a&amp;gt; and
429 # &amp;lt;/a&amp;gt;.
430 },
431 ],
432 &quot;completed&quot;: &quot;A String&quot;, # Completion date of the task (as a RFC 3339 timestamp). This field is
433 # omitted if the task has not been completed.
434 &quot;hidden&quot;: True or False, # Flag indicating whether the task is hidden. This is the case if the task
435 # had been marked completed when the task list was last cleared. The default
436 # is False. This field is read-only.
437 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400438</div>
439
440<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700441 <code class="details" id="patch">patch(tasklist, task, body=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400442 <pre>Updates the specified task. This method supports patch semantics.
443
444Args:
445 tasklist: string, Task list identifier. (required)
446 task: string, Task identifier. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700447 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400448 The object takes the form of:
449
450{
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700451 &quot;updated&quot;: &quot;A String&quot;, # Last modification time of the task (as a RFC 3339 timestamp).
452 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
453 &quot;title&quot;: &quot;A String&quot;, # Title of the task.
454 &quot;kind&quot;: &quot;A String&quot;, # Type of the resource. This is always &quot;tasks#task&quot;.
455 &quot;id&quot;: &quot;A String&quot;, # Task identifier.
456 &quot;parent&quot;: &quot;A String&quot;, # Parent task identifier. This field is omitted if it is a top-level task.
457 # This field is read-only. Use the &quot;move&quot; method to move the task under a
458 # different parent or to the top level.
459 &quot;selfLink&quot;: &quot;A String&quot;, # URL pointing to this task. Used to retrieve, update, or delete this task.
460 &quot;notes&quot;: &quot;A String&quot;, # Notes describing the task. Optional.
461 &quot;status&quot;: &quot;A String&quot;, # Status of the task. This is either &quot;needsAction&quot; or &quot;completed&quot;.
462 &quot;deleted&quot;: True or False, # Flag indicating whether the task has been deleted. The default is False.
463 &quot;position&quot;: &quot;A String&quot;, # String indicating the position of the task among its sibling tasks under
464 # the same parent task or at the top level. If this string is greater than
465 # another task&#x27;s corresponding position string according to lexicographical
466 # ordering, the task is positioned after the other task under the same parent
467 # task (or at the top level). This field is read-only. Use the &quot;move&quot; method
468 # to move the task to another position.
469 &quot;due&quot;: &quot;A String&quot;, # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only
470 # records date information; the time portion of the timestamp is discarded
471 # when setting the due date. It isn&#x27;t possible to read or write the time that
472 # a task is due via the API.
473 &quot;links&quot;: [ # Collection of links. This collection is read-only.
474 {
475 &quot;type&quot;: &quot;A String&quot;, # Type of the link, e.g. &quot;email&quot;.
476 &quot;link&quot;: &quot;A String&quot;, # The URL.
477 &quot;description&quot;: &quot;A String&quot;, # The description. In HTML speak: Everything between &amp;lt;a&amp;gt; and
478 # &amp;lt;/a&amp;gt;.
479 },
480 ],
481 &quot;completed&quot;: &quot;A String&quot;, # Completion date of the task (as a RFC 3339 timestamp). This field is
482 # omitted if the task has not been completed.
483 &quot;hidden&quot;: True or False, # Flag indicating whether the task is hidden. This is the case if the task
484 # had been marked completed when the task list was last cleared. The default
485 # is False. This field is read-only.
486 }
John Asmuth614db982014-04-24 15:46:26 -0400487
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700488 x__xgafv: string, V1 error format.
489 Allowed values
490 1 - v1 error format
491 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400492
493Returns:
494 An object of the form:
495
496 {
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700497 &quot;updated&quot;: &quot;A String&quot;, # Last modification time of the task (as a RFC 3339 timestamp).
498 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
499 &quot;title&quot;: &quot;A String&quot;, # Title of the task.
500 &quot;kind&quot;: &quot;A String&quot;, # Type of the resource. This is always &quot;tasks#task&quot;.
501 &quot;id&quot;: &quot;A String&quot;, # Task identifier.
502 &quot;parent&quot;: &quot;A String&quot;, # Parent task identifier. This field is omitted if it is a top-level task.
503 # This field is read-only. Use the &quot;move&quot; method to move the task under a
504 # different parent or to the top level.
505 &quot;selfLink&quot;: &quot;A String&quot;, # URL pointing to this task. Used to retrieve, update, or delete this task.
506 &quot;notes&quot;: &quot;A String&quot;, # Notes describing the task. Optional.
507 &quot;status&quot;: &quot;A String&quot;, # Status of the task. This is either &quot;needsAction&quot; or &quot;completed&quot;.
508 &quot;deleted&quot;: True or False, # Flag indicating whether the task has been deleted. The default is False.
509 &quot;position&quot;: &quot;A String&quot;, # String indicating the position of the task among its sibling tasks under
510 # the same parent task or at the top level. If this string is greater than
511 # another task&#x27;s corresponding position string according to lexicographical
512 # ordering, the task is positioned after the other task under the same parent
513 # task (or at the top level). This field is read-only. Use the &quot;move&quot; method
514 # to move the task to another position.
515 &quot;due&quot;: &quot;A String&quot;, # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only
516 # records date information; the time portion of the timestamp is discarded
517 # when setting the due date. It isn&#x27;t possible to read or write the time that
518 # a task is due via the API.
519 &quot;links&quot;: [ # Collection of links. This collection is read-only.
520 {
521 &quot;type&quot;: &quot;A String&quot;, # Type of the link, e.g. &quot;email&quot;.
522 &quot;link&quot;: &quot;A String&quot;, # The URL.
523 &quot;description&quot;: &quot;A String&quot;, # The description. In HTML speak: Everything between &amp;lt;a&amp;gt; and
524 # &amp;lt;/a&amp;gt;.
525 },
526 ],
527 &quot;completed&quot;: &quot;A String&quot;, # Completion date of the task (as a RFC 3339 timestamp). This field is
528 # omitted if the task has not been completed.
529 &quot;hidden&quot;: True or False, # Flag indicating whether the task is hidden. This is the case if the task
530 # had been marked completed when the task list was last cleared. The default
531 # is False. This field is read-only.
532 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400533</div>
534
535<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700536 <code class="details" id="update">update(tasklist, task, body=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400537 <pre>Updates the specified task.
538
539Args:
540 tasklist: string, Task list identifier. (required)
541 task: string, Task identifier. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700542 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400543 The object takes the form of:
544
545{
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700546 &quot;updated&quot;: &quot;A String&quot;, # Last modification time of the task (as a RFC 3339 timestamp).
547 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
548 &quot;title&quot;: &quot;A String&quot;, # Title of the task.
549 &quot;kind&quot;: &quot;A String&quot;, # Type of the resource. This is always &quot;tasks#task&quot;.
550 &quot;id&quot;: &quot;A String&quot;, # Task identifier.
551 &quot;parent&quot;: &quot;A String&quot;, # Parent task identifier. This field is omitted if it is a top-level task.
552 # This field is read-only. Use the &quot;move&quot; method to move the task under a
553 # different parent or to the top level.
554 &quot;selfLink&quot;: &quot;A String&quot;, # URL pointing to this task. Used to retrieve, update, or delete this task.
555 &quot;notes&quot;: &quot;A String&quot;, # Notes describing the task. Optional.
556 &quot;status&quot;: &quot;A String&quot;, # Status of the task. This is either &quot;needsAction&quot; or &quot;completed&quot;.
557 &quot;deleted&quot;: True or False, # Flag indicating whether the task has been deleted. The default is False.
558 &quot;position&quot;: &quot;A String&quot;, # String indicating the position of the task among its sibling tasks under
559 # the same parent task or at the top level. If this string is greater than
560 # another task&#x27;s corresponding position string according to lexicographical
561 # ordering, the task is positioned after the other task under the same parent
562 # task (or at the top level). This field is read-only. Use the &quot;move&quot; method
563 # to move the task to another position.
564 &quot;due&quot;: &quot;A String&quot;, # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only
565 # records date information; the time portion of the timestamp is discarded
566 # when setting the due date. It isn&#x27;t possible to read or write the time that
567 # a task is due via the API.
568 &quot;links&quot;: [ # Collection of links. This collection is read-only.
569 {
570 &quot;type&quot;: &quot;A String&quot;, # Type of the link, e.g. &quot;email&quot;.
571 &quot;link&quot;: &quot;A String&quot;, # The URL.
572 &quot;description&quot;: &quot;A String&quot;, # The description. In HTML speak: Everything between &amp;lt;a&amp;gt; and
573 # &amp;lt;/a&amp;gt;.
574 },
575 ],
576 &quot;completed&quot;: &quot;A String&quot;, # Completion date of the task (as a RFC 3339 timestamp). This field is
577 # omitted if the task has not been completed.
578 &quot;hidden&quot;: True or False, # Flag indicating whether the task is hidden. This is the case if the task
579 # had been marked completed when the task list was last cleared. The default
580 # is False. This field is read-only.
581 }
John Asmuth614db982014-04-24 15:46:26 -0400582
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700583 x__xgafv: string, V1 error format.
584 Allowed values
585 1 - v1 error format
586 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400587
588Returns:
589 An object of the form:
590
591 {
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700592 &quot;updated&quot;: &quot;A String&quot;, # Last modification time of the task (as a RFC 3339 timestamp).
593 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
594 &quot;title&quot;: &quot;A String&quot;, # Title of the task.
595 &quot;kind&quot;: &quot;A String&quot;, # Type of the resource. This is always &quot;tasks#task&quot;.
596 &quot;id&quot;: &quot;A String&quot;, # Task identifier.
597 &quot;parent&quot;: &quot;A String&quot;, # Parent task identifier. This field is omitted if it is a top-level task.
598 # This field is read-only. Use the &quot;move&quot; method to move the task under a
599 # different parent or to the top level.
600 &quot;selfLink&quot;: &quot;A String&quot;, # URL pointing to this task. Used to retrieve, update, or delete this task.
601 &quot;notes&quot;: &quot;A String&quot;, # Notes describing the task. Optional.
602 &quot;status&quot;: &quot;A String&quot;, # Status of the task. This is either &quot;needsAction&quot; or &quot;completed&quot;.
603 &quot;deleted&quot;: True or False, # Flag indicating whether the task has been deleted. The default is False.
604 &quot;position&quot;: &quot;A String&quot;, # String indicating the position of the task among its sibling tasks under
605 # the same parent task or at the top level. If this string is greater than
606 # another task&#x27;s corresponding position string according to lexicographical
607 # ordering, the task is positioned after the other task under the same parent
608 # task (or at the top level). This field is read-only. Use the &quot;move&quot; method
609 # to move the task to another position.
610 &quot;due&quot;: &quot;A String&quot;, # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only
611 # records date information; the time portion of the timestamp is discarded
612 # when setting the due date. It isn&#x27;t possible to read or write the time that
613 # a task is due via the API.
614 &quot;links&quot;: [ # Collection of links. This collection is read-only.
615 {
616 &quot;type&quot;: &quot;A String&quot;, # Type of the link, e.g. &quot;email&quot;.
617 &quot;link&quot;: &quot;A String&quot;, # The URL.
618 &quot;description&quot;: &quot;A String&quot;, # The description. In HTML speak: Everything between &amp;lt;a&amp;gt; and
619 # &amp;lt;/a&amp;gt;.
620 },
621 ],
622 &quot;completed&quot;: &quot;A String&quot;, # Completion date of the task (as a RFC 3339 timestamp). This field is
623 # omitted if the task has not been completed.
624 &quot;hidden&quot;: True or False, # Flag indicating whether the task is hidden. This is the case if the task
625 # had been marked completed when the task list was last cleared. The default
626 # is False. This field is read-only.
627 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400628</div>
629
630</body></html>