Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / calendar_v3.calendars.html
blob: e949d20853381550d41e92affc1f4d816051e01e [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">
87 <code><a href="#insert">insert(body)</a></code></p>
88<p class="firstline">Creates a secondary calendar.</p>
89<p class="toc_element">
90 <code><a href="#patch">patch(calendarId, body)</a></code></p>
91<p class="firstline">Updates metadata for a calendar. This method supports patch semantics.</p>
92<p class="toc_element">
93 <code><a href="#update">update(calendarId, body)</a></code></p>
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:
Takashi Matsuo06694102015-09-11 13:55:40 -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 "primary" 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:
Takashi Matsuo06694102015-09-11 13:55:40 -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 "primary" 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:
Takashi Matsuo06694102015-09-11 13:55:40 -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 "primary" keyword. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]120
121Returns:
122 An object of the form:
123
124 {
125 "kind": "calendar#calendar", # Type of the resource ("calendar#calendar").
126 "description": "A String", # Description of the calendar. Optional.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]127 "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed.
128 "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar.
129 # The possible values are:
130 # - "eventHangout"
131 # - "eventNamedHangout"
132 # - "hangoutsMeet" Optional.
133 "A String",
134 ],
135 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]136 "summary": "A String", # Title of the calendar.
137 "etag": "A String", # ETag of the resource.
138 "location": "A String", # Geographic location of the calendar as free-form text. Optional.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]139 "timeZone": "A String", # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]140 "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]141 }</pre>
142</div>
143
144<div class="method">
145 <code class="details" id="insert">insert(body)</code>
146 <pre>Creates a secondary calendar.
147
148Args:
149 body: object, The request body. (required)
150 The object takes the form of:
151
152{
153 "kind": "calendar#calendar", # Type of the resource ("calendar#calendar").
154 "description": "A String", # Description of the calendar. Optional.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]155 "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed.
156 "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar.
157 # The possible values are:
158 # - "eventHangout"
159 # - "eventNamedHangout"
160 # - "hangoutsMeet" Optional.
161 "A String",
162 ],
163 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]164 "summary": "A String", # Title of the calendar.
165 "etag": "A String", # ETag of the resource.
166 "location": "A String", # Geographic location of the calendar as free-form text. Optional.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]167 "timeZone": "A String", # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]168 "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]169 }
170
171
172Returns:
173 An object of the form:
174
175 {
176 "kind": "calendar#calendar", # Type of the resource ("calendar#calendar").
177 "description": "A String", # Description of the calendar. Optional.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]178 "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed.
179 "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar.
180 # The possible values are:
181 # - "eventHangout"
182 # - "eventNamedHangout"
183 # - "hangoutsMeet" Optional.
184 "A String",
185 ],
186 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]187 "summary": "A String", # Title of the calendar.
188 "etag": "A String", # ETag of the resource.
189 "location": "A String", # Geographic location of the calendar as free-form text. Optional.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]190 "timeZone": "A String", # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]191 "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]192 }</pre>
193</div>
194
195<div class="method">
196 <code class="details" id="patch">patch(calendarId, body)</code>
197 <pre>Updates metadata for a calendar. This method supports patch semantics.
198
199Args:
Takashi Matsuo06694102015-09-11 13:55:40 -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 "primary" keyword. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]201 body: object, The request body. (required)
202 The object takes the form of:
203
204{
205 "kind": "calendar#calendar", # Type of the resource ("calendar#calendar").
206 "description": "A String", # Description of the calendar. Optional.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]207 "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed.
208 "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar.
209 # The possible values are:
210 # - "eventHangout"
211 # - "eventNamedHangout"
212 # - "hangoutsMeet" Optional.
213 "A String",
214 ],
215 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]216 "summary": "A String", # Title of the calendar.
217 "etag": "A String", # ETag of the resource.
218 "location": "A String", # Geographic location of the calendar as free-form text. Optional.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]219 "timeZone": "A String", # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]220 "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]221 }
222
223
224Returns:
225 An object of the form:
226
227 {
228 "kind": "calendar#calendar", # Type of the resource ("calendar#calendar").
229 "description": "A String", # Description of the calendar. Optional.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]230 "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed.
231 "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar.
232 # The possible values are:
233 # - "eventHangout"
234 # - "eventNamedHangout"
235 # - "hangoutsMeet" Optional.
236 "A String",
237 ],
238 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]239 "summary": "A String", # Title of the calendar.
240 "etag": "A String", # ETag of the resource.
241 "location": "A String", # Geographic location of the calendar as free-form text. Optional.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]242 "timeZone": "A String", # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]243 "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]244 }</pre>
245</div>
246
247<div class="method">
248 <code class="details" id="update">update(calendarId, body)</code>
249 <pre>Updates metadata for a calendar.
250
251Args:
Takashi Matsuo06694102015-09-11 13:55:40 -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 "primary" keyword. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]253 body: object, The request body. (required)
254 The object takes the form of:
255
256{
257 "kind": "calendar#calendar", # Type of the resource ("calendar#calendar").
258 "description": "A String", # Description of the calendar. Optional.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]259 "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed.
260 "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar.
261 # The possible values are:
262 # - "eventHangout"
263 # - "eventNamedHangout"
264 # - "hangoutsMeet" Optional.
265 "A String",
266 ],
267 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]268 "summary": "A String", # Title of the calendar.
269 "etag": "A String", # ETag of the resource.
270 "location": "A String", # Geographic location of the calendar as free-form text. Optional.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]271 "timeZone": "A String", # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]272 "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]273 }
274
275
276Returns:
277 An object of the form:
278
279 {
280 "kind": "calendar#calendar", # Type of the resource ("calendar#calendar").
281 "description": "A String", # Description of the calendar. Optional.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]282 "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed.
283 "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar.
284 # The possible values are:
285 # - "eventHangout"
286 # - "eventNamedHangout"
287 # - "hangoutsMeet" Optional.
288 "A String",
289 ],
290 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]291 "summary": "A String", # Title of the calendar.
292 "etag": "A String", # ETag of the resource.
293 "location": "A String", # Geographic location of the calendar as free-form text. Optional.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]294 "timeZone": "A String", # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]295 "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]296 }</pre>
297</div>
298
299</body></html>