Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e4e4b403f89a92d0f2d0661bf47d5ccd490d7bbd / . / docs / dyn / classroom_v1.registrations.html
blob: e681f016f101534ee6f7887395eb958669c2735f [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -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.registrations.html">registrations</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(body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">Creates a `Registration`, causing Classroom to start sending notifications from the provided `feed` to the destination provided in `cloudPubSubTopic`. Returns the created `Registration`. Currently, this will be the same as the argument, but with server-assigned fields such as `expiry_time` and `id` filled in. Note that any value specified for the `expiry_time` or `id` fields will be ignored. While Classroom may validate the `cloudPubSubTopic` and return errors on a best effort basis, it is the caller's responsibility to ensure that it exists and that Classroom has permission to publish to it. This method may return the following error codes: * `PERMISSION_DENIED` if: * the authenticated user does not have permission to receive notifications from the requested field; or * the current user has not granted access to the current Cloud project with the appropriate scope for the requested feed. Note that domain-wide delegation of authority is not currently supported for this purpose. If the request has the appropriate scope, but no grant exists, a Request Errors is returned. * another access error is encountered. * `INVALID_ARGUMENT` if: * no `cloudPubsubTopic` is specified, or the specified `cloudPubsubTopic` is not valid; or * no `feed` is specified, or the specified `feed` is not valid. * `NOT_FOUND` if: * the specified `feed` cannot be located, or the requesting user does not have permission to determine whether or not it exists; or * the specified `cloudPubsubTopic` cannot be located, or Classroom has not been granted permission to publish to it.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83<p class="toc_element">
84 <code><a href="#delete">delete(registrationId, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85<p class="firstline">Deletes a `Registration`, causing Classroom to stop sending notifications for that `Registration`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]86<h3>Method Details</h3>
87<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90</div>
91
92<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]93 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]94 <pre>Creates a `Registration`, causing Classroom to start sending notifications from the provided `feed` to the destination provided in `cloudPubSubTopic`. Returns the created `Registration`. Currently, this will be the same as the argument, but with server-assigned fields such as `expiry_time` and `id` filled in. Note that any value specified for the `expiry_time` or `id` fields will be ignored. While Classroom may validate the `cloudPubSubTopic` and return errors on a best effort basis, it is the caller&#x27;s responsibility to ensure that it exists and that Classroom has permission to publish to it. This method may return the following error codes: * `PERMISSION_DENIED` if: * the authenticated user does not have permission to receive notifications from the requested field; or * the current user has not granted access to the current Cloud project with the appropriate scope for the requested feed. Note that domain-wide delegation of authority is not currently supported for this purpose. If the request has the appropriate scope, but no grant exists, a Request Errors is returned. * another access error is encountered. * `INVALID_ARGUMENT` if: * no `cloudPubsubTopic` is specified, or the specified `cloudPubsubTopic` is not valid; or * no `feed` is specified, or the specified `feed` is not valid. * `NOT_FOUND` if: * the specified `feed` cannot be located, or the requesting user does not have permission to determine whether or not it exists; or * the specified `cloudPubsubTopic` cannot be located, or Classroom has not been granted permission to publish to it.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]95
96Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]97 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98 The object takes the form of:
99
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]100{ # An instruction to Classroom to send notifications from the `feed` to the provided destination.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]101 &quot;registrationId&quot;: &quot;A String&quot;, # A server-generated unique identifier for this `Registration`. Read-only.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]102 &quot;expiryTime&quot;: &quot;A String&quot;, # The time until which the `Registration` is effective. This is a read-only field assigned by the server.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]103 &quot;feed&quot;: { # A class of notifications that an application can register to receive. For example: &quot;all roster changes for a domain&quot;. # Specification for the class of notifications that Classroom should deliver to the destination.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]104 &quot;courseWorkChangesInfo&quot;: { # Information about a `Feed` with a `feed_type` of `COURSE_WORK_CHANGES`. # Information about a `Feed` with a `feed_type` of `COURSE_WORK_CHANGES`. This field must be specified if `feed_type` is `COURSE_WORK_CHANGES`.
105 &quot;courseId&quot;: &quot;A String&quot;, # The `course_id` of the course to subscribe to work changes for.
106 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]107 &quot;feedType&quot;: &quot;A String&quot;, # The type of feed.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]108 &quot;courseRosterChangesInfo&quot;: { # Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`. # Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`. This field must be specified if `feed_type` is `COURSE_ROSTER_CHANGES`.
109 &quot;courseId&quot;: &quot;A String&quot;, # The `course_id` of the course to subscribe to roster changes for.
110 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]111 },
112 &quot;cloudPubsubTopic&quot;: { # A reference to a Cloud Pub/Sub topic. To register for notifications, the owner of the topic must grant `classroom-notifications@system.gserviceaccount.com` the `projects.topics.publish` permission. # The Cloud Pub/Sub topic that notifications are to be sent to.
113 &quot;topicName&quot;: &quot;A String&quot;, # The `name` field of a Cloud Pub/Sub [Topic](https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]114 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]115 }
116
117 x__xgafv: string, V1 error format.
118 Allowed values
119 1 - v1 error format
120 2 - v2 error format
121
122Returns:
123 An object of the form:
124
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]125 { # An instruction to Classroom to send notifications from the `feed` to the provided destination.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]126 &quot;registrationId&quot;: &quot;A String&quot;, # A server-generated unique identifier for this `Registration`. Read-only.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]127 &quot;expiryTime&quot;: &quot;A String&quot;, # The time until which the `Registration` is effective. This is a read-only field assigned by the server.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]128 &quot;feed&quot;: { # A class of notifications that an application can register to receive. For example: &quot;all roster changes for a domain&quot;. # Specification for the class of notifications that Classroom should deliver to the destination.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]129 &quot;courseWorkChangesInfo&quot;: { # Information about a `Feed` with a `feed_type` of `COURSE_WORK_CHANGES`. # Information about a `Feed` with a `feed_type` of `COURSE_WORK_CHANGES`. This field must be specified if `feed_type` is `COURSE_WORK_CHANGES`.
130 &quot;courseId&quot;: &quot;A String&quot;, # The `course_id` of the course to subscribe to work changes for.
131 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]132 &quot;feedType&quot;: &quot;A String&quot;, # The type of feed.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]133 &quot;courseRosterChangesInfo&quot;: { # Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`. # Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`. This field must be specified if `feed_type` is `COURSE_ROSTER_CHANGES`.
134 &quot;courseId&quot;: &quot;A String&quot;, # The `course_id` of the course to subscribe to roster changes for.
135 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]136 },
137 &quot;cloudPubsubTopic&quot;: { # A reference to a Cloud Pub/Sub topic. To register for notifications, the owner of the topic must grant `classroom-notifications@system.gserviceaccount.com` the `projects.topics.publish` permission. # The Cloud Pub/Sub topic that notifications are to be sent to.
138 &quot;topicName&quot;: &quot;A String&quot;, # The `name` field of a Cloud Pub/Sub [Topic](https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]139 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]140 }</pre>
141</div>
142
143<div class="method">
144 <code class="details" id="delete">delete(registrationId, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]145 <pre>Deletes a `Registration`, causing Classroom to stop sending notifications for that `Registration`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]146
147Args:
148 registrationId: string, The `registration_id` of the `Registration` to be deleted. (required)
149 x__xgafv: string, V1 error format.
150 Allowed values
151 1 - v1 error format
152 2 - v2 error format
153
154Returns:
155 An object of the form:
156
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]157 { # 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 `{}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]158 }</pre>
159</div>
160
161</body></html>