Files
google-apis-rs/google_tasks1_cli/tasks_list/index.html
2024-03-05 21:06:01 +01:00

324 lines
12 KiB
HTML

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="http://byron.github.io/google-apis-rs/google-tasks1-cli/tasks_list/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>List - Tasks v5.0.4+20240303</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "List";
var mkdocs_page_input_path = "tasks_list.md";
var mkdocs_page_url = "/google-apis-rs/google-tasks1-cli/tasks_list/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> Tasks v5.0.4+20240303
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Tasklists</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../tasklists_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tasklists_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tasklists_insert/">Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tasklists_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tasklists_patch/">Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tasklists_update/">Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Tasks</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../tasks_clear/">Clear</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tasks_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tasks_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tasks_insert/">Insert</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">List</a>
<ul class="current">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tasks_move/">Move</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tasks_patch/">Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tasks_update/">Update</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">Tasks v5.0.4+20240303</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Tasks &raquo;</li>
<li>List</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/tasks1-cli/edit/master/docs/tasks_list.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<p>Returns all tasks in the specified task list.</p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
<ul>
<li><em>https://www.googleapis.com/auth/tasks</em></li>
<li><em>https://www.googleapis.com/auth/tasks.readonly</em></li>
</ul>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/tasks.readonly</em>.
You can set the scope for this method like this: <code>tasks1 --scope &lt;scope&gt; tasks list ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;tasklist&gt;</strong> <em>(string)</em><ul>
<li>Task list identifier.</li>
</ul>
</li>
</ul>
<h1 id="optional-output-flags">Optional Output Flags</h1>
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
<ul>
<li><strong>-o out</strong><ul>
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
It will be a JSON-encoded structure.
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
If unset, it defaults to standard output.</li>
</ul>
</li>
</ul>
<h1 id="optional-method-properties">Optional Method Properties</h1>
<p>You may set the following properties to further configure the call. Please note that <code>-p</code> is followed by one
or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> even though the listing below repeats the
<code>-p</code> for completeness.</p>
<ul>
<li>
<p><strong>-p completed-max=string</strong></p>
<ul>
<li>Upper bound for a task&#39;s completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date.</li>
</ul>
</li>
<li>
<p><strong>-p completed-min=string</strong></p>
<ul>
<li>Lower bound for a task&#39;s completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date.</li>
</ul>
</li>
<li>
<p><strong>-p due-max=string</strong></p>
<ul>
<li>Upper bound for a task&#39;s due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date.</li>
</ul>
</li>
<li>
<p><strong>-p due-min=string</strong></p>
<ul>
<li>Lower bound for a task&#39;s due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date.</li>
</ul>
</li>
<li>
<p><strong>-p max-results=integer</strong></p>
<ul>
<li>Maximum number of tasks returned on one page. Optional. The default is 20 (max allowed: 100).</li>
</ul>
</li>
<li>
<p><strong>-p page-token=string</strong></p>
<ul>
<li>Token specifying the result page to return. Optional.</li>
</ul>
</li>
<li>
<p><strong>-p show-completed=boolean</strong></p>
<ul>
<li>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&#39;s mobile apps.</li>
</ul>
</li>
<li>
<p><strong>-p show-deleted=boolean</strong></p>
<ul>
<li>Flag indicating whether deleted tasks are returned in the result. Optional. The default is False.</li>
</ul>
</li>
<li>
<p><strong>-p show-hidden=boolean</strong></p>
<ul>
<li>Flag indicating whether hidden tasks are returned in the result. Optional. The default is False.</li>
</ul>
</li>
<li>
<p><strong>-p updated-min=string</strong></p>
<ul>
<li>Lower bound for a task&#39;s last modification time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by last modification time.</li>
</ul>
</li>
</ul>
<h1 id="optional-general-properties">Optional General Properties</h1>
<p>The following properties can configure any call, and are not specific to this method.</p>
<ul>
<li>
<p><strong>-p $-xgafv=string</strong></p>
<ul>
<li>V1 error format.</li>
</ul>
</li>
<li>
<p><strong>-p access-token=string</strong></p>
<ul>
<li>OAuth access token.</li>
</ul>
</li>
<li>
<p><strong>-p alt=string</strong></p>
<ul>
<li>Data format for response.</li>
</ul>
</li>
<li>
<p><strong>-p callback=string</strong></p>
<ul>
<li>JSONP</li>
</ul>
</li>
<li>
<p><strong>-p fields=string</strong></p>
<ul>
<li>Selector specifying which fields to include in a partial response.</li>
</ul>
</li>
<li>
<p><strong>-p key=string</strong></p>
<ul>
<li>API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.</li>
</ul>
</li>
<li>
<p><strong>-p oauth-token=string</strong></p>
<ul>
<li>OAuth 2.0 token for the current user.</li>
</ul>
</li>
<li>
<p><strong>-p pretty-print=boolean</strong></p>
<ul>
<li>Returns response with indentations and line breaks.</li>
</ul>
</li>
<li>
<p><strong>-p quota-user=string</strong></p>
<ul>
<li>Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.</li>
</ul>
</li>
<li>
<p><strong>-p upload-type=string</strong></p>
<ul>
<li>Legacy upload protocol for media (e.g. &#34;media&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
<li>
<p><strong>-p upload-protocol=string</strong></p>
<ul>
<li>Upload protocol for media (e.g. &#34;raw&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
</ul>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../tasks_insert/" class="btn btn-neutral float-left" title="Insert"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../tasks_move/" class="btn btn-neutral float-right" title="Move">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
<p>Copyright &copy; 2015-2020, `Sebastian Thiel`</p>
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/tasks1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../tasks_insert/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../tasks_move/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>