Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 8045c4550a7f366dd071a6ffb27dba362e59bf95 / . / docs / dyn / calendar_v3.acl.html
blob: 6b220302af795a2746ef0dd8d4a01eaf9cc007b3 [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">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]90 <code><a href="#list">list(calendarId, maxResults=None, pageToken=None, showDeleted=None, syncToken=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">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]102 <code><a href="#watch">watch(calendarId, body=None, maxResults=None, pageToken=None, showDeleted=None, syncToken=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 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]132 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]133 &quot;id&quot;: &quot;A String&quot;, # Identifier of the Access Control List (ACL) rule. See Sharing calendars.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]134 &quot;kind&quot;: &quot;calendar#aclRule&quot;, # Type of the resource (&quot;calendar#aclRule&quot;).
135 &quot;role&quot;: &quot;A String&quot;, # The role assigned to the scope. Possible values are:
136 # - &quot;none&quot; - Provides no access.
137 # - &quot;freeBusyReader&quot; - Provides read access to free/busy information.
138 # - &quot;reader&quot; - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
139 # - &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.
140 # - &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.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]141 &quot;scope&quot;: { # The extent to which calendar access is granted by this ACL rule.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]142 &quot;type&quot;: &quot;A String&quot;, # The type of the scope. Possible values are:
143 # - &quot;default&quot; - The public scope. This is the default value.
144 # - &quot;user&quot; - Limits the scope to a single user.
145 # - &quot;group&quot; - Limits the scope to a group.
146 # - &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.
147 &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;.
148 },
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{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]162 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]163 &quot;id&quot;: &quot;A String&quot;, # Identifier of the Access Control List (ACL) rule. See Sharing calendars.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]164 &quot;kind&quot;: &quot;calendar#aclRule&quot;, # Type of the resource (&quot;calendar#aclRule&quot;).
165 &quot;role&quot;: &quot;A String&quot;, # The role assigned to the scope. Possible values are:
166 # - &quot;none&quot; - Provides no access.
167 # - &quot;freeBusyReader&quot; - Provides read access to free/busy information.
168 # - &quot;reader&quot; - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
169 # - &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.
170 # - &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.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]171 &quot;scope&quot;: { # The extent to which calendar access is granted by this ACL rule.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]172 &quot;type&quot;: &quot;A String&quot;, # The type of the scope. Possible values are:
173 # - &quot;default&quot; - The public scope. This is the default value.
174 # - &quot;user&quot; - Limits the scope to a single user.
175 # - &quot;group&quot; - Limits the scope to a group.
176 # - &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.
177 &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;.
178 },
179}
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]180
181 sendNotifications: boolean, Whether to send notifications about the calendar sharing change. Optional. The default is True.
182
183Returns:
184 An object of the form:
185
186 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]187 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]188 &quot;id&quot;: &quot;A String&quot;, # Identifier of the Access Control List (ACL) rule. See Sharing calendars.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]189 &quot;kind&quot;: &quot;calendar#aclRule&quot;, # Type of the resource (&quot;calendar#aclRule&quot;).
190 &quot;role&quot;: &quot;A String&quot;, # The role assigned to the scope. Possible values are:
191 # - &quot;none&quot; - Provides no access.
192 # - &quot;freeBusyReader&quot; - Provides read access to free/busy information.
193 # - &quot;reader&quot; - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
194 # - &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.
195 # - &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.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]196 &quot;scope&quot;: { # The extent to which calendar access is granted by this ACL rule.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]197 &quot;type&quot;: &quot;A String&quot;, # The type of the scope. Possible values are:
198 # - &quot;default&quot; - The public scope. This is the default value.
199 # - &quot;user&quot; - Limits the scope to a single user.
200 # - &quot;group&quot; - Limits the scope to a group.
201 # - &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.
202 &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;.
203 },
204}</pre>
205</div>
206
207<div class="method">
208 <code class="details" id="list">list(calendarId, maxResults=None, pageToken=None, showDeleted=None, syncToken=None)</code>
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)
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.
214 pageToken: string, Token specifying which result page to return. Optional.
215 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.
216 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.
217If 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.
218Learn more about incremental synchronization.
219Optional. The default is to return all entries.
220
221Returns:
222 An object of the form:
223
224 {
225 &quot;etag&quot;: &quot;A String&quot;, # ETag of the collection.
226 &quot;items&quot;: [ # List of rules on the access control list.
227 {
228 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]229 &quot;id&quot;: &quot;A String&quot;, # Identifier of the Access Control List (ACL) rule. See Sharing calendars.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]230 &quot;kind&quot;: &quot;calendar#aclRule&quot;, # Type of the resource (&quot;calendar#aclRule&quot;).
231 &quot;role&quot;: &quot;A String&quot;, # The role assigned to the scope. Possible values are:
232 # - &quot;none&quot; - Provides no access.
233 # - &quot;freeBusyReader&quot; - Provides read access to free/busy information.
234 # - &quot;reader&quot; - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
235 # - &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.
236 # - &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.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]237 &quot;scope&quot;: { # The extent to which calendar access is granted by this ACL rule.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]238 &quot;type&quot;: &quot;A String&quot;, # The type of the scope. Possible values are:
239 # - &quot;default&quot; - The public scope. This is the default value.
240 # - &quot;user&quot; - Limits the scope to a single user.
241 # - &quot;group&quot; - Limits the scope to a group.
242 # - &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.
243 &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;.
244 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]245 },
246 ],
247 &quot;kind&quot;: &quot;calendar#acl&quot;, # Type of the collection (&quot;calendar#acl&quot;).
248 &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.
249 &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.
250}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]278 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]279 &quot;id&quot;: &quot;A String&quot;, # Identifier of the Access Control List (ACL) rule. See Sharing calendars.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]280 &quot;kind&quot;: &quot;calendar#aclRule&quot;, # Type of the resource (&quot;calendar#aclRule&quot;).
281 &quot;role&quot;: &quot;A String&quot;, # The role assigned to the scope. Possible values are:
282 # - &quot;none&quot; - Provides no access.
283 # - &quot;freeBusyReader&quot; - Provides read access to free/busy information.
284 # - &quot;reader&quot; - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
285 # - &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.
286 # - &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.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]287 &quot;scope&quot;: { # The extent to which calendar access is granted by this ACL rule.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]288 &quot;type&quot;: &quot;A String&quot;, # The type of the scope. Possible values are:
289 # - &quot;default&quot; - The public scope. This is the default value.
290 # - &quot;user&quot; - Limits the scope to a single user.
291 # - &quot;group&quot; - Limits the scope to a group.
292 # - &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.
293 &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;.
294 },
295}
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]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 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]303 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]304 &quot;id&quot;: &quot;A String&quot;, # Identifier of the Access Control List (ACL) rule. See Sharing calendars.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]305 &quot;kind&quot;: &quot;calendar#aclRule&quot;, # Type of the resource (&quot;calendar#aclRule&quot;).
306 &quot;role&quot;: &quot;A String&quot;, # The role assigned to the scope. Possible values are:
307 # - &quot;none&quot; - Provides no access.
308 # - &quot;freeBusyReader&quot; - Provides read access to free/busy information.
309 # - &quot;reader&quot; - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
310 # - &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.
311 # - &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.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]312 &quot;scope&quot;: { # The extent to which calendar access is granted by this ACL rule.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]313 &quot;type&quot;: &quot;A String&quot;, # The type of the scope. Possible values are:
314 # - &quot;default&quot; - The public scope. This is the default value.
315 # - &quot;user&quot; - Limits the scope to a single user.
316 # - &quot;group&quot; - Limits the scope to a group.
317 # - &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.
318 &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;.
319 },
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{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]334 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]335 &quot;id&quot;: &quot;A String&quot;, # Identifier of the Access Control List (ACL) rule. See Sharing calendars.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]336 &quot;kind&quot;: &quot;calendar#aclRule&quot;, # Type of the resource (&quot;calendar#aclRule&quot;).
337 &quot;role&quot;: &quot;A String&quot;, # The role assigned to the scope. Possible values are:
338 # - &quot;none&quot; - Provides no access.
339 # - &quot;freeBusyReader&quot; - Provides read access to free/busy information.
340 # - &quot;reader&quot; - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
341 # - &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.
342 # - &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.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]343 &quot;scope&quot;: { # The extent to which calendar access is granted by this ACL rule.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]344 &quot;type&quot;: &quot;A String&quot;, # The type of the scope. Possible values are:
345 # - &quot;default&quot; - The public scope. This is the default value.
346 # - &quot;user&quot; - Limits the scope to a single user.
347 # - &quot;group&quot; - Limits the scope to a group.
348 # - &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.
349 &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;.
350 },
351}
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]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 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]359 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]360 &quot;id&quot;: &quot;A String&quot;, # Identifier of the Access Control List (ACL) rule. See Sharing calendars.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]361 &quot;kind&quot;: &quot;calendar#aclRule&quot;, # Type of the resource (&quot;calendar#aclRule&quot;).
362 &quot;role&quot;: &quot;A String&quot;, # The role assigned to the scope. Possible values are:
363 # - &quot;none&quot; - Provides no access.
364 # - &quot;freeBusyReader&quot; - Provides read access to free/busy information.
365 # - &quot;reader&quot; - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
366 # - &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.
367 # - &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.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]368 &quot;scope&quot;: { # The extent to which calendar access is granted by this ACL rule.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]369 &quot;type&quot;: &quot;A String&quot;, # The type of the scope. Possible values are:
370 # - &quot;default&quot; - The public scope. This is the default value.
371 # - &quot;user&quot; - Limits the scope to a single user.
372 # - &quot;group&quot; - Limits the scope to a group.
373 # - &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.
374 &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;.
375 },
376}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]377</div>
378
379<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]380 <code class="details" id="watch">watch(calendarId, body=None, maxResults=None, pageToken=None, showDeleted=None, syncToken=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{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]389 &quot;address&quot;: &quot;A String&quot;, # The address where notifications are delivered for this channel.
390 &quot;expiration&quot;: &quot;A String&quot;, # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
391 &quot;id&quot;: &quot;A String&quot;, # A UUID or similar unique string that identifies this channel.
392 &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;.
393 &quot;params&quot;: { # Additional parameters controlling delivery channel behavior. Optional.
394 &quot;a_key&quot;: &quot;A String&quot;, # Declares a new parameter by name.
395 },
396 &quot;payload&quot;: True or False, # A Boolean value to indicate whether payload is wanted. Optional.
397 &quot;resourceId&quot;: &quot;A String&quot;, # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
398 &quot;resourceUri&quot;: &quot;A String&quot;, # A version-specific identifier for the watched resource.
399 &quot;token&quot;: &quot;A String&quot;, # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]400 &quot;type&quot;: &quot;A String&quot;, # The type of delivery mechanism used for this channel. Valid values are &quot;web_hook&quot; (or &quot;webhook&quot;). Both values refer to a channel where Http requests are used to deliver messages.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]401}
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]402
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]404 pageToken: string, Token specifying which result page to return. Optional.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]405 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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]406 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.
407If 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.
408Learn more about incremental synchronization.
409Optional. The default is to return all entries.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]410
411Returns:
412 An object of the form:
413
414 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]415 &quot;address&quot;: &quot;A String&quot;, # The address where notifications are delivered for this channel.
416 &quot;expiration&quot;: &quot;A String&quot;, # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
417 &quot;id&quot;: &quot;A String&quot;, # A UUID or similar unique string that identifies this channel.
418 &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;.
419 &quot;params&quot;: { # Additional parameters controlling delivery channel behavior. Optional.
420 &quot;a_key&quot;: &quot;A String&quot;, # Declares a new parameter by name.
421 },
422 &quot;payload&quot;: True or False, # A Boolean value to indicate whether payload is wanted. Optional.
423 &quot;resourceId&quot;: &quot;A String&quot;, # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
424 &quot;resourceUri&quot;: &quot;A String&quot;, # A version-specific identifier for the watched resource.
425 &quot;token&quot;: &quot;A String&quot;, # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]426 &quot;type&quot;: &quot;A String&quot;, # The type of delivery mechanism used for this channel. Valid values are &quot;web_hook&quot; (or &quot;webhook&quot;). Both values refer to a channel where Http requests are used to deliver messages.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]427}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]428</div>
429
430</body></html>