Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 164f37ed3a7eff3c49c4a3ef0163f5a47f8f8198 / . / docs / dyn / calendar_v3.acl.html
blob: 836a699c8c2bbadea82d9021509cfd491026b314 [file] [log] [blame]
Joe Gregorio075572b2012-07-09 16:53:09 -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)</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="#patch">patch(calendarId, ruleId, body)</a></code></p>
91<p class="firstline">Updates an access control rule. This method supports patch semantics.</p>
92<p class="toc_element">
93 <code><a href="#update">update(calendarId, ruleId, body)</a></code></p>
94<p class="firstline">Updates an access control rule.</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="delete">delete(calendarId, ruleId)</code>
98 <pre>Deletes an access control rule.
99
100Args:
101 calendarId: string, Calendar identifier. (required)
102 ruleId: string, ACL rule identifier. (required)
103</pre>
104</div>
105
106<div class="method">
107 <code class="details" id="get">get(calendarId, ruleId)</code>
108 <pre>Returns an access control rule.
109
110Args:
111 calendarId: string, Calendar identifier. (required)
112 ruleId: string, ACL rule identifier. (required)
113
114Returns:
115 An object of the form:
116
117 {
118 "scope": { # The scope of the rule.
119 "type": "A String", # The type of the scope. Possible values are:
120 # - "default" - The public scope. This is the default value.
121 # - "user" - Limits the scope to a single user.
122 # - "group" - Limits the scope to a group.
123 # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
124 "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".
125 },
126 "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
127 "etag": "A String", # ETag of the resource.
128 "role": "A String", # The role assigned to the scope. Possible values are:
129 # - "none" - Provides no access.
130 # - "freeBusyReader" - Provides read access to free/busy information.
131 # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
132 # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
133 # - "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.
134 "id": "A String", # Identifier of the ACL rule.
135 }</pre>
136</div>
137
138<div class="method">
139 <code class="details" id="insert">insert(calendarId, body)</code>
140 <pre>Creates an access control rule.
141
142Args:
143 calendarId: string, Calendar identifier. (required)
144 body: object, The request body. (required)
145 The object takes the form of:
146
147{
148 "scope": { # The scope of the rule.
149 "type": "A String", # The type of the scope. Possible values are:
150 # - "default" - The public scope. This is the default value.
151 # - "user" - Limits the scope to a single user.
152 # - "group" - Limits the scope to a group.
153 # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
154 "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".
155 },
156 "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
157 "etag": "A String", # ETag of the resource.
158 "role": "A String", # The role assigned to the scope. Possible values are:
159 # - "none" - Provides no access.
160 # - "freeBusyReader" - Provides read access to free/busy information.
161 # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
162 # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
163 # - "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.
164 "id": "A String", # Identifier of the ACL rule.
165 }
166
167
168Returns:
169 An object of the form:
170
171 {
172 "scope": { # The scope of the rule.
173 "type": "A String", # The type of the scope. Possible values are:
174 # - "default" - The public scope. This is the default value.
175 # - "user" - Limits the scope to a single user.
176 # - "group" - Limits the scope to a group.
177 # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
178 "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".
179 },
180 "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
181 "etag": "A String", # ETag of the resource.
182 "role": "A String", # The role assigned to the scope. Possible values are:
183 # - "none" - Provides no access.
184 # - "freeBusyReader" - Provides read access to free/busy information.
185 # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
186 # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
187 # - "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.
188 "id": "A String", # Identifier of the ACL rule.
189 }</pre>
190</div>
191
192<div class="method">
193 <code class="details" id="list">list(calendarId)</code>
194 <pre>Returns the rules in the access control list for the calendar.
195
196Args:
197 calendarId: string, Calendar identifier. (required)
198
199Returns:
200 An object of the form:
201
202 {
203 "nextPageToken": "A String", # Token used to access the next page of this result. Omitted if no further results are available.
204 "items": [ # List of rules on the access control list.
205 {
206 "scope": { # The scope of the rule.
207 "type": "A String", # The type of the scope. Possible values are:
208 # - "default" - The public scope. This is the default value.
209 # - "user" - Limits the scope to a single user.
210 # - "group" - Limits the scope to a group.
211 # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
212 "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".
213 },
214 "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
215 "etag": "A String", # ETag of the resource.
216 "role": "A String", # The role assigned to the scope. Possible values are:
217 # - "none" - Provides no access.
218 # - "freeBusyReader" - Provides read access to free/busy information.
219 # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
220 # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
221 # - "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.
222 "id": "A String", # Identifier of the ACL rule.
223 },
224 ],
225 "kind": "calendar#acl", # Type of the collection ("calendar#acl").
226 "etag": "A String", # ETag of the collection.
227 }</pre>
228</div>
229
230<div class="method">
231 <code class="details" id="patch">patch(calendarId, ruleId, body)</code>
232 <pre>Updates an access control rule. This method supports patch semantics.
233
234Args:
235 calendarId: string, Calendar identifier. (required)
236 ruleId: string, ACL rule identifier. (required)
237 body: object, The request body. (required)
238 The object takes the form of:
239
240{
241 "scope": { # The scope of the rule.
242 "type": "A String", # The type of the scope. Possible values are:
243 # - "default" - The public scope. This is the default value.
244 # - "user" - Limits the scope to a single user.
245 # - "group" - Limits the scope to a group.
246 # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
247 "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".
248 },
249 "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
250 "etag": "A String", # ETag of the resource.
251 "role": "A String", # The role assigned to the scope. Possible values are:
252 # - "none" - Provides no access.
253 # - "freeBusyReader" - Provides read access to free/busy information.
254 # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
255 # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
256 # - "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.
257 "id": "A String", # Identifier of the ACL rule.
258 }
259
260
261Returns:
262 An object of the form:
263
264 {
265 "scope": { # The scope of the rule.
266 "type": "A String", # The type of the scope. Possible values are:
267 # - "default" - The public scope. This is the default value.
268 # - "user" - Limits the scope to a single user.
269 # - "group" - Limits the scope to a group.
270 # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
271 "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".
272 },
273 "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
274 "etag": "A String", # ETag of the resource.
275 "role": "A String", # The role assigned to the scope. Possible values are:
276 # - "none" - Provides no access.
277 # - "freeBusyReader" - Provides read access to free/busy information.
278 # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
279 # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
280 # - "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.
281 "id": "A String", # Identifier of the ACL rule.
282 }</pre>
283</div>
284
285<div class="method">
286 <code class="details" id="update">update(calendarId, ruleId, body)</code>
287 <pre>Updates an access control rule.
288
289Args:
290 calendarId: string, Calendar identifier. (required)
291 ruleId: string, ACL rule identifier. (required)
292 body: object, The request body. (required)
293 The object takes the form of:
294
295{
296 "scope": { # The scope of the rule.
297 "type": "A String", # The type of the scope. Possible values are:
298 # - "default" - The public scope. This is the default value.
299 # - "user" - Limits the scope to a single user.
300 # - "group" - Limits the scope to a group.
301 # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
302 "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".
303 },
304 "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
305 "etag": "A String", # ETag of the resource.
306 "role": "A String", # The role assigned to the scope. Possible values are:
307 # - "none" - Provides no access.
308 # - "freeBusyReader" - Provides read access to free/busy information.
309 # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
310 # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
311 # - "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.
312 "id": "A String", # Identifier of the ACL rule.
313 }
314
315
316Returns:
317 An object of the form:
318
319 {
320 "scope": { # The scope of the rule.
321 "type": "A String", # The type of the scope. Possible values are:
322 # - "default" - The public scope. This is the default value.
323 # - "user" - Limits the scope to a single user.
324 # - "group" - Limits the scope to a group.
325 # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
326 "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".
327 },
328 "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
329 "etag": "A String", # ETag of the resource.
330 "role": "A String", # The role assigned to the scope. Possible values are:
331 # - "none" - Provides no access.
332 # - "freeBusyReader" - Provides read access to free/busy information.
333 # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
334 # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
335 # - "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.
336 "id": "A String", # Identifier of the ACL rule.
337 }</pre>
338</div>
339
340</body></html>