OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-28 21:02:29 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
a20241b2412723b0062d1c19a8ec792837b145a4
google-apis-rs/google_classroom1_cli/invitations_accept/index.html
Sebastian Thiel a20241b241 Update documentation
2022-03-08 15:36:16 +08:00

558 lines
19 KiB
HTML
Raw Blame History

<!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>Accept - classroom v3.0.0+20220224</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"> classroom v3.0.0+20220224</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Courses</span>
<li class="toctree-l1 ">
<a class="" href="../courses_aliases-create">Aliases Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_aliases-delete">Aliases Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_aliases-list">Aliases List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_announcements-create">Announcements Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_announcements-delete">Announcements Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_announcements-get">Announcements Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_announcements-list">Announcements List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_announcements-modify-assignees">Announcements Modify Assignees</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_announcements-patch">Announcements Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_course-work-create">Course Work Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_course-work-delete">Course Work Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_course-work-get">Course Work Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_course-work-list">Course Work List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_course-work-modify-assignees">Course Work Modify Assignees</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_course-work-patch">Course Work Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_course-work-student-submissions-get">Course Work Student Submissions Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_course-work-student-submissions-list">Course Work Student Submissions List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_course-work-student-submissions-modify-attachments">Course Work Student Submissions Modify Attachments</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_course-work-student-submissions-patch">Course Work Student Submissions Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_course-work-student-submissions-reclaim">Course Work Student Submissions Reclaim</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_course-work-student-submissions-return">Course Work Student Submissions Return</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_course-work-student-submissions-turn-in">Course Work Student Submissions Turn In</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_course-work-materials-create">Course Work Materials Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_course-work-materials-delete">Course Work Materials Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_course-work-materials-get">Course Work Materials Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_course-work-materials-list">Course Work Materials List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_course-work-materials-patch">Course Work Materials Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_create">Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_patch">Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_students-create">Students Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_students-delete">Students Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_students-get">Students Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_students-list">Students List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_teachers-create">Teachers Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_teachers-delete">Teachers Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_teachers-get">Teachers Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_teachers-list">Teachers List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_topics-create">Topics Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_topics-delete">Topics Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_topics-get">Topics Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_topics-list">Topics List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_topics-patch">Topics Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../courses_update">Update</a>
</li>
<span>Invitations</span>
<li class="toctree-l1 current">
<a class="current" href=".">Accept</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>
<li class="toctree-l1 ">
<a class="" href="../invitations_create">Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../invitations_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../invitations_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../invitations_list">List</a>
</li>
<span>Registrations</span>
<li class="toctree-l1 ">
<a class="" href="../registrations_create">Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../registrations_delete">Delete</a>
</li>
<span>User Profiles</span>
<li class="toctree-l1 ">
<a class="" href="../user-profiles_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../user-profiles_guardian-invitations-create">Guardian Invitations Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../user-profiles_guardian-invitations-get">Guardian Invitations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../user-profiles_guardian-invitations-list">Guardian Invitations List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../user-profiles_guardian-invitations-patch">Guardian Invitations Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../user-profiles_guardians-delete">Guardians Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../user-profiles_guardians-get">Guardians Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../user-profiles_guardians-list">Guardians List</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>Accept</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/classroom1-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<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="../invitations_create" class="btn btn-neutral float-right" title="Create"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../courses_update" class="btn btn-neutral" title="Update"><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="../courses_update" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../invitations_create" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink