Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 66212035140c8f3abfb6ed14a40db27dbef4d220 / . / docs / dyn / calendar.v3.calendars.html
blob: 71ccb793f6bb9dd06b4ab18b6521bf9c185b7f4d [file] [log] [blame]
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]1
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: class Resource</title>
4</head><body bgcolor="#f0f0f8">
5<p>
6<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
7<tr bgcolor="#ffc8d8">
8<td colspan=3 valign=bottom>&nbsp;<br>
9<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
10
11<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
12<td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
13<tr><td>&nbsp;</td>
14<td width="100%">Methods defined here:<br>
15<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
16
17<dl><dt><a name="Resource-clear"><strong>clear</strong></a> = method(self, **kwargs)</dt><dd><tt>Clears&nbsp;a&nbsp;primary&nbsp;calendar.&nbsp;This&nbsp;operation&nbsp;deletes&nbsp;all&nbsp;data&nbsp;associated&nbsp;with&nbsp;the&nbsp;primary&nbsp;calendar&nbsp;of&nbsp;an&nbsp;account&nbsp;and&nbsp;cannot&nbsp;be&nbsp;undone.<br>
18&nbsp;<br>
19Args:<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame^]20&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
21&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
22&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
23&nbsp;&nbsp;calendarId:&nbsp;string,&nbsp;Calendar&nbsp;identifier.&nbsp;(required)<br>
24&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter</tt></dd></dl>
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]25
26<dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Deletes&nbsp;a&nbsp;secondary&nbsp;calendar.<br>
27&nbsp;<br>
28Args:<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame^]29&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
30&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
31&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
32&nbsp;&nbsp;calendarId:&nbsp;string,&nbsp;Calendar&nbsp;identifier.&nbsp;(required)<br>
33&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter</tt></dd></dl>
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]34
35<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns&nbsp;metadata&nbsp;for&nbsp;a&nbsp;calendar.<br>
36&nbsp;<br>
37Args:<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame^]38&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
39&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
40&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]41&nbsp;&nbsp;calendarId:&nbsp;string,&nbsp;Calendar&nbsp;identifier.&nbsp;(required)<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame^]42&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]43&nbsp;<br>
44Returns:<br>
45&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
46&nbsp;<br>
47&nbsp;&nbsp;&nbsp;&nbsp;{<br>
48&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"calendar#calendar",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;resource&nbsp;("calendar#calendar").<br>
49&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Description&nbsp;of&nbsp;the&nbsp;calendar.&nbsp;Optional.<br>
50&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"summary":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;the&nbsp;calendar.<br>
51&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"etag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;ETag&nbsp;of&nbsp;the&nbsp;resource.<br>
52&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Geographic&nbsp;location&nbsp;of&nbsp;the&nbsp;calendar&nbsp;as&nbsp;free-form&nbsp;text.&nbsp;Optional.<br>
53&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"timeZone":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;time&nbsp;zone&nbsp;of&nbsp;the&nbsp;calendar.&nbsp;Optional.<br>
54&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Identifier&nbsp;of&nbsp;the&nbsp;calendar.<br>
55&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
56
57<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Creates&nbsp;a&nbsp;secondary&nbsp;calendar.<br>
58&nbsp;<br>
59Args:<br>
60&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
61&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
62&nbsp;<br>
63{<br>
64&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"calendar#calendar",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;resource&nbsp;("calendar#calendar").<br>
65&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Description&nbsp;of&nbsp;the&nbsp;calendar.&nbsp;Optional.<br>
66&nbsp;&nbsp;&nbsp;&nbsp;"summary":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;the&nbsp;calendar.<br>
67&nbsp;&nbsp;&nbsp;&nbsp;"etag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;ETag&nbsp;of&nbsp;the&nbsp;resource.<br>
68&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Geographic&nbsp;location&nbsp;of&nbsp;the&nbsp;calendar&nbsp;as&nbsp;free-form&nbsp;text.&nbsp;Optional.<br>
69&nbsp;&nbsp;&nbsp;&nbsp;"timeZone":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;time&nbsp;zone&nbsp;of&nbsp;the&nbsp;calendar.&nbsp;Optional.<br>
70&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Identifier&nbsp;of&nbsp;the&nbsp;calendar.<br>
71&nbsp;&nbsp;}<br>
72&nbsp;<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame^]73&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
74&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
75&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
76&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]77&nbsp;<br>
78Returns:<br>
79&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
80&nbsp;<br>
81&nbsp;&nbsp;&nbsp;&nbsp;{<br>
82&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"calendar#calendar",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;resource&nbsp;("calendar#calendar").<br>
83&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Description&nbsp;of&nbsp;the&nbsp;calendar.&nbsp;Optional.<br>
84&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"summary":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;the&nbsp;calendar.<br>
85&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"etag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;ETag&nbsp;of&nbsp;the&nbsp;resource.<br>
86&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Geographic&nbsp;location&nbsp;of&nbsp;the&nbsp;calendar&nbsp;as&nbsp;free-form&nbsp;text.&nbsp;Optional.<br>
87&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"timeZone":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;time&nbsp;zone&nbsp;of&nbsp;the&nbsp;calendar.&nbsp;Optional.<br>
88&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Identifier&nbsp;of&nbsp;the&nbsp;calendar.<br>
89&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
90
91<dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates&nbsp;metadata&nbsp;for&nbsp;a&nbsp;calendar.&nbsp;This&nbsp;method&nbsp;supports&nbsp;patch&nbsp;semantics.<br>
92&nbsp;<br>
93Args:<br>
94&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
95&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
96&nbsp;<br>
97{<br>
98&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"calendar#calendar",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;resource&nbsp;("calendar#calendar").<br>
99&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Description&nbsp;of&nbsp;the&nbsp;calendar.&nbsp;Optional.<br>
100&nbsp;&nbsp;&nbsp;&nbsp;"summary":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;the&nbsp;calendar.<br>
101&nbsp;&nbsp;&nbsp;&nbsp;"etag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;ETag&nbsp;of&nbsp;the&nbsp;resource.<br>
102&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Geographic&nbsp;location&nbsp;of&nbsp;the&nbsp;calendar&nbsp;as&nbsp;free-form&nbsp;text.&nbsp;Optional.<br>
103&nbsp;&nbsp;&nbsp;&nbsp;"timeZone":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;time&nbsp;zone&nbsp;of&nbsp;the&nbsp;calendar.&nbsp;Optional.<br>
104&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Identifier&nbsp;of&nbsp;the&nbsp;calendar.<br>
105&nbsp;&nbsp;}<br>
106&nbsp;<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame^]107&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
108&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
109&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]110&nbsp;&nbsp;calendarId:&nbsp;string,&nbsp;Calendar&nbsp;identifier.&nbsp;(required)<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame^]111&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]112&nbsp;<br>
113Returns:<br>
114&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
115&nbsp;<br>
116&nbsp;&nbsp;&nbsp;&nbsp;{<br>
117&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"calendar#calendar",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;resource&nbsp;("calendar#calendar").<br>
118&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Description&nbsp;of&nbsp;the&nbsp;calendar.&nbsp;Optional.<br>
119&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"summary":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;the&nbsp;calendar.<br>
120&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"etag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;ETag&nbsp;of&nbsp;the&nbsp;resource.<br>
121&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Geographic&nbsp;location&nbsp;of&nbsp;the&nbsp;calendar&nbsp;as&nbsp;free-form&nbsp;text.&nbsp;Optional.<br>
122&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"timeZone":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;time&nbsp;zone&nbsp;of&nbsp;the&nbsp;calendar.&nbsp;Optional.<br>
123&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Identifier&nbsp;of&nbsp;the&nbsp;calendar.<br>
124&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
125
126<dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates&nbsp;metadata&nbsp;for&nbsp;a&nbsp;calendar.<br>
127&nbsp;<br>
128Args:<br>
129&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
130&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
131&nbsp;<br>
132{<br>
133&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"calendar#calendar",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;resource&nbsp;("calendar#calendar").<br>
134&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Description&nbsp;of&nbsp;the&nbsp;calendar.&nbsp;Optional.<br>
135&nbsp;&nbsp;&nbsp;&nbsp;"summary":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;the&nbsp;calendar.<br>
136&nbsp;&nbsp;&nbsp;&nbsp;"etag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;ETag&nbsp;of&nbsp;the&nbsp;resource.<br>
137&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Geographic&nbsp;location&nbsp;of&nbsp;the&nbsp;calendar&nbsp;as&nbsp;free-form&nbsp;text.&nbsp;Optional.<br>
138&nbsp;&nbsp;&nbsp;&nbsp;"timeZone":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;time&nbsp;zone&nbsp;of&nbsp;the&nbsp;calendar.&nbsp;Optional.<br>
139&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Identifier&nbsp;of&nbsp;the&nbsp;calendar.<br>
140&nbsp;&nbsp;}<br>
141&nbsp;<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame^]142&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
143&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
144&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]145&nbsp;&nbsp;calendarId:&nbsp;string,&nbsp;Calendar&nbsp;identifier.&nbsp;(required)<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame^]146&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio2401bd62011-12-15 09:18:49 -0500[diff] [blame]147&nbsp;<br>
148Returns:<br>
149&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
150&nbsp;<br>
151&nbsp;&nbsp;&nbsp;&nbsp;{<br>
152&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"calendar#calendar",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;resource&nbsp;("calendar#calendar").<br>
153&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Description&nbsp;of&nbsp;the&nbsp;calendar.&nbsp;Optional.<br>
154&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"summary":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;the&nbsp;calendar.<br>
155&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"etag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;ETag&nbsp;of&nbsp;the&nbsp;resource.<br>
156&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Geographic&nbsp;location&nbsp;of&nbsp;the&nbsp;calendar&nbsp;as&nbsp;free-form&nbsp;text.&nbsp;Optional.<br>
157&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"timeZone":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;time&nbsp;zone&nbsp;of&nbsp;the&nbsp;calendar.&nbsp;Optional.<br>
158&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Identifier&nbsp;of&nbsp;the&nbsp;calendar.<br>
159&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
160
161<hr>
162Data descriptors defined here:<br>
163<dl><dt><strong>__dict__</strong></dt>
164<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
165</dl>
166<dl><dt><strong>__weakref__</strong></dt>
167<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
168</dl>
169</td></tr></table>
170</body></html>