Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 98b51f044ede8b9b24e584ab9680e3f35f4bd469 / . / docs / dyn / calendar_v3.calendars.html
blob: 2c6b0771d852844ff47e4dbfb3554e6f836b983d [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.
127 "summary": "A String", # Title of the calendar.
128 "etag": "A String", # ETag of the resource.
129 "location": "A String", # Geographic location of the calendar as free-form text. Optional.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]130 "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]131 "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]132 }</pre>
133</div>
134
135<div class="method">
136 <code class="details" id="insert">insert(body)</code>
137 <pre>Creates a secondary calendar.
138
139Args:
140 body: object, The request body. (required)
141 The object takes the form of:
142
143{
144 "kind": "calendar#calendar", # Type of the resource ("calendar#calendar").
145 "description": "A String", # Description of the calendar. Optional.
146 "summary": "A String", # Title of the calendar.
147 "etag": "A String", # ETag of the resource.
148 "location": "A String", # Geographic location of the calendar as free-form text. Optional.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]149 "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]150 "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]151 }
152
153
154Returns:
155 An object of the form:
156
157 {
158 "kind": "calendar#calendar", # Type of the resource ("calendar#calendar").
159 "description": "A String", # Description of the calendar. Optional.
160 "summary": "A String", # Title of the calendar.
161 "etag": "A String", # ETag of the resource.
162 "location": "A String", # Geographic location of the calendar as free-form text. Optional.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]163 "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]164 "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]165 }</pre>
166</div>
167
168<div class="method">
169 <code class="details" id="patch">patch(calendarId, body)</code>
170 <pre>Updates metadata for a calendar. This method supports patch semantics.
171
172Args:
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]173 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]174 body: object, The request body. (required)
175 The object takes the form of:
176
177{
178 "kind": "calendar#calendar", # Type of the resource ("calendar#calendar").
179 "description": "A String", # Description of the calendar. Optional.
180 "summary": "A String", # Title of the calendar.
181 "etag": "A String", # ETag of the resource.
182 "location": "A String", # Geographic location of the calendar as free-form text. Optional.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]183 "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]184 "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]185 }
186
187
188Returns:
189 An object of the form:
190
191 {
192 "kind": "calendar#calendar", # Type of the resource ("calendar#calendar").
193 "description": "A String", # Description of the calendar. Optional.
194 "summary": "A String", # Title of the calendar.
195 "etag": "A String", # ETag of the resource.
196 "location": "A String", # Geographic location of the calendar as free-form text. Optional.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]197 "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]198 "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]199 }</pre>
200</div>
201
202<div class="method">
203 <code class="details" id="update">update(calendarId, body)</code>
204 <pre>Updates metadata for a calendar.
205
206Args:
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]207 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]208 body: object, The request body. (required)
209 The object takes the form of:
210
211{
212 "kind": "calendar#calendar", # Type of the resource ("calendar#calendar").
213 "description": "A String", # Description of the calendar. Optional.
214 "summary": "A String", # Title of the calendar.
215 "etag": "A String", # ETag of the resource.
216 "location": "A String", # Geographic location of the calendar as free-form text. Optional.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]217 "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]218 "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]219 }
220
221
222Returns:
223 An object of the form:
224
225 {
226 "kind": "calendar#calendar", # Type of the resource ("calendar#calendar").
227 "description": "A String", # Description of the calendar. Optional.
228 "summary": "A String", # Title of the calendar.
229 "etag": "A String", # ETag of the resource.
230 "location": "A String", # Geographic location of the calendar as free-form text. Optional.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]231 "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]232 "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]233 }</pre>
234</div>
235
236</body></html>