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

266 lines
11 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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-mirror1-cli/settings_get/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Get - mirror v5.0.4+20190424</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 = "Get";
var mkdocs_page_input_path = "settings_get.md";
var mkdocs_page_url = "/google-apis-rs/google-mirror1-cli/settings_get/";
</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"> mirror v5.0.4+20190424
</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">Accounts</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../accounts_insert/">Insert</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Contacts</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../contacts_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../contacts_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../contacts_insert/">Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../contacts_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../contacts_patch/">Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../contacts_update/">Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Locations</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../locations_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../locations_list/">List</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Settings</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">Get</a>
<ul class="current">
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">Subscriptions</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../subscriptions_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../subscriptions_insert/">Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../subscriptions_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../subscriptions_update/">Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Timeline</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../timeline_attachments-delete/">Attachments Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../timeline_attachments-get/">Attachments Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../timeline_attachments-insert/">Attachments Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../timeline_attachments-list/">Attachments List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../timeline_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../timeline_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../timeline_insert/">Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../timeline_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../timeline_patch/">Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../timeline_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="..">mirror v5.0.4+20190424</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>Settings &raquo;</li>
<li>Get</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/mirror1-cli/edit/master/docs/settings_get.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>Gets a single setting by ID.</p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for the <em>https://www.googleapis.com/auth/glass.timeline</em> scope to make a valid call.</p>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/glass.timeline</em>.
You can set the scope for this method like this: <code>mirror1 --scope &lt;scope&gt; settings get ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;id&gt;</strong> <em>(string)</em><ul>
<li>The ID of the setting. The following IDs are valid: <ul>
<li>locale - The key to the users language/locale (BCP 47 identifier) that Glassware should use to render localized content. </li>
<li>timezone - The key to the users current time zone region as defined in the tz database. Example: America/Los_Angeles.</li>
</ul>
</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-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 alt=string</strong></p>
<ul>
<li>Data format for the response.</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>An opaque string that represents a user for quota purposes. Must not exceed 40 characters.</li>
</ul>
</li>
<li>
<p><strong>-p user-ip=string</strong></p>
<ul>
<li>Deprecated. Please use quotaUser instead.</li>
</ul>
</li>
</ul>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../locations_list/" class="btn btn-neutral float-left" title="List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../subscriptions_delete/" class="btn btn-neutral float-right" title="Delete">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/mirror1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../locations_list/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../subscriptions_delete/" 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>