1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="calendar_v3.html">Calendar API</a> . <a href="calendar_v3.acl.html">acl</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#delete">delete(calendarId, ruleId)</a></code></p>
<p class="firstline">Deletes an access control rule.</p>
<p class="toc_element">
<code><a href="#get">get(calendarId, ruleId)</a></code></p>
<p class="firstline">Returns an access control rule.</p>
<p class="toc_element">
<code><a href="#insert">insert(calendarId, body=None, sendNotifications=None)</a></code></p>
<p class="firstline">Creates an access control rule.</p>
<p class="toc_element">
<code><a href="#list">list(calendarId, maxResults=None, pageToken=None, showDeleted=None, syncToken=None)</a></code></p>
<p class="firstline">Returns the rules in the access control list for the calendar.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(calendarId, ruleId, body=None, sendNotifications=None)</a></code></p>
<p class="firstline">Updates an access control rule. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(calendarId, ruleId, body=None, sendNotifications=None)</a></code></p>
<p class="firstline">Updates an access control rule.</p>
<p class="toc_element">
<code><a href="#watch">watch(calendarId, body=None, maxResults=None, pageToken=None, showDeleted=None, syncToken=None)</a></code></p>
<p class="firstline">Watch for changes to ACL resources.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(calendarId, ruleId)</code>
<pre>Deletes an access control rule.
Args:
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 "primary" keyword. (required)
ruleId: string, ACL rule identifier. (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(calendarId, ruleId)</code>
<pre>Returns an access control rule.
Args:
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 "primary" keyword. (required)
ruleId: string, ACL rule identifier. (required)
Returns:
An object of the form:
{
"etag": "A String", # ETag of the resource.
"id": "A String", # Identifier of the Access Control List (ACL) rule. See Sharing calendars.
"kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
"role": "A String", # The role assigned to the scope. Possible values are:
# - "none" - Provides no access.
# - "freeBusyReader" - Provides read access to free/busy information.
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. Provides read access to the calendar's ACLs.
# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to manipulate ACLs.
"scope": { # The extent to which calendar access is granted by this ACL rule.
"type": "A String", # The type of the scope. Possible values are:
# - "default" - The public scope. This is the default value.
# - "user" - Limits the scope to a single user.
# - "group" - Limits the scope to a group.
# - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
},
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(calendarId, body=None, sendNotifications=None)</code>
<pre>Creates an access control rule.
Args:
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 "primary" keyword. (required)
body: object, The request body.
The object takes the form of:
{
"etag": "A String", # ETag of the resource.
"id": "A String", # Identifier of the Access Control List (ACL) rule. See Sharing calendars.
"kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
"role": "A String", # The role assigned to the scope. Possible values are:
# - "none" - Provides no access.
# - "freeBusyReader" - Provides read access to free/busy information.
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. Provides read access to the calendar's ACLs.
# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to manipulate ACLs.
"scope": { # The extent to which calendar access is granted by this ACL rule.
"type": "A String", # The type of the scope. Possible values are:
# - "default" - The public scope. This is the default value.
# - "user" - Limits the scope to a single user.
# - "group" - Limits the scope to a group.
# - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
},
}
sendNotifications: boolean, Whether to send notifications about the calendar sharing change. Optional. The default is True.
Returns:
An object of the form:
{
"etag": "A String", # ETag of the resource.
"id": "A String", # Identifier of the Access Control List (ACL) rule. See Sharing calendars.
"kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
"role": "A String", # The role assigned to the scope. Possible values are:
# - "none" - Provides no access.
# - "freeBusyReader" - Provides read access to free/busy information.
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. Provides read access to the calendar's ACLs.
# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to manipulate ACLs.
"scope": { # The extent to which calendar access is granted by this ACL rule.
"type": "A String", # The type of the scope. Possible values are:
# - "default" - The public scope. This is the default value.
# - "user" - Limits the scope to a single user.
# - "group" - Limits the scope to a group.
# - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(calendarId, maxResults=None, pageToken=None, showDeleted=None, syncToken=None)</code>
<pre>Returns the rules in the access control list for the calendar.
Args:
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 "primary" keyword. (required)
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.
pageToken: string, Token specifying which result page to return. Optional.
showDeleted: boolean, Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.
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.
If 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.
Learn more about incremental synchronization.
Optional. The default is to return all entries.
Returns:
An object of the form:
{
"etag": "A String", # ETag of the collection.
"items": [ # List of rules on the access control list.
{
"etag": "A String", # ETag of the resource.
"id": "A String", # Identifier of the Access Control List (ACL) rule. See Sharing calendars.
"kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
"role": "A String", # The role assigned to the scope. Possible values are:
# - "none" - Provides no access.
# - "freeBusyReader" - Provides read access to free/busy information.
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. Provides read access to the calendar's ACLs.
# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to manipulate ACLs.
"scope": { # The extent to which calendar access is granted by this ACL rule.
"type": "A String", # The type of the scope. Possible values are:
# - "default" - The public scope. This is the default value.
# - "user" - Limits the scope to a single user.
# - "group" - Limits the scope to a group.
# - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
},
},
],
"kind": "calendar#acl", # Type of the collection ("calendar#acl").
"nextPageToken": "A String", # Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
"nextSyncToken": "A String", # 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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(calendarId, ruleId, body=None, sendNotifications=None)</code>
<pre>Updates an access control rule. This method supports patch semantics.
Args:
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 "primary" keyword. (required)
ruleId: string, ACL rule identifier. (required)
body: object, The request body.
The object takes the form of:
{
"etag": "A String", # ETag of the resource.
"id": "A String", # Identifier of the Access Control List (ACL) rule. See Sharing calendars.
"kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
"role": "A String", # The role assigned to the scope. Possible values are:
# - "none" - Provides no access.
# - "freeBusyReader" - Provides read access to free/busy information.
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. Provides read access to the calendar's ACLs.
# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to manipulate ACLs.
"scope": { # The extent to which calendar access is granted by this ACL rule.
"type": "A String", # The type of the scope. Possible values are:
# - "default" - The public scope. This is the default value.
# - "user" - Limits the scope to a single user.
# - "group" - Limits the scope to a group.
# - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
},
}
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.
Returns:
An object of the form:
{
"etag": "A String", # ETag of the resource.
"id": "A String", # Identifier of the Access Control List (ACL) rule. See Sharing calendars.
"kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
"role": "A String", # The role assigned to the scope. Possible values are:
# - "none" - Provides no access.
# - "freeBusyReader" - Provides read access to free/busy information.
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. Provides read access to the calendar's ACLs.
# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to manipulate ACLs.
"scope": { # The extent to which calendar access is granted by this ACL rule.
"type": "A String", # The type of the scope. Possible values are:
# - "default" - The public scope. This is the default value.
# - "user" - Limits the scope to a single user.
# - "group" - Limits the scope to a group.
# - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
},
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(calendarId, ruleId, body=None, sendNotifications=None)</code>
<pre>Updates an access control rule.
Args:
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 "primary" keyword. (required)
ruleId: string, ACL rule identifier. (required)
body: object, The request body.
The object takes the form of:
{
"etag": "A String", # ETag of the resource.
"id": "A String", # Identifier of the Access Control List (ACL) rule. See Sharing calendars.
"kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
"role": "A String", # The role assigned to the scope. Possible values are:
# - "none" - Provides no access.
# - "freeBusyReader" - Provides read access to free/busy information.
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. Provides read access to the calendar's ACLs.
# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to manipulate ACLs.
"scope": { # The extent to which calendar access is granted by this ACL rule.
"type": "A String", # The type of the scope. Possible values are:
# - "default" - The public scope. This is the default value.
# - "user" - Limits the scope to a single user.
# - "group" - Limits the scope to a group.
# - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
},
}
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.
Returns:
An object of the form:
{
"etag": "A String", # ETag of the resource.
"id": "A String", # Identifier of the Access Control List (ACL) rule. See Sharing calendars.
"kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
"role": "A String", # The role assigned to the scope. Possible values are:
# - "none" - Provides no access.
# - "freeBusyReader" - Provides read access to free/busy information.
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. Provides read access to the calendar's ACLs.
# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to manipulate ACLs.
"scope": { # The extent to which calendar access is granted by this ACL rule.
"type": "A String", # The type of the scope. Possible values are:
# - "default" - The public scope. This is the default value.
# - "user" - Limits the scope to a single user.
# - "group" - Limits the scope to a group.
# - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
},
}</pre>
</div>
<div class="method">
<code class="details" id="watch">watch(calendarId, body=None, maxResults=None, pageToken=None, showDeleted=None, syncToken=None)</code>
<pre>Watch for changes to ACL resources.
Args:
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 "primary" keyword. (required)
body: object, The request body.
The object takes the form of:
{
"address": "A String", # The address where notifications are delivered for this channel.
"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
"id": "A String", # A UUID or similar unique string that identifies this channel.
"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
"params": { # Additional parameters controlling delivery channel behavior. Optional.
"a_key": "A String", # Declares a new parameter by name.
},
"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
"resourceUri": "A String", # A version-specific identifier for the watched resource.
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
"type": "A String", # The type of delivery mechanism used for this channel. Valid values are "web_hook" (or "webhook"). Both values refer to a channel where Http requests are used to deliver messages.
}
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.
pageToken: string, Token specifying which result page to return. Optional.
showDeleted: boolean, Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.
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.
If 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.
Learn more about incremental synchronization.
Optional. The default is to return all entries.
Returns:
An object of the form:
{
"address": "A String", # The address where notifications are delivered for this channel.
"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
"id": "A String", # A UUID or similar unique string that identifies this channel.
"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
"params": { # Additional parameters controlling delivery channel behavior. Optional.
"a_key": "A String", # Declares a new parameter by name.
},
"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
"resourceUri": "A String", # A version-specific identifier for the watched resource.
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
"type": "A String", # The type of delivery mechanism used for this channel. Valid values are "web_hook" (or "webhook"). Both values refer to a channel where Http requests are used to deliver messages.
}</pre>
</div>
</body></html>
|
