Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b6971b0405ba59d905b84fa5fc8e27e12d29b70c / . / docs / dyn / classroom_v1.courses.aliases.html
blob: fe68adc5da25f7d838445e7171146aaea70f7867 [file] [log] [blame]
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="classroom_v1.html">Google Classroom API</a> . <a href="classroom_v1.courses.html">courses</a> . <a href="classroom_v1.courses.aliases.html">aliases</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]81 <code><a href="#create">create(courseId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">Creates an alias for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the alias or for access errors. * `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the alias already exists. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to access a domain-scoped alias).</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]83<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]84 <code><a href="#delete">delete(courseId, alias, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85<p class="firstline">Deletes an alias of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to remove the alias or for access errors. * `NOT_FOUND` if the alias does not exist. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to delete a domain-scoped alias).</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]86<p class="toc_element">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]87 <code><a href="#list">list(courseId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88<p class="firstline">Returns a list of aliases for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for access errors. * `NOT_FOUND` if the course does not exist.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<h3>Method Details</h3>
93<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]94 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96</div>
97
98<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]99 <code class="details" id="create">create(courseId, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]100 <pre>Creates an alias for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the alias or for access errors. * `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the alias already exists. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to access a domain-scoped alias).
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]101
102Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]103 courseId: string, Identifier of the course to alias. This identifier can be either the Classroom-assigned identifier or an alias. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]104 body: object, The request body.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]105 The object takes the form of:
106
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]107{ # Alternative identifier for a course. An alias uniquely identifies a course. It must be unique within one of the following scopes: * domain: A domain-scoped alias is visible to all users within the alias creator&#x27;s domain and can be created only by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom. * project: A project-scoped alias is visible to any request from an application using the Developer Console project ID that created the alias and can be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return `ALREADY_EXISTS` if a previous one has succeeded.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]108 &quot;alias&quot;: &quot;A String&quot;, # Alias string. The format of the string indicates the desired alias scoping. * `d:` indicates a domain-scoped alias. Example: `d:math_101` * `p:` indicates a project-scoped alias. Example: `p:abc123` This field has a maximum length of 256 characters.
109 }
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]110
111 x__xgafv: string, V1 error format.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]112 Allowed values
113 1 - v1 error format
114 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]115
116Returns:
117 An object of the form:
118
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]119 { # Alternative identifier for a course. An alias uniquely identifies a course. It must be unique within one of the following scopes: * domain: A domain-scoped alias is visible to all users within the alias creator&#x27;s domain and can be created only by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom. * project: A project-scoped alias is visible to any request from an application using the Developer Console project ID that created the alias and can be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return `ALREADY_EXISTS` if a previous one has succeeded.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]120 &quot;alias&quot;: &quot;A String&quot;, # Alias string. The format of the string indicates the desired alias scoping. * `d:` indicates a domain-scoped alias. Example: `d:math_101` * `p:` indicates a project-scoped alias. Example: `p:abc123` This field has a maximum length of 256 characters.
121 }</pre>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]122</div>
123
124<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]125 <code class="details" id="delete">delete(courseId, alias, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]126 <pre>Deletes an alias of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to remove the alias or for access errors. * `NOT_FOUND` if the alias does not exist. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to delete a domain-scoped alias).
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]127
128Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]129 courseId: string, Identifier of the course whose alias should be deleted. This identifier can be either the Classroom-assigned identifier or an alias. (required)
130 alias: string, Alias to delete. This may not be the Classroom-assigned identifier. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]131 x__xgafv: string, V1 error format.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]132 Allowed values
133 1 - v1 error format
134 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]135
136Returns:
137 An object of the form:
138
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]139 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]140 }</pre>
141</div>
142
143<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]144 <code class="details" id="list">list(courseId, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]145 <pre>Returns a list of aliases for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for access errors. * `NOT_FOUND` if the course does not exist.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]146
147Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]148 courseId: string, The identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]149 pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]150 pageToken: string, nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]151 x__xgafv: string, V1 error format.
152 Allowed values
153 1 - v1 error format
154 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]155
156Returns:
157 An object of the form:
158
159 { # Response when listing course aliases.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]160 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token identifying the next page of results to return. If empty, no further results are available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]161 &quot;aliases&quot;: [ # The course aliases.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]162 { # Alternative identifier for a course. An alias uniquely identifies a course. It must be unique within one of the following scopes: * domain: A domain-scoped alias is visible to all users within the alias creator&#x27;s domain and can be created only by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom. * project: A project-scoped alias is visible to any request from an application using the Developer Console project ID that created the alias and can be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return `ALREADY_EXISTS` if a previous one has succeeded.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]163 &quot;alias&quot;: &quot;A String&quot;, # Alias string. The format of the string indicates the desired alias scoping. * `d:` indicates a domain-scoped alias. Example: `d:math_101` * `p:` indicates a project-scoped alias. Example: `p:abc123` This field has a maximum length of 256 characters.
164 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]165 ],
166 }</pre>
167</div>
168
169<div class="method">
170 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
171 <pre>Retrieves the next page of results.
172
173Args:
174 previous_request: The request for the previous page. (required)
175 previous_response: The response from the request for the previous page. (required)
176
177Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]178 A request object that you can call &#x27;execute()&#x27; on to request the next
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]179 page. Returns None if there are no more items in the collection.
180 </pre>
181</div>
182
183</body></html>