Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d059ad881c7ae58c67931c48788d0bd7343ab16c / . / docs / dyn / calendar_v3.settings.html
blob: 4879d7f019aa15fedc3133ab439cd186444f4d23 [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.settings.html">settings</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(setting)</a></code></p>
79<p class="firstline">Returns a single user setting.</p>
80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]81 <code><a href="#list">list(pageToken=None, maxResults=None, syncToken=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]82<p class="firstline">Returns all user settings for the authenticated user.</p>
83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]87 <code><a href="#watch">watch(body=None, pageToken=None, syncToken=None, maxResults=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]88<p class="firstline">Watch for changes to Settings resources.</p>
89<h3>Method Details</h3>
90<div class="method">
91 <code class="details" id="get">get(setting)</code>
92 <pre>Returns a single user setting.
93
94Args:
95 setting: string, The id of the user setting. (required)
96
97Returns:
98 An object of the form:
99
100 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]101 &quot;kind&quot;: &quot;calendar#setting&quot;, # Type of the resource (&quot;calendar#setting&quot;).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]102 &quot;id&quot;: &quot;A String&quot;, # The id of the user setting.
103 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]104 &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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]105 }</pre>
106</div>
107
108<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]109 <code class="details" id="list">list(pageToken=None, maxResults=None, syncToken=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]110 <pre>Returns all user settings for the authenticated user.
111
112Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]113 pageToken: string, Token specifying which result page to return. Optional.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]114 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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]115 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.
116If 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.
117Learn more about incremental synchronization.
118Optional. The default is to return all entries.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]119
120Returns:
121 An object of the form:
122
123 {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]124 &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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]125 &quot;etag&quot;: &quot;A String&quot;, # Etag of the collection.
126 &quot;items&quot;: [ # List of user settings.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]127 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]128 &quot;kind&quot;: &quot;calendar#setting&quot;, # Type of the resource (&quot;calendar#setting&quot;).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]129 &quot;id&quot;: &quot;A String&quot;, # The id of the user setting.
130 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]131 &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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]132 },
133 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]134 &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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]135 &quot;kind&quot;: &quot;calendar#settings&quot;, # Type of the collection (&quot;calendar#settings&quot;).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]136 }</pre>
137</div>
138
139<div class="method">
140 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
141 <pre>Retrieves the next page of results.
142
143Args:
144 previous_request: The request for the previous page. (required)
145 previous_response: The response from the request for the previous page. (required)
146
147Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]148 A request object that you can call &#x27;execute()&#x27; on to request the next
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]149 page. Returns None if there are no more items in the collection.
150 </pre>
151</div>
152
153<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]154 <code class="details" id="watch">watch(body=None, pageToken=None, syncToken=None, maxResults=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]155 <pre>Watch for changes to Settings resources.
156
157Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]158 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]159 The object takes the form of:
160
161{
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]162 &quot;resourceUri&quot;: &quot;A String&quot;, # A version-specific identifier for the watched resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]163 &quot;address&quot;: &quot;A String&quot;, # The address where notifications are delivered for this channel.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]164 &quot;resourceId&quot;: &quot;A String&quot;, # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]165 &quot;params&quot;: { # Additional parameters controlling delivery channel behavior. Optional.
166 &quot;a_key&quot;: &quot;A String&quot;, # Declares a new parameter by name.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]167 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]168 &quot;payload&quot;: True or False, # A Boolean value to indicate whether payload is wanted. Optional.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]169 &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;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]170 &quot;token&quot;: &quot;A String&quot;, # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]173 &quot;type&quot;: &quot;A String&quot;, # The type of delivery mechanism used for this channel.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]174 }
175
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]176 pageToken: string, Token specifying which result page to return. Optional.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]177 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.
178If 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.
179Learn more about incremental synchronization.
180Optional. The default is to return all entries.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]181 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]182
183Returns:
184 An object of the form:
185
186 {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]187 &quot;resourceUri&quot;: &quot;A String&quot;, # A version-specific identifier for the watched resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]188 &quot;address&quot;: &quot;A String&quot;, # The address where notifications are delivered for this channel.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]189 &quot;resourceId&quot;: &quot;A String&quot;, # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]190 &quot;params&quot;: { # Additional parameters controlling delivery channel behavior. Optional.
191 &quot;a_key&quot;: &quot;A String&quot;, # Declares a new parameter by name.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]192 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]193 &quot;payload&quot;: True or False, # A Boolean value to indicate whether payload is wanted. Optional.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]194 &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;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]195 &quot;token&quot;: &quot;A String&quot;, # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]198 &quot;type&quot;: &quot;A String&quot;, # The type of delivery mechanism used for this channel.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]199 }</pre>
200</div>
201
202</body></html>