OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-27 04:10:02 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
f4bb79d2d629ee5166f17b80ca2aa0e621d1c837
google-apis-rs/google_classroom1_cli/build_html/invitations_accept/index.html
Sebastian Thiel f4bb79d2d6 Update documentation
2024-03-05 21:06:01 +01:00

354 lines
18 KiB
HTML
Raw Blame History

<!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-classroom1-cli/invitations_accept/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Accept - classroom v5.0.4+20240227</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 = "Accept";
var mkdocs_page_input_path = "invitations_accept.md";
var mkdocs_page_url = "/google-apis-rs/google-classroom1-cli/invitations_accept/";
</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"> classroom v5.0.4+20240227
</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">Courses</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../courses_aliases-create/">Aliases Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_aliases-delete/">Aliases Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_aliases-list/">Aliases List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_announcements-create/">Announcements Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_announcements-delete/">Announcements Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_announcements-get/">Announcements Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_announcements-list/">Announcements List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_announcements-modify-assignees/">Announcements Modify Assignees</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_announcements-patch/">Announcements Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-create/">Course Work Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-delete/">Course Work Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-get/">Course Work Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-list/">Course Work List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-modify-assignees/">Course Work Modify Assignees</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-patch/">Course Work Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-student-submissions-get/">Course Work Student Submissions Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-student-submissions-list/">Course Work Student Submissions List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-student-submissions-modify-attachments/">Course Work Student Submissions Modify Attachments</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-student-submissions-patch/">Course Work Student Submissions Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-student-submissions-reclaim/">Course Work Student Submissions Reclaim</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-student-submissions-return/">Course Work Student Submissions Return</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-student-submissions-turn-in/">Course Work Student Submissions Turn In</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-materials-create/">Course Work Materials Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-materials-delete/">Course Work Materials Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-materials-get/">Course Work Materials Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-materials-list/">Course Work Materials List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_course-work-materials-patch/">Course Work Materials Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_create/">Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_patch/">Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_students-create/">Students Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_students-delete/">Students Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_students-get/">Students Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_students-list/">Students List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_teachers-create/">Teachers Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_teachers-delete/">Teachers Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_teachers-get/">Teachers Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_teachers-list/">Teachers List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_topics-create/">Topics Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_topics-delete/">Topics Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_topics-get/">Topics Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_topics-list/">Topics List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_topics-patch/">Topics Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../courses_update/">Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Invitations</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">Accept</a>
<ul class="current">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../invitations_create/">Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../invitations_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../invitations_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../invitations_list/">List</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Registrations</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../registrations_create/">Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../registrations_delete/">Delete</a>
</li>
</ul>
<p class="caption"><span class="caption-text">User Profiles</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../user-profiles_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../user-profiles_guardian-invitations-create/">Guardian Invitations Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../user-profiles_guardian-invitations-get/">Guardian Invitations Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../user-profiles_guardian-invitations-list/">Guardian Invitations List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../user-profiles_guardian-invitations-patch/">Guardian Invitations Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../user-profiles_guardians-delete/">Guardians Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../user-profiles_guardians-get/">Guardians Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../user-profiles_guardians-list/">Guardians List</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="..">classroom v5.0.4+20240227</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>Invitations &raquo;</li>
<li>Accept</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/classroom1-cli/edit/master/docs/invitations_accept.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>Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes: * <code>PERMISSION_DENIED</code> if the requesting user is not permitted to accept the requested invitation or for access errors. * <code>FAILED_PRECONDITION</code> for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * <code>NOT_FOUND</code> if no invitation exists with the requested ID.</p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for the <em>https://www.googleapis.com/auth/classroom.rosters</em> scope to make a valid call.</p>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/classroom.rosters</em>.
You can set the scope for this method like this: <code>classroom1 --scope &lt;scope&gt; invitations accept ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;id&gt;</strong> <em>(string)</em><ul>
<li>Identifier of the invitation to accept.</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 $-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="../courses_update/" class="btn btn-neutral float-left" title="Update"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../invitations_create/" class="btn btn-neutral float-right" title="Create">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/classroom1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../courses_update/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../invitations_create/" 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>
Reference in New Issue View Git Blame Copy Permalink