docs/dyn/tasks_v1.tasklists.html

<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.</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.</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.</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.

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;, # Type of the resource. This is always &quot;tasks#taskList&quot;.
  &quot;selfLink&quot;: &quot;A String&quot;, # 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.
  &quot;updated&quot;: &quot;A String&quot;, # 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.

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;, # Type of the resource. This is always &quot;tasks#taskList&quot;.
  &quot;selfLink&quot;: &quot;A String&quot;, # 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.
  &quot;updated&quot;: &quot;A String&quot;, # 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;, # Type of the resource. This is always &quot;tasks#taskList&quot;.
  &quot;selfLink&quot;: &quot;A String&quot;, # 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.
  &quot;updated&quot;: &quot;A String&quot;, # 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.

Args:
  maxResults: integer, Maximum number of task lists returned on one page. Optional. The default is 20 (max allowed: 100).
  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;, # Type of the resource. This is always &quot;tasks#taskList&quot;.
      &quot;selfLink&quot;: &quot;A String&quot;, # 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.
      &quot;updated&quot;: &quot;A String&quot;, # 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;, # Type of the resource. This is always &quot;tasks#taskList&quot;.
  &quot;selfLink&quot;: &quot;A String&quot;, # 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.
  &quot;updated&quot;: &quot;A String&quot;, # 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;, # Type of the resource. This is always &quot;tasks#taskList&quot;.
  &quot;selfLink&quot;: &quot;A String&quot;, # 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.
  &quot;updated&quot;: &quot;A String&quot;, # 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;, # Type of the resource. This is always &quot;tasks#taskList&quot;.
  &quot;selfLink&quot;: &quot;A String&quot;, # 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.
  &quot;updated&quot;: &quot;A String&quot;, # 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;, # Type of the resource. This is always &quot;tasks#taskList&quot;.
  &quot;selfLink&quot;: &quot;A String&quot;, # 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.
  &quot;updated&quot;: &quot;A String&quot;, # Last modification time of the task list (as a RFC 3339 timestamp).
}</pre>
</div>

</body></html>