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