blob: 17eb94f7aa1fbeeeabf0d4464d37fa70d75ddcac [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<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.settings.html">settings</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -040081 <code><a href="#get">get(setting)</a></code></p>
82<p class="firstline">Returns a single user setting.</p>
83<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080084 <code><a href="#list">list(maxResults=None, pageToken=None, syncToken=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040085<p class="firstline">Returns all user settings for the authenticated user.</p>
86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080090 <code><a href="#watch">watch(body=None, maxResults=None, pageToken=None, syncToken=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040091<p class="firstline">Watch for changes to Settings resources.</p>
92<h3>Method Details</h3>
93<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070094 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96</div>
97
98<div class="method">
John Asmuth614db982014-04-24 15:46:26 -040099 <code class="details" id="get">get(setting)</code>
100 <pre>Returns a single user setting.
101
102Args:
103 setting: string, The id of the user setting. (required)
104
105Returns:
106 An object of the form:
107
108 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800109 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
110 &quot;id&quot;: &quot;A String&quot;, # The id of the user setting.
111 &quot;kind&quot;: &quot;calendar#setting&quot;, # Type of the resource (&quot;calendar#setting&quot;).
112 &quot;value&quot;: &quot;A String&quot;, # Value of the user setting. The format of the value depends on the ID of the setting. It must always be a UTF-8 string of length up to 1024 characters.
113}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400114</div>
115
116<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800117 <code class="details" id="list">list(maxResults=None, pageToken=None, syncToken=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400118 <pre>Returns all user settings for the authenticated user.
119
120Args:
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800121 maxResults: integer, Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
122 pageToken: string, Token specifying which result page to return. Optional.
Craig Citro065b5302014-08-14 00:47:23 -0700123 syncToken: string, Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then.
124If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.
125Learn more about incremental synchronization.
126Optional. The default is to return all entries.
John Asmuth614db982014-04-24 15:46:26 -0400127
128Returns:
129 An object of the form:
130
131 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800132 &quot;etag&quot;: &quot;A String&quot;, # Etag of the collection.
133 &quot;items&quot;: [ # List of user settings.
134 {
135 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
136 &quot;id&quot;: &quot;A String&quot;, # The id of the user setting.
137 &quot;kind&quot;: &quot;calendar#setting&quot;, # Type of the resource (&quot;calendar#setting&quot;).
138 &quot;value&quot;: &quot;A String&quot;, # Value of the user setting. The format of the value depends on the ID of the setting. It must always be a UTF-8 string of length up to 1024 characters.
139 },
140 ],
141 &quot;kind&quot;: &quot;calendar#settings&quot;, # Type of the collection (&quot;calendar#settings&quot;).
142 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
143 &quot;nextSyncToken&quot;: &quot;A String&quot;, # Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.
144}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400145</div>
146
147<div class="method">
148 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
149 <pre>Retrieves the next page of results.
150
151Args:
152 previous_request: The request for the previous page. (required)
153 previous_response: The response from the request for the previous page. (required)
154
155Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700156 A request object that you can call &#x27;execute()&#x27; on to request the next
John Asmuth614db982014-04-24 15:46:26 -0400157 page. Returns None if there are no more items in the collection.
158 </pre>
159</div>
160
161<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800162 <code class="details" id="watch">watch(body=None, maxResults=None, pageToken=None, syncToken=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400163 <pre>Watch for changes to Settings resources.
164
165Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700166 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400167 The object takes the form of:
168
169{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800170 &quot;address&quot;: &quot;A String&quot;, # The address where notifications are delivered for this channel.
171 &quot;expiration&quot;: &quot;A String&quot;, # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
172 &quot;id&quot;: &quot;A String&quot;, # A UUID or similar unique string that identifies this channel.
173 &quot;kind&quot;: &quot;api#channel&quot;, # Identifies this as a notification channel used to watch for changes to a resource, which is &quot;api#channel&quot;.
174 &quot;params&quot;: { # Additional parameters controlling delivery channel behavior. Optional.
175 &quot;a_key&quot;: &quot;A String&quot;, # Declares a new parameter by name.
176 },
177 &quot;payload&quot;: True or False, # A Boolean value to indicate whether payload is wanted. Optional.
178 &quot;resourceId&quot;: &quot;A String&quot;, # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
179 &quot;resourceUri&quot;: &quot;A String&quot;, # A version-specific identifier for the watched resource.
180 &quot;token&quot;: &quot;A String&quot;, # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800181 &quot;type&quot;: &quot;A String&quot;, # The type of delivery mechanism used for this channel. Valid values are &quot;web_hook&quot; (or &quot;webhook&quot;). Both values refer to a channel where Http requests are used to deliver messages.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800182}
John Asmuth614db982014-04-24 15:46:26 -0400183
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800184 maxResults: integer, Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800185 pageToken: string, Token specifying which result page to return. Optional.
Craig Citro065b5302014-08-14 00:47:23 -0700186 syncToken: string, Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then.
187If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.
188Learn more about incremental synchronization.
189Optional. The default is to return all entries.
John Asmuth614db982014-04-24 15:46:26 -0400190
191Returns:
192 An object of the form:
193
194 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800195 &quot;address&quot;: &quot;A String&quot;, # The address where notifications are delivered for this channel.
196 &quot;expiration&quot;: &quot;A String&quot;, # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
197 &quot;id&quot;: &quot;A String&quot;, # A UUID or similar unique string that identifies this channel.
198 &quot;kind&quot;: &quot;api#channel&quot;, # Identifies this as a notification channel used to watch for changes to a resource, which is &quot;api#channel&quot;.
199 &quot;params&quot;: { # Additional parameters controlling delivery channel behavior. Optional.
200 &quot;a_key&quot;: &quot;A String&quot;, # Declares a new parameter by name.
201 },
202 &quot;payload&quot;: True or False, # A Boolean value to indicate whether payload is wanted. Optional.
203 &quot;resourceId&quot;: &quot;A String&quot;, # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
204 &quot;resourceUri&quot;: &quot;A String&quot;, # A version-specific identifier for the watched resource.
205 &quot;token&quot;: &quot;A String&quot;, # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800206 &quot;type&quot;: &quot;A String&quot;, # The type of delivery mechanism used for this channel. Valid values are &quot;web_hook&quot; (or &quot;webhook&quot;). Both values refer to a channel where Http requests are used to deliver messages.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800207}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400208</div>
209
210</body></html>