Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 25fba648ea647b62f2a6edc54ae927c1ed381b45 / . / docs / dyn / calendar_v3.acl.html
blob: 4bba7fc4748a6053c7411404c25e0172f5c1fbff [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[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="calendar_v3.html">Calendar API</a> . <a href="calendar_v3.acl.html">acl</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">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]81 <code><a href="#delete">delete(calendarId, ruleId)</a></code></p>
82<p class="firstline">Deletes an access control rule.</p>
83<p class="toc_element">
84 <code><a href="#get">get(calendarId, ruleId)</a></code></p>
85<p class="firstline">Returns an access control rule.</p>
86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]87 <code><a href="#insert">insert(calendarId, body=None, sendNotifications=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]88<p class="firstline">Creates an access control rule.</p>
89<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]90 <code><a href="#list">list(calendarId, maxResults=None, syncToken=None, showDeleted=None, pageToken=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]91<p class="firstline">Returns the rules in the access control list for the calendar.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]96 <code><a href="#patch">patch(calendarId, ruleId, body=None, sendNotifications=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]97<p class="firstline">Updates an access control rule. This method supports patch semantics.</p>
98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]99 <code><a href="#update">update(calendarId, ruleId, body=None, sendNotifications=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]100<p class="firstline">Updates an access control rule.</p>
101<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]102 <code><a href="#watch">watch(calendarId, body=None, maxResults=None, syncToken=None, showDeleted=None, pageToken=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]103<p class="firstline">Watch for changes to ACL resources.</p>
104<h3>Method Details</h3>
105<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]106 <code class="details" id="close">close()</code>
107 <pre>Close httplib2 connections.</pre>
108</div>
109
110<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]111 <code class="details" id="delete">delete(calendarId, ruleId)</code>
112 <pre>Deletes an access control rule.
113
114Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]115 calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the &quot;primary&quot; keyword. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]116 ruleId: string, ACL rule identifier. (required)
117</pre>
118</div>
119
120<div class="method">
121 <code class="details" id="get">get(calendarId, ruleId)</code>
122 <pre>Returns an access control rule.
123
124Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]125 calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the &quot;primary&quot; keyword. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]126 ruleId: string, ACL rule identifier. (required)
127
128Returns:
129 An object of the form:
130
131 {
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]132 &quot;kind&quot;: &quot;calendar#aclRule&quot;, # Type of the resource (&quot;calendar#aclRule&quot;).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]133 &quot;id&quot;: &quot;A String&quot;, # Identifier of the ACL rule.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]134 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
135 &quot;scope&quot;: { # The scope of the rule.
136 &quot;value&quot;: &quot;A String&quot;, # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type &quot;default&quot;.
137 &quot;type&quot;: &quot;A String&quot;, # The type of the scope. Possible values are:
138 # - &quot;default&quot; - The public scope. This is the default value.
139 # - &quot;user&quot; - Limits the scope to a single user.
140 # - &quot;group&quot; - Limits the scope to a group.
141 # - &quot;domain&quot; - Limits the scope to a domain. Note: The permissions granted to the &quot;default&quot;, or public, scope apply to any user, authenticated or not.
142 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]143 &quot;role&quot;: &quot;A String&quot;, # The role assigned to the scope. Possible values are:
144 # - &quot;none&quot; - Provides no access.
145 # - &quot;freeBusyReader&quot; - Provides read access to free/busy information.
146 # - &quot;reader&quot; - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
147 # - &quot;writer&quot; - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
148 # - &quot;owner&quot; - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]149 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]150</div>
151
152<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]153 <code class="details" id="insert">insert(calendarId, body=None, sendNotifications=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]154 <pre>Creates an access control rule.
155
156Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]157 calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the &quot;primary&quot; keyword. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]158 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]159 The object takes the form of:
160
161{
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]162 &quot;kind&quot;: &quot;calendar#aclRule&quot;, # Type of the resource (&quot;calendar#aclRule&quot;).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]163 &quot;id&quot;: &quot;A String&quot;, # Identifier of the ACL rule.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]164 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
165 &quot;scope&quot;: { # The scope of the rule.
166 &quot;value&quot;: &quot;A String&quot;, # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type &quot;default&quot;.
167 &quot;type&quot;: &quot;A String&quot;, # The type of the scope. Possible values are:
168 # - &quot;default&quot; - The public scope. This is the default value.
169 # - &quot;user&quot; - Limits the scope to a single user.
170 # - &quot;group&quot; - Limits the scope to a group.
171 # - &quot;domain&quot; - Limits the scope to a domain. Note: The permissions granted to the &quot;default&quot;, or public, scope apply to any user, authenticated or not.
172 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]173 &quot;role&quot;: &quot;A String&quot;, # The role assigned to the scope. Possible values are:
174 # - &quot;none&quot; - Provides no access.
175 # - &quot;freeBusyReader&quot; - Provides read access to free/busy information.
176 # - &quot;reader&quot; - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
177 # - &quot;writer&quot; - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
178 # - &quot;owner&quot; - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]179 }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]180
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]181 sendNotifications: boolean, Whether to send notifications about the calendar sharing change. Optional. The default is True.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]182
183Returns:
184 An object of the form:
185
186 {
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]187 &quot;kind&quot;: &quot;calendar#aclRule&quot;, # Type of the resource (&quot;calendar#aclRule&quot;).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]188 &quot;id&quot;: &quot;A String&quot;, # Identifier of the ACL rule.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]189 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
190 &quot;scope&quot;: { # The scope of the rule.
191 &quot;value&quot;: &quot;A String&quot;, # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type &quot;default&quot;.
192 &quot;type&quot;: &quot;A String&quot;, # The type of the scope. Possible values are:
193 # - &quot;default&quot; - The public scope. This is the default value.
194 # - &quot;user&quot; - Limits the scope to a single user.
195 # - &quot;group&quot; - Limits the scope to a group.
196 # - &quot;domain&quot; - Limits the scope to a domain. Note: The permissions granted to the &quot;default&quot;, or public, scope apply to any user, authenticated or not.
197 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]198 &quot;role&quot;: &quot;A String&quot;, # The role assigned to the scope. Possible values are:
199 # - &quot;none&quot; - Provides no access.
200 # - &quot;freeBusyReader&quot; - Provides read access to free/busy information.
201 # - &quot;reader&quot; - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
202 # - &quot;writer&quot; - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
203 # - &quot;owner&quot; - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]204 }</pre>
205</div>
206
207<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]208 <code class="details" id="list">list(calendarId, maxResults=None, syncToken=None, showDeleted=None, pageToken=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]209 <pre>Returns the rules in the access control list for the calendar.
210
211Args:
212 calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the &quot;primary&quot; keyword. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]213 maxResults: integer, Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]214 syncToken: string, Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.
215If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.
216Learn more about incremental synchronization.
217Optional. The default is to return all entries.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]218 showDeleted: boolean, Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to &quot;none&quot;. Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.
219 pageToken: string, Token specifying which result page to return. Optional.
220
221Returns:
222 An object of the form:
223
224 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]225 &quot;items&quot;: [ # List of rules on the access control list.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]226 {
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]227 &quot;kind&quot;: &quot;calendar#aclRule&quot;, # Type of the resource (&quot;calendar#aclRule&quot;).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]228 &quot;id&quot;: &quot;A String&quot;, # Identifier of the ACL rule.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]229 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
230 &quot;scope&quot;: { # The scope of the rule.
231 &quot;value&quot;: &quot;A String&quot;, # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type &quot;default&quot;.
232 &quot;type&quot;: &quot;A String&quot;, # The type of the scope. Possible values are:
233 # - &quot;default&quot; - The public scope. This is the default value.
234 # - &quot;user&quot; - Limits the scope to a single user.
235 # - &quot;group&quot; - Limits the scope to a group.
236 # - &quot;domain&quot; - Limits the scope to a domain. Note: The permissions granted to the &quot;default&quot;, or public, scope apply to any user, authenticated or not.
237 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]238 &quot;role&quot;: &quot;A String&quot;, # The role assigned to the scope. Possible values are:
239 # - &quot;none&quot; - Provides no access.
240 # - &quot;freeBusyReader&quot; - Provides read access to free/busy information.
241 # - &quot;reader&quot; - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
242 # - &quot;writer&quot; - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
243 # - &quot;owner&quot; - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]244 },
245 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]246 &quot;etag&quot;: &quot;A String&quot;, # ETag of the collection.
247 &quot;kind&quot;: &quot;calendar#acl&quot;, # Type of the collection (&quot;calendar#acl&quot;).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]248 &quot;nextSyncToken&quot;: &quot;A String&quot;, # Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]249 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]250 }</pre>
251</div>
252
253<div class="method">
254 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
255 <pre>Retrieves the next page of results.
256
257Args:
258 previous_request: The request for the previous page. (required)
259 previous_response: The response from the request for the previous page. (required)
260
261Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]262 A request object that you can call &#x27;execute()&#x27; on to request the next
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]263 page. Returns None if there are no more items in the collection.
264 </pre>
265</div>
266
267<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]268 <code class="details" id="patch">patch(calendarId, ruleId, body=None, sendNotifications=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]269 <pre>Updates an access control rule. This method supports patch semantics.
270
271Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]272 calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the &quot;primary&quot; keyword. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]273 ruleId: string, ACL rule identifier. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]274 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]275 The object takes the form of:
276
277{
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]278 &quot;kind&quot;: &quot;calendar#aclRule&quot;, # Type of the resource (&quot;calendar#aclRule&quot;).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]279 &quot;id&quot;: &quot;A String&quot;, # Identifier of the ACL rule.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]280 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
281 &quot;scope&quot;: { # The scope of the rule.
282 &quot;value&quot;: &quot;A String&quot;, # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type &quot;default&quot;.
283 &quot;type&quot;: &quot;A String&quot;, # The type of the scope. Possible values are:
284 # - &quot;default&quot; - The public scope. This is the default value.
285 # - &quot;user&quot; - Limits the scope to a single user.
286 # - &quot;group&quot; - Limits the scope to a group.
287 # - &quot;domain&quot; - Limits the scope to a domain. Note: The permissions granted to the &quot;default&quot;, or public, scope apply to any user, authenticated or not.
288 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]289 &quot;role&quot;: &quot;A String&quot;, # The role assigned to the scope. Possible values are:
290 # - &quot;none&quot; - Provides no access.
291 # - &quot;freeBusyReader&quot; - Provides read access to free/busy information.
292 # - &quot;reader&quot; - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
293 # - &quot;writer&quot; - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
294 # - &quot;owner&quot; - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]295 }
296
297 sendNotifications: boolean, Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.
298
299Returns:
300 An object of the form:
301
302 {
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]303 &quot;kind&quot;: &quot;calendar#aclRule&quot;, # Type of the resource (&quot;calendar#aclRule&quot;).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]304 &quot;id&quot;: &quot;A String&quot;, # Identifier of the ACL rule.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]305 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
306 &quot;scope&quot;: { # The scope of the rule.
307 &quot;value&quot;: &quot;A String&quot;, # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type &quot;default&quot;.
308 &quot;type&quot;: &quot;A String&quot;, # The type of the scope. Possible values are:
309 # - &quot;default&quot; - The public scope. This is the default value.
310 # - &quot;user&quot; - Limits the scope to a single user.
311 # - &quot;group&quot; - Limits the scope to a group.
312 # - &quot;domain&quot; - Limits the scope to a domain. Note: The permissions granted to the &quot;default&quot;, or public, scope apply to any user, authenticated or not.
313 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]314 &quot;role&quot;: &quot;A String&quot;, # The role assigned to the scope. Possible values are:
315 # - &quot;none&quot; - Provides no access.
316 # - &quot;freeBusyReader&quot; - Provides read access to free/busy information.
317 # - &quot;reader&quot; - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
318 # - &quot;writer&quot; - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
319 # - &quot;owner&quot; - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]320 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]321</div>
322
323<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]324 <code class="details" id="update">update(calendarId, ruleId, body=None, sendNotifications=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]325 <pre>Updates an access control rule.
326
327Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]328 calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the &quot;primary&quot; keyword. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]329 ruleId: string, ACL rule identifier. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]330 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]331 The object takes the form of:
332
333{
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]334 &quot;kind&quot;: &quot;calendar#aclRule&quot;, # Type of the resource (&quot;calendar#aclRule&quot;).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]335 &quot;id&quot;: &quot;A String&quot;, # Identifier of the ACL rule.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]336 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
337 &quot;scope&quot;: { # The scope of the rule.
338 &quot;value&quot;: &quot;A String&quot;, # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type &quot;default&quot;.
339 &quot;type&quot;: &quot;A String&quot;, # The type of the scope. Possible values are:
340 # - &quot;default&quot; - The public scope. This is the default value.
341 # - &quot;user&quot; - Limits the scope to a single user.
342 # - &quot;group&quot; - Limits the scope to a group.
343 # - &quot;domain&quot; - Limits the scope to a domain. Note: The permissions granted to the &quot;default&quot;, or public, scope apply to any user, authenticated or not.
344 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]345 &quot;role&quot;: &quot;A String&quot;, # The role assigned to the scope. Possible values are:
346 # - &quot;none&quot; - Provides no access.
347 # - &quot;freeBusyReader&quot; - Provides read access to free/busy information.
348 # - &quot;reader&quot; - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
349 # - &quot;writer&quot; - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
350 # - &quot;owner&quot; - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]351 }
352
353 sendNotifications: boolean, Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.
354
355Returns:
356 An object of the form:
357
358 {
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]359 &quot;kind&quot;: &quot;calendar#aclRule&quot;, # Type of the resource (&quot;calendar#aclRule&quot;).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]360 &quot;id&quot;: &quot;A String&quot;, # Identifier of the ACL rule.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]361 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
362 &quot;scope&quot;: { # The scope of the rule.
363 &quot;value&quot;: &quot;A String&quot;, # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type &quot;default&quot;.
364 &quot;type&quot;: &quot;A String&quot;, # The type of the scope. Possible values are:
365 # - &quot;default&quot; - The public scope. This is the default value.
366 # - &quot;user&quot; - Limits the scope to a single user.
367 # - &quot;group&quot; - Limits the scope to a group.
368 # - &quot;domain&quot; - Limits the scope to a domain. Note: The permissions granted to the &quot;default&quot;, or public, scope apply to any user, authenticated or not.
369 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]370 &quot;role&quot;: &quot;A String&quot;, # The role assigned to the scope. Possible values are:
371 # - &quot;none&quot; - Provides no access.
372 # - &quot;freeBusyReader&quot; - Provides read access to free/busy information.
373 # - &quot;reader&quot; - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
374 # - &quot;writer&quot; - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
375 # - &quot;owner&quot; - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]376 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]377</div>
378
379<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]380 <code class="details" id="watch">watch(calendarId, body=None, maxResults=None, syncToken=None, showDeleted=None, pageToken=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]381 <pre>Watch for changes to ACL resources.
382
383Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]384 calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the &quot;primary&quot; keyword. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]385 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]386 The object takes the form of:
387
388{
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]389 &quot;kind&quot;: &quot;api#channel&quot;, # Identifies this as a notification channel used to watch for changes to a resource, which is &quot;api#channel&quot;.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]390 &quot;resourceId&quot;: &quot;A String&quot;, # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]391 &quot;payload&quot;: True or False, # A Boolean value to indicate whether payload is wanted. Optional.
392 &quot;type&quot;: &quot;A String&quot;, # The type of delivery mechanism used for this channel.
393 &quot;id&quot;: &quot;A String&quot;, # A UUID or similar unique string that identifies this channel.
394 &quot;token&quot;: &quot;A String&quot;, # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
395 &quot;resourceUri&quot;: &quot;A String&quot;, # A version-specific identifier for the watched resource.
396 &quot;expiration&quot;: &quot;A String&quot;, # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]397 &quot;params&quot;: { # Additional parameters controlling delivery channel behavior. Optional.
398 &quot;a_key&quot;: &quot;A String&quot;, # Declares a new parameter by name.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]399 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]400 &quot;address&quot;: &quot;A String&quot;, # The address where notifications are delivered for this channel.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]401 }
402
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]403 maxResults: integer, Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]404 syncToken: string, Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.
405If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.
406Learn more about incremental synchronization.
407Optional. The default is to return all entries.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]408 showDeleted: boolean, Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to &quot;none&quot;. Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]409 pageToken: string, Token specifying which result page to return. Optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]410
411Returns:
412 An object of the form:
413
414 {
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]415 &quot;kind&quot;: &quot;api#channel&quot;, # Identifies this as a notification channel used to watch for changes to a resource, which is &quot;api#channel&quot;.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]416 &quot;resourceId&quot;: &quot;A String&quot;, # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]417 &quot;payload&quot;: True or False, # A Boolean value to indicate whether payload is wanted. Optional.
418 &quot;type&quot;: &quot;A String&quot;, # The type of delivery mechanism used for this channel.
419 &quot;id&quot;: &quot;A String&quot;, # A UUID or similar unique string that identifies this channel.
420 &quot;token&quot;: &quot;A String&quot;, # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
421 &quot;resourceUri&quot;: &quot;A String&quot;, # A version-specific identifier for the watched resource.
422 &quot;expiration&quot;: &quot;A String&quot;, # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]423 &quot;params&quot;: { # Additional parameters controlling delivery channel behavior. Optional.
424 &quot;a_key&quot;: &quot;A String&quot;, # Declares a new parameter by name.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]425 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]426 &quot;address&quot;: &quot;A String&quot;, # The address where notifications are delivered for this channel.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]427 }</pre>
428</div>
429
430</body></html>