John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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 Manista | 4f877e5 | 2015-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 Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 80 | <p class="toc_element"> |
Dmitry Frenkel | 3e17f89 | 2020-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 Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 84 | <code><a href="#delete">delete(calendarId)</a></code></p> |
Nathaniel Manista | 4f877e5 | 2015-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 Asmuth | 614db98 | 2014-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'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 90 | <code><a href="#insert">insert(body=None)</a></code></p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 91 | <p class="firstline">Creates a secondary calendar.</p> |
| 92 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 93 | <code><a href="#patch">patch(calendarId, body=None)</a></code></p> |
John Asmuth | 614db98 | 2014-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'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 96 | <code><a href="#update">update(calendarId, body=None)</a></code></p> |
John Asmuth | 614db98 | 2014-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 Manista | 4f877e5 | 2015-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 Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 102 | |
| 103 | Args: |
Bu Sun Kim | 6502091 | 2020-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 "primary" keyword. (required) |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 105 | </pre> |
| 106 | </div> |
| 107 | |
| 108 | <div class="method"> |
Dmitry Frenkel | 3e17f89 | 2020-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 Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 114 | <code class="details" id="delete">delete(calendarId)</code> |
Nathaniel Manista | 4f877e5 | 2015-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 Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 116 | |
| 117 | Args: |
Bu Sun Kim | 6502091 | 2020-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 "primary" keyword. (required) |
John Asmuth | 614db98 | 2014-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 | |
| 126 | Args: |
Bu Sun Kim | 6502091 | 2020-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 "primary" keyword. (required) |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 128 | |
| 129 | Returns: |
| 130 | An object of the form: |
| 131 | |
| 132 | { |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 133 | "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed. |
| 134 | "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar. |
| 135 | # The possible values are: |
| 136 | # - "eventHangout" |
| 137 | # - "eventNamedHangout" |
| 138 | # - "hangoutsMeet" Optional. |
| 139 | "A String", |
| 140 | ], |
| 141 | }, |
| 142 | "description": "A String", # Description of the calendar. Optional. |
| 143 | "etag": "A String", # ETag of the resource. |
| 144 | "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method. |
| 145 | "kind": "calendar#calendar", # Type of the resource ("calendar#calendar"). |
| 146 | "location": "A String", # Geographic location of the calendar as free-form text. Optional. |
| 147 | "summary": "A String", # Title of the calendar. |
| 148 | "timeZone": "A String", # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. |
| 149 | }</pre> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 150 | </div> |
| 151 | |
| 152 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 153 | <code class="details" id="insert">insert(body=None)</code> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 154 | <pre>Creates a secondary calendar. |
| 155 | |
| 156 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 157 | body: object, The request body. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 158 | The object takes the form of: |
| 159 | |
| 160 | { |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 161 | "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed. |
| 162 | "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar. |
| 163 | # The possible values are: |
| 164 | # - "eventHangout" |
| 165 | # - "eventNamedHangout" |
| 166 | # - "hangoutsMeet" Optional. |
| 167 | "A String", |
| 168 | ], |
| 169 | }, |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 170 | "description": "A String", # Description of the calendar. Optional. |
Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 171 | "etag": "A String", # ETag of the resource. |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 172 | "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 173 | "kind": "calendar#calendar", # Type of the resource ("calendar#calendar"). |
Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 174 | "location": "A String", # Geographic location of the calendar as free-form text. Optional. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 175 | "summary": "A String", # Title of the calendar. |
| 176 | "timeZone": "A String", # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 177 | } |
| 178 | |
| 179 | |
| 180 | Returns: |
| 181 | An object of the form: |
| 182 | |
| 183 | { |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 184 | "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed. |
| 185 | "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar. |
| 186 | # The possible values are: |
| 187 | # - "eventHangout" |
| 188 | # - "eventNamedHangout" |
| 189 | # - "hangoutsMeet" Optional. |
| 190 | "A String", |
| 191 | ], |
| 192 | }, |
| 193 | "description": "A String", # Description of the calendar. Optional. |
| 194 | "etag": "A String", # ETag of the resource. |
| 195 | "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method. |
| 196 | "kind": "calendar#calendar", # Type of the resource ("calendar#calendar"). |
| 197 | "location": "A String", # Geographic location of the calendar as free-form text. Optional. |
| 198 | "summary": "A String", # Title of the calendar. |
| 199 | "timeZone": "A String", # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. |
| 200 | }</pre> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 201 | </div> |
| 202 | |
| 203 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 204 | <code class="details" id="patch">patch(calendarId, body=None)</code> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 205 | <pre>Updates metadata for a calendar. This method supports patch semantics. |
| 206 | |
| 207 | Args: |
Bu Sun Kim | 6502091 | 2020-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 "primary" keyword. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 209 | body: object, The request body. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 210 | The object takes the form of: |
| 211 | |
| 212 | { |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 213 | "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed. |
| 214 | "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar. |
| 215 | # The possible values are: |
| 216 | # - "eventHangout" |
| 217 | # - "eventNamedHangout" |
| 218 | # - "hangoutsMeet" Optional. |
| 219 | "A String", |
| 220 | ], |
| 221 | }, |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 222 | "description": "A String", # Description of the calendar. Optional. |
Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 223 | "etag": "A String", # ETag of the resource. |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 224 | "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 225 | "kind": "calendar#calendar", # Type of the resource ("calendar#calendar"). |
Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 226 | "location": "A String", # Geographic location of the calendar as free-form text. Optional. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 227 | "summary": "A String", # Title of the calendar. |
| 228 | "timeZone": "A String", # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 229 | } |
| 230 | |
| 231 | |
| 232 | Returns: |
| 233 | An object of the form: |
| 234 | |
| 235 | { |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 236 | "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed. |
| 237 | "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar. |
| 238 | # The possible values are: |
| 239 | # - "eventHangout" |
| 240 | # - "eventNamedHangout" |
| 241 | # - "hangoutsMeet" Optional. |
| 242 | "A String", |
| 243 | ], |
| 244 | }, |
| 245 | "description": "A String", # Description of the calendar. Optional. |
| 246 | "etag": "A String", # ETag of the resource. |
| 247 | "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method. |
| 248 | "kind": "calendar#calendar", # Type of the resource ("calendar#calendar"). |
| 249 | "location": "A String", # Geographic location of the calendar as free-form text. Optional. |
| 250 | "summary": "A String", # Title of the calendar. |
| 251 | "timeZone": "A String", # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. |
| 252 | }</pre> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 253 | </div> |
| 254 | |
| 255 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 256 | <code class="details" id="update">update(calendarId, body=None)</code> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 257 | <pre>Updates metadata for a calendar. |
| 258 | |
| 259 | Args: |
Bu Sun Kim | 6502091 | 2020-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 "primary" keyword. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 261 | body: object, The request body. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 262 | The object takes the form of: |
| 263 | |
| 264 | { |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 265 | "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed. |
| 266 | "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar. |
| 267 | # The possible values are: |
| 268 | # - "eventHangout" |
| 269 | # - "eventNamedHangout" |
| 270 | # - "hangoutsMeet" Optional. |
| 271 | "A String", |
| 272 | ], |
| 273 | }, |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 274 | "description": "A String", # Description of the calendar. Optional. |
Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 275 | "etag": "A String", # ETag of the resource. |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 276 | "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 277 | "kind": "calendar#calendar", # Type of the resource ("calendar#calendar"). |
Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 278 | "location": "A String", # Geographic location of the calendar as free-form text. Optional. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 279 | "summary": "A String", # Title of the calendar. |
| 280 | "timeZone": "A String", # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 281 | } |
| 282 | |
| 283 | |
| 284 | Returns: |
| 285 | An object of the form: |
| 286 | |
| 287 | { |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 288 | "conferenceProperties": { # Conferencing properties for this calendar, for example what types of conferences are allowed. |
| 289 | "allowedConferenceSolutionTypes": [ # The types of conference solutions that are supported for this calendar. |
| 290 | # The possible values are: |
| 291 | # - "eventHangout" |
| 292 | # - "eventNamedHangout" |
| 293 | # - "hangoutsMeet" Optional. |
| 294 | "A String", |
| 295 | ], |
| 296 | }, |
| 297 | "description": "A String", # Description of the calendar. Optional. |
| 298 | "etag": "A String", # ETag of the resource. |
| 299 | "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method. |
| 300 | "kind": "calendar#calendar", # Type of the resource ("calendar#calendar"). |
| 301 | "location": "A String", # Geographic location of the calendar as free-form text. Optional. |
| 302 | "summary": "A String", # Title of the calendar. |
| 303 | "timeZone": "A String", # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. |
| 304 | }</pre> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 305 | </div> |
| 306 | |
| 307 | </body></html> |