Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b6971b0405ba59d905b84fa5fc8e27e12d29b70c / . / docs / dyn / calendar_v3.calendars.html
blob: 5fa5296c5ab1d7013d85091482a22728aef0e0e2 [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.calendars.html">calendars</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#clear">clear(calendarId)</a></code></p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]79<p class="firstline">Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]80<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]81 <code><a href="#close">close()</a></code></p>
82<p class="firstline">Close httplib2 connections.</p>
83<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]84 <code><a href="#delete">delete(calendarId)</a></code></p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]85<p class="firstline">Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]86<p class="toc_element">
87 <code><a href="#get">get(calendarId)</a></code></p>
88<p class="firstline">Returns metadata for a calendar.</p>
89<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]90 <code><a href="#insert">insert(body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]91<p class="firstline">Creates a secondary calendar.</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]93 <code><a href="#patch">patch(calendarId, body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]94<p class="firstline">Updates metadata for a calendar. 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, body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]97<p class="firstline">Updates metadata for a calendar.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="clear">clear(calendarId)</code>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]101 <pre>Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]102
103Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]104 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]105</pre>
106</div>
107
108<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]109 <code class="details" id="close">close()</code>
110 <pre>Close httplib2 connections.</pre>
111</div>
112
113<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]114 <code class="details" id="delete">delete(calendarId)</code>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]115 <pre>Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]116
117Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]118 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]119</pre>
120</div>
121
122<div class="method">
123 <code class="details" id="get">get(calendarId)</code>
124 <pre>Returns metadata for a calendar.
125
126Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]127 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]128
129Returns:
130 An object of the form:
131
132 {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]133 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
134 &quot;location&quot;: &quot;A String&quot;, # Geographic location of the calendar as free-form text. Optional.
135 &quot;summary&quot;: &quot;A String&quot;, # Title of the calendar.
136 &quot;conferenceProperties&quot;: { # Conferencing properties for this calendar, for example what types of conferences are allowed.
137 &quot;allowedConferenceSolutionTypes&quot;: [ # The types of conference solutions that are supported for this calendar.
138 # The possible values are:
139 # - &quot;eventHangout&quot;
140 # - &quot;eventNamedHangout&quot;
141 # - &quot;hangoutsMeet&quot; Optional.
142 &quot;A String&quot;,
143 ],
144 },
145 &quot;timeZone&quot;: &quot;A String&quot;, # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. &quot;Europe/Zurich&quot;.) Optional.
146 &quot;kind&quot;: &quot;calendar#calendar&quot;, # Type of the resource (&quot;calendar#calendar&quot;).
147 &quot;description&quot;: &quot;A String&quot;, # Description of the calendar. Optional.
148 &quot;id&quot;: &quot;A String&quot;, # Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
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(body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]154 <pre>Creates a secondary calendar.
155
156Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]157 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]158 The object takes the form of:
159
160{
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]161 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
162 &quot;location&quot;: &quot;A String&quot;, # Geographic location of the calendar as free-form text. Optional.
163 &quot;summary&quot;: &quot;A String&quot;, # Title of the calendar.
164 &quot;conferenceProperties&quot;: { # Conferencing properties for this calendar, for example what types of conferences are allowed.
165 &quot;allowedConferenceSolutionTypes&quot;: [ # The types of conference solutions that are supported for this calendar.
166 # The possible values are:
167 # - &quot;eventHangout&quot;
168 # - &quot;eventNamedHangout&quot;
169 # - &quot;hangoutsMeet&quot; Optional.
170 &quot;A String&quot;,
171 ],
172 },
173 &quot;timeZone&quot;: &quot;A String&quot;, # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. &quot;Europe/Zurich&quot;.) Optional.
174 &quot;kind&quot;: &quot;calendar#calendar&quot;, # Type of the resource (&quot;calendar#calendar&quot;).
175 &quot;description&quot;: &quot;A String&quot;, # Description of the calendar. Optional.
176 &quot;id&quot;: &quot;A String&quot;, # Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
177}
178
179
180Returns:
181 An object of the form:
182
183 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]184 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
185 &quot;location&quot;: &quot;A String&quot;, # Geographic location of the calendar as free-form text. Optional.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]186 &quot;summary&quot;: &quot;A String&quot;, # Title of the calendar.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]187 &quot;conferenceProperties&quot;: { # Conferencing properties for this calendar, for example what types of conferences are allowed.
188 &quot;allowedConferenceSolutionTypes&quot;: [ # The types of conference solutions that are supported for this calendar.
189 # The possible values are:
190 # - &quot;eventHangout&quot;
191 # - &quot;eventNamedHangout&quot;
192 # - &quot;hangoutsMeet&quot; Optional.
193 &quot;A String&quot;,
194 ],
195 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]196 &quot;timeZone&quot;: &quot;A String&quot;, # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. &quot;Europe/Zurich&quot;.) Optional.
197 &quot;kind&quot;: &quot;calendar#calendar&quot;, # Type of the resource (&quot;calendar#calendar&quot;).
198 &quot;description&quot;: &quot;A String&quot;, # Description of the calendar. Optional.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]199 &quot;id&quot;: &quot;A String&quot;, # Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]200 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]201</div>
202
203<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]204 <code class="details" id="patch">patch(calendarId, body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]205 <pre>Updates metadata for a calendar. This method supports patch semantics.
206
207Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]208 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]209 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]210 The object takes the form of:
211
212{
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]213 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
214 &quot;location&quot;: &quot;A String&quot;, # Geographic location of the calendar as free-form text. Optional.
215 &quot;summary&quot;: &quot;A String&quot;, # Title of the calendar.
216 &quot;conferenceProperties&quot;: { # Conferencing properties for this calendar, for example what types of conferences are allowed.
217 &quot;allowedConferenceSolutionTypes&quot;: [ # The types of conference solutions that are supported for this calendar.
218 # The possible values are:
219 # - &quot;eventHangout&quot;
220 # - &quot;eventNamedHangout&quot;
221 # - &quot;hangoutsMeet&quot; Optional.
222 &quot;A String&quot;,
223 ],
224 },
225 &quot;timeZone&quot;: &quot;A String&quot;, # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. &quot;Europe/Zurich&quot;.) Optional.
226 &quot;kind&quot;: &quot;calendar#calendar&quot;, # Type of the resource (&quot;calendar#calendar&quot;).
227 &quot;description&quot;: &quot;A String&quot;, # Description of the calendar. Optional.
228 &quot;id&quot;: &quot;A String&quot;, # Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
229}
230
231
232Returns:
233 An object of the form:
234
235 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]236 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
237 &quot;location&quot;: &quot;A String&quot;, # Geographic location of the calendar as free-form text. Optional.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]238 &quot;summary&quot;: &quot;A String&quot;, # Title of the calendar.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]239 &quot;conferenceProperties&quot;: { # Conferencing properties for this calendar, for example what types of conferences are allowed.
240 &quot;allowedConferenceSolutionTypes&quot;: [ # The types of conference solutions that are supported for this calendar.
241 # The possible values are:
242 # - &quot;eventHangout&quot;
243 # - &quot;eventNamedHangout&quot;
244 # - &quot;hangoutsMeet&quot; Optional.
245 &quot;A String&quot;,
246 ],
247 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]248 &quot;timeZone&quot;: &quot;A String&quot;, # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. &quot;Europe/Zurich&quot;.) Optional.
249 &quot;kind&quot;: &quot;calendar#calendar&quot;, # Type of the resource (&quot;calendar#calendar&quot;).
250 &quot;description&quot;: &quot;A String&quot;, # Description of the calendar. Optional.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]251 &quot;id&quot;: &quot;A String&quot;, # Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]252 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]253</div>
254
255<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]256 <code class="details" id="update">update(calendarId, body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]257 <pre>Updates metadata for a calendar.
258
259Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]260 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]261 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]262 The object takes the form of:
263
264{
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]265 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
266 &quot;location&quot;: &quot;A String&quot;, # Geographic location of the calendar as free-form text. Optional.
267 &quot;summary&quot;: &quot;A String&quot;, # Title of the calendar.
268 &quot;conferenceProperties&quot;: { # Conferencing properties for this calendar, for example what types of conferences are allowed.
269 &quot;allowedConferenceSolutionTypes&quot;: [ # The types of conference solutions that are supported for this calendar.
270 # The possible values are:
271 # - &quot;eventHangout&quot;
272 # - &quot;eventNamedHangout&quot;
273 # - &quot;hangoutsMeet&quot; Optional.
274 &quot;A String&quot;,
275 ],
276 },
277 &quot;timeZone&quot;: &quot;A String&quot;, # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. &quot;Europe/Zurich&quot;.) Optional.
278 &quot;kind&quot;: &quot;calendar#calendar&quot;, # Type of the resource (&quot;calendar#calendar&quot;).
279 &quot;description&quot;: &quot;A String&quot;, # Description of the calendar. Optional.
280 &quot;id&quot;: &quot;A String&quot;, # Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
281}
282
283
284Returns:
285 An object of the form:
286
287 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]288 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
289 &quot;location&quot;: &quot;A String&quot;, # Geographic location of the calendar as free-form text. Optional.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]290 &quot;summary&quot;: &quot;A String&quot;, # Title of the calendar.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]291 &quot;conferenceProperties&quot;: { # Conferencing properties for this calendar, for example what types of conferences are allowed.
292 &quot;allowedConferenceSolutionTypes&quot;: [ # The types of conference solutions that are supported for this calendar.
293 # The possible values are:
294 # - &quot;eventHangout&quot;
295 # - &quot;eventNamedHangout&quot;
296 # - &quot;hangoutsMeet&quot; Optional.
297 &quot;A String&quot;,
298 ],
299 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]300 &quot;timeZone&quot;: &quot;A String&quot;, # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. &quot;Europe/Zurich&quot;.) Optional.
301 &quot;kind&quot;: &quot;calendar#calendar&quot;, # Type of the resource (&quot;calendar#calendar&quot;).
302 &quot;description&quot;: &quot;A String&quot;, # Description of the calendar. Optional.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]303 &quot;id&quot;: &quot;A String&quot;, # Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]304 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]305</div>
306
307</body></html>