Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / calendar_v3.acl.html
blob: 3cae543f144c447d0140cd84a2bb2185b1a43ba8 [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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]84 <code><a href="#insert">insert(calendarId, body=None, sendNotifications=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]93 <code><a href="#patch">patch(calendarId, ruleId, body=None, sendNotifications=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]94<p class="firstline">Updates an access control rule. This method supports patch semantics.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]96 <code><a href="#update">update(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.</p>
98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]99 <code><a href="#watch">watch(calendarId, body=None, syncToken=None, pageToken=None, maxResults=None, showDeleted=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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:
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]107 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)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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:
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]117 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)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]145 <code class="details" id="insert">insert(calendarId, body=None, sendNotifications=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]146 <pre>Creates an access control rule.
147
148Args:
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]149 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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]150 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]173 sendNotifications: boolean, Whether to send notifications about the calendar sharing change. Optional. The default is True.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]174
175Returns:
176 An object of the form:
177
178 {
179 "scope": { # The scope of the rule.
180 "type": "A String", # The type of the scope. Possible values are:
181 # - "default" - The public scope. This is the default value.
182 # - "user" - Limits the scope to a single user.
183 # - "group" - Limits the scope to a group.
184 # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
185 "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".
186 },
187 "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
188 "etag": "A String", # ETag of the resource.
189 "role": "A String", # The role assigned to the scope. Possible values are:
190 # - "none" - Provides no access.
191 # - "freeBusyReader" - Provides read access to free/busy information.
192 # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
193 # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
194 # - "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.
195 "id": "A String", # Identifier of the ACL rule.
196 }</pre>
197</div>
198
199<div class="method">
200 <code class="details" id="list">list(calendarId, syncToken=None, pageToken=None, maxResults=None, showDeleted=None)</code>
201 <pre>Returns the rules in the access control list for the calendar.
202
203Args:
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]204 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)
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]205 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.
206If 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.
207Learn more about incremental synchronization.
208Optional. The default is to return all entries.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]209 pageToken: string, Token specifying which result page to return. Optional.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]210 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.
211 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]212
213Returns:
214 An object of the form:
215
216 {
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]217 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]218 "items": [ # List of rules on the access control list.
219 {
220 "scope": { # The scope of the rule.
221 "type": "A String", # The type of the scope. Possible values are:
222 # - "default" - The public scope. This is the default value.
223 # - "user" - Limits the scope to a single user.
224 # - "group" - Limits the scope to a group.
225 # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
226 "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".
227 },
228 "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
229 "etag": "A String", # ETag of the resource.
230 "role": "A String", # The role assigned to the scope. Possible values are:
231 # - "none" - Provides no access.
232 # - "freeBusyReader" - Provides read access to free/busy information.
233 # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
234 # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
235 # - "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.
236 "id": "A String", # Identifier of the ACL rule.
237 },
238 ],
239 "kind": "calendar#acl", # Type of the collection ("calendar#acl").
240 "etag": "A String", # ETag of the collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]241 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]242 }</pre>
243</div>
244
245<div class="method">
246 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
247 <pre>Retrieves the next page of results.
248
249Args:
250 previous_request: The request for the previous page. (required)
251 previous_response: The response from the request for the previous page. (required)
252
253Returns:
254 A request object that you can call 'execute()' on to request the next
255 page. Returns None if there are no more items in the collection.
256 </pre>
257</div>
258
259<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]260 <code class="details" id="patch">patch(calendarId, ruleId, body=None, sendNotifications=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]261 <pre>Updates an access control rule. This method supports patch semantics.
262
263Args:
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]264 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)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]265 ruleId: string, ACL rule identifier. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]266 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]267 The object takes the form of:
268
269{
270 "scope": { # The scope of the rule.
271 "type": "A String", # The type of the scope. Possible values are:
272 # - "default" - The public scope. This is the default value.
273 # - "user" - Limits the scope to a single user.
274 # - "group" - Limits the scope to a group.
275 # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
276 "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".
277 },
278 "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
279 "etag": "A String", # ETag of the resource.
280 "role": "A String", # The role assigned to the scope. Possible values are:
281 # - "none" - Provides no access.
282 # - "freeBusyReader" - Provides read access to free/busy information.
283 # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
284 # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
285 # - "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.
286 "id": "A String", # Identifier of the ACL rule.
287 }
288
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]289 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]290
291Returns:
292 An object of the form:
293
294 {
295 "scope": { # The scope of the rule.
296 "type": "A String", # The type of the scope. Possible values are:
297 # - "default" - The public scope. This is the default value.
298 # - "user" - Limits the scope to a single user.
299 # - "group" - Limits the scope to a group.
300 # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
301 "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".
302 },
303 "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
304 "etag": "A String", # ETag of the resource.
305 "role": "A String", # The role assigned to the scope. Possible values are:
306 # - "none" - Provides no access.
307 # - "freeBusyReader" - Provides read access to free/busy information.
308 # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
309 # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
310 # - "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.
311 "id": "A String", # Identifier of the ACL rule.
312 }</pre>
313</div>
314
315<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]316 <code class="details" id="update">update(calendarId, ruleId, body=None, sendNotifications=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]317 <pre>Updates an access control rule.
318
319Args:
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]320 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)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]321 ruleId: string, ACL rule identifier. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]322 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]323 The object takes the form of:
324
325{
326 "scope": { # The scope of the rule.
327 "type": "A String", # The type of the scope. Possible values are:
328 # - "default" - The public scope. This is the default value.
329 # - "user" - Limits the scope to a single user.
330 # - "group" - Limits the scope to a group.
331 # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
332 "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".
333 },
334 "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
335 "etag": "A String", # ETag of the resource.
336 "role": "A String", # The role assigned to the scope. Possible values are:
337 # - "none" - Provides no access.
338 # - "freeBusyReader" - Provides read access to free/busy information.
339 # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
340 # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
341 # - "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.
342 "id": "A String", # Identifier of the ACL rule.
343 }
344
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]345 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]346
347Returns:
348 An object of the form:
349
350 {
351 "scope": { # The scope of the rule.
352 "type": "A String", # The type of the scope. Possible values are:
353 # - "default" - The public scope. This is the default value.
354 # - "user" - Limits the scope to a single user.
355 # - "group" - Limits the scope to a group.
356 # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
357 "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".
358 },
359 "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
360 "etag": "A String", # ETag of the resource.
361 "role": "A String", # The role assigned to the scope. Possible values are:
362 # - "none" - Provides no access.
363 # - "freeBusyReader" - Provides read access to free/busy information.
364 # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
365 # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
366 # - "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.
367 "id": "A String", # Identifier of the ACL rule.
368 }</pre>
369</div>
370
371<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]372 <code class="details" id="watch">watch(calendarId, body=None, syncToken=None, pageToken=None, maxResults=None, showDeleted=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]373 <pre>Watch for changes to ACL resources.
374
375Args:
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]376 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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]377 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]378 The object takes the form of:
379
380{
381 "resourceUri": "A String", # A version-specific identifier for the watched resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]382 "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]383 "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
384 "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
385 "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
386 "params": { # Additional parameters controlling delivery channel behavior. Optional.
387 "a_key": "A String", # Declares a new parameter by name.
388 },
389 "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
390 "address": "A String", # The address where notifications are delivered for this channel.
391 "type": "A String", # The type of delivery mechanism used for this channel.
392 "id": "A String", # A UUID or similar unique string that identifies this channel.
393 }
394
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]395 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.
396If 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.
397Learn more about incremental synchronization.
398Optional. The default is to return all entries.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]399 pageToken: string, Token specifying which result page to return. Optional.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]400 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.
401 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]402
403Returns:
404 An object of the form:
405
406 {
407 "resourceUri": "A String", # A version-specific identifier for the watched resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]408 "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]409 "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
410 "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
411 "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
412 "params": { # Additional parameters controlling delivery channel behavior. Optional.
413 "a_key": "A String", # Declares a new parameter by name.
414 },
415 "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
416 "address": "A String", # The address where notifications are delivered for this channel.
417 "type": "A String", # The type of delivery mechanism used for this channel.
418 "id": "A String", # A UUID or similar unique string that identifies this channel.
419 }</pre>
420</div>
421
422</body></html>