File: tasks_v1.tasklists.html

package info (click to toggle)
python-googleapi 2.182.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 533,852 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (297 lines) | stat: -rw-r--r-- 11,772 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="tasks_v1.html">Google Tasks API</a> . <a href="tasks_v1.tasklists.html">tasklists</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#delete">delete(tasklist, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes the authenticated user's specified task list. If the list contains assigned tasks, both the assigned tasks and the original tasks in the assignment surface (Docs, Chat Spaces) are deleted.</p>
<p class="toc_element">
  <code><a href="#get">get(tasklist, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the authenticated user's specified task list.</p>
<p class="toc_element">
  <code><a href="#insert">insert(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new task list and adds it to the authenticated user's task lists. A user can have up to 2000 lists at a time.</p>
<p class="toc_element">
  <code><a href="#list">list(maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns all the authenticated user's task lists. A user can have up to 2000 lists at a time.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(tasklist, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the authenticated user's specified task list. This method supports patch semantics.</p>
<p class="toc_element">
  <code><a href="#update">update(tasklist, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the authenticated user's specified task list.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(tasklist, x__xgafv=None)</code>
  <pre>Deletes the authenticated user&#x27;s specified task list. If the list contains assigned tasks, both the assigned tasks and the original tasks in the assignment surface (Docs, Chat Spaces) are deleted.

Args:
  tasklist: string, Task list identifier. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
</pre>
</div>

<div class="method">
    <code class="details" id="get">get(tasklist, x__xgafv=None)</code>
  <pre>Returns the authenticated user&#x27;s specified task list.

Args:
  tasklist: string, Task list identifier. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
  &quot;id&quot;: &quot;A String&quot;, # Task list identifier.
  &quot;kind&quot;: &quot;A String&quot;, # Output only. Type of the resource. This is always &quot;tasks#taskList&quot;.
  &quot;selfLink&quot;: &quot;A String&quot;, # Output only. URL pointing to this task list. Used to retrieve, update, or delete this task list.
  &quot;title&quot;: &quot;A String&quot;, # Title of the task list. Maximum length allowed: 1024 characters.
  &quot;updated&quot;: &quot;A String&quot;, # Output only. Last modification time of the task list (as a RFC 3339 timestamp).
}</pre>
</div>

<div class="method">
    <code class="details" id="insert">insert(body=None, x__xgafv=None)</code>
  <pre>Creates a new task list and adds it to the authenticated user&#x27;s task lists. A user can have up to 2000 lists at a time.

Args:
  body: object, The request body.
    The object takes the form of:

{
  &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
  &quot;id&quot;: &quot;A String&quot;, # Task list identifier.
  &quot;kind&quot;: &quot;A String&quot;, # Output only. Type of the resource. This is always &quot;tasks#taskList&quot;.
  &quot;selfLink&quot;: &quot;A String&quot;, # Output only. URL pointing to this task list. Used to retrieve, update, or delete this task list.
  &quot;title&quot;: &quot;A String&quot;, # Title of the task list. Maximum length allowed: 1024 characters.
  &quot;updated&quot;: &quot;A String&quot;, # Output only. Last modification time of the task list (as a RFC 3339 timestamp).
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
  &quot;id&quot;: &quot;A String&quot;, # Task list identifier.
  &quot;kind&quot;: &quot;A String&quot;, # Output only. Type of the resource. This is always &quot;tasks#taskList&quot;.
  &quot;selfLink&quot;: &quot;A String&quot;, # Output only. URL pointing to this task list. Used to retrieve, update, or delete this task list.
  &quot;title&quot;: &quot;A String&quot;, # Title of the task list. Maximum length allowed: 1024 characters.
  &quot;updated&quot;: &quot;A String&quot;, # Output only. Last modification time of the task list (as a RFC 3339 timestamp).
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(maxResults=None, pageToken=None, x__xgafv=None)</code>
  <pre>Returns all the authenticated user&#x27;s task lists. A user can have up to 2000 lists at a time.

Args:
  maxResults: integer, Maximum number of task lists returned on one page. Optional. The default is 1000 (max allowed: 1000).
  pageToken: string, Token specifying the result page to return. Optional.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
  &quot;items&quot;: [ # Collection of task lists.
    {
      &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
      &quot;id&quot;: &quot;A String&quot;, # Task list identifier.
      &quot;kind&quot;: &quot;A String&quot;, # Output only. Type of the resource. This is always &quot;tasks#taskList&quot;.
      &quot;selfLink&quot;: &quot;A String&quot;, # Output only. URL pointing to this task list. Used to retrieve, update, or delete this task list.
      &quot;title&quot;: &quot;A String&quot;, # Title of the task list. Maximum length allowed: 1024 characters.
      &quot;updated&quot;: &quot;A String&quot;, # Output only. Last modification time of the task list (as a RFC 3339 timestamp).
    },
  ],
  &quot;kind&quot;: &quot;A String&quot;, # Type of the resource. This is always &quot;tasks#taskLists&quot;.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Token that can be used to request the next page of this result.
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(tasklist, body=None, x__xgafv=None)</code>
  <pre>Updates the authenticated user&#x27;s specified task list. This method supports patch semantics.

Args:
  tasklist: string, Task list identifier. (required)
  body: object, The request body.
    The object takes the form of:

{
  &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
  &quot;id&quot;: &quot;A String&quot;, # Task list identifier.
  &quot;kind&quot;: &quot;A String&quot;, # Output only. Type of the resource. This is always &quot;tasks#taskList&quot;.
  &quot;selfLink&quot;: &quot;A String&quot;, # Output only. URL pointing to this task list. Used to retrieve, update, or delete this task list.
  &quot;title&quot;: &quot;A String&quot;, # Title of the task list. Maximum length allowed: 1024 characters.
  &quot;updated&quot;: &quot;A String&quot;, # Output only. Last modification time of the task list (as a RFC 3339 timestamp).
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
  &quot;id&quot;: &quot;A String&quot;, # Task list identifier.
  &quot;kind&quot;: &quot;A String&quot;, # Output only. Type of the resource. This is always &quot;tasks#taskList&quot;.
  &quot;selfLink&quot;: &quot;A String&quot;, # Output only. URL pointing to this task list. Used to retrieve, update, or delete this task list.
  &quot;title&quot;: &quot;A String&quot;, # Title of the task list. Maximum length allowed: 1024 characters.
  &quot;updated&quot;: &quot;A String&quot;, # Output only. Last modification time of the task list (as a RFC 3339 timestamp).
}</pre>
</div>

<div class="method">
    <code class="details" id="update">update(tasklist, body=None, x__xgafv=None)</code>
  <pre>Updates the authenticated user&#x27;s specified task list.

Args:
  tasklist: string, Task list identifier. (required)
  body: object, The request body.
    The object takes the form of:

{
  &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
  &quot;id&quot;: &quot;A String&quot;, # Task list identifier.
  &quot;kind&quot;: &quot;A String&quot;, # Output only. Type of the resource. This is always &quot;tasks#taskList&quot;.
  &quot;selfLink&quot;: &quot;A String&quot;, # Output only. URL pointing to this task list. Used to retrieve, update, or delete this task list.
  &quot;title&quot;: &quot;A String&quot;, # Title of the task list. Maximum length allowed: 1024 characters.
  &quot;updated&quot;: &quot;A String&quot;, # Output only. Last modification time of the task list (as a RFC 3339 timestamp).
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
  &quot;id&quot;: &quot;A String&quot;, # Task list identifier.
  &quot;kind&quot;: &quot;A String&quot;, # Output only. Type of the resource. This is always &quot;tasks#taskList&quot;.
  &quot;selfLink&quot;: &quot;A String&quot;, # Output only. URL pointing to this task list. Used to retrieve, update, or delete this task list.
  &quot;title&quot;: &quot;A String&quot;, # Title of the task list. Maximum length allowed: 1024 characters.
  &quot;updated&quot;: &quot;A String&quot;, # Output only. Last modification time of the task list (as a RFC 3339 timestamp).
}</pre>
</div>

</body></html>