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