Files
google-apis-rs/google_mirror1_cli/settings_get/index.html
2022-03-08 15:36:16 +08:00

365 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>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Get - mirror v3.0.0+20190424</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
<link rel="stylesheet" href="../css/highlight.css">
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js"></script>
<script type="text/javascript" src="../js/highlight.pack.js"></script>
<script src="../js/theme.js"></script>
<style>
body {font-size: 90%;}
pre, code {font-size: 100%;}
h3, h4, h5, h6 {color: #2980b9; font-weight: 300}
</style>
</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-nav-search">
<a href=".." class="icon icon-home"> mirror v3.0.0+20190424</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Accounts</span>
<li class="toctree-l1 ">
<a class="" href="../accounts_insert">Insert</a>
</li>
<span>Contacts</span>
<li class="toctree-l1 ">
<a class="" href="../contacts_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../contacts_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../contacts_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../contacts_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../contacts_patch">Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../contacts_update">Update</a>
</li>
<span>Locations</span>
<li class="toctree-l1 ">
<a class="" href="../locations_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../locations_list">List</a>
</li>
<span>Settings</span>
<li class="toctree-l1 current">
<a class="current" href=".">Get</a>
<ul>
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
<li class="toctree-l2"><a href="#required-scalar-argument">Required Scalar Argument</a></li>
<li class="toctree-l2"><a href="#optional-output-flags">Optional Output Flags</a></li>
<li class="toctree-l2"><a href="#optional-general-properties">Optional General Properties</a></li>
</ul>
</li>
<span>Subscriptions</span>
<li class="toctree-l1 ">
<a class="" href="../subscriptions_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../subscriptions_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../subscriptions_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../subscriptions_update">Update</a>
</li>
<span>Timeline</span>
<li class="toctree-l1 ">
<a class="" href="../timeline_attachments-delete">Attachments Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../timeline_attachments-get">Attachments Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../timeline_attachments-insert">Attachments Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../timeline_attachments-list">Attachments List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../timeline_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../timeline_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../timeline_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../timeline_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../timeline_patch">Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../timeline_update">Update</a>
</li>
</ul>
</div>
&nbsp;
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
<a href=".."></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="..">Docs</a> &raquo;</li>
<li>Get</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/mirror1-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<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="../subscriptions_delete" class="btn btn-neutral float-right" title="Delete"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../locations_list" class="btn btn-neutral" title="List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
<!-- Copyright etc -->
</p>
</div>
Built with <a href="http://www.mkdocs.org">MkDocs</a>, using a <a href="https://github.com/snide/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" style="cursor: pointer">
<span class="rst-current-version" data-toggle="rst-current-version">
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
<span><a href="../locations_list" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../subscriptions_delete" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>