Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b1cc515b93bef725389ac86401366b6f7a98b0c8 / . / docs / dyn / calendar_v3.settings.html
blob: aa92bb81aaa2094ce665d486ab7f14cefde2c2b8 [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">
81 <code><a href="#list">list(syncToken=None, pageToken=None, maxResults=None)</a></code></p>
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">
87 <code><a href="#watch">watch(body, syncToken=None, pageToken=None, maxResults=None)</a></code></p>
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 {
101 "kind": "calendar#setting", # Type of the resource ("calendar#setting").
102 "etag": "A String", # ETag of the resource.
103 "id": "A String", # The id of the user setting.
104 "value": "A String", # 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.
105 }</pre>
106</div>
107
108<div class="method">
109 <code class="details" id="list">list(syncToken=None, pageToken=None, maxResults=None)</code>
110 <pre>Returns all user settings for the authenticated user.
111
112Args:
113 syncToken: string, Token obtained from the 'nextSyncToken' field returned on the last result page of the previous method's call. It makes the result of this call contain only entries that have changed since the last call. Optional. The default is to return all entries.
114 pageToken: string, Token specifying which result page to return. Optional.
115 maxResults: integer, Maximum number of entries returned on one result page. Optional.
116
117Returns:
118 An object of the form:
119
120 {
121 "nextPageToken": "A String", # Token used to access the next page of this result.
122 "items": [ # List of user settings.
123 {
124 "kind": "calendar#setting", # Type of the resource ("calendar#setting").
125 "etag": "A String", # ETag of the resource.
126 "id": "A String", # The id of the user setting.
127 "value": "A String", # 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.
128 },
129 ],
130 "kind": "calendar#settings", # Type of the collection ("calendar#settings").
131 "etag": "A String", # Etag of the collection.
132 "nextSyncToken": "A String", # 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.
133 }</pre>
134</div>
135
136<div class="method">
137 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
138 <pre>Retrieves the next page of results.
139
140Args:
141 previous_request: The request for the previous page. (required)
142 previous_response: The response from the request for the previous page. (required)
143
144Returns:
145 A request object that you can call 'execute()' on to request the next
146 page. Returns None if there are no more items in the collection.
147 </pre>
148</div>
149
150<div class="method">
151 <code class="details" id="watch">watch(body, syncToken=None, pageToken=None, maxResults=None)</code>
152 <pre>Watch for changes to Settings resources.
153
154Args:
155 body: object, The request body. (required)
156 The object takes the form of:
157
158{
159 "resourceUri": "A String", # A version-specific identifier for the watched resource.
160 "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
161 "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
162 "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
163 "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
164 "params": { # Additional parameters controlling delivery channel behavior. Optional.
165 "a_key": "A String", # Declares a new parameter by name.
166 },
167 "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
168 "address": "A String", # The address where notifications are delivered for this channel.
169 "type": "A String", # The type of delivery mechanism used for this channel.
170 "id": "A String", # A UUID or similar unique string that identifies this channel.
171 }
172
173 syncToken: string, Token obtained from the 'nextSyncToken' field returned on the last result page of the previous method's call. It makes the result of this call contain only entries that have changed since the last call. Optional. The default is to return all entries.
174 pageToken: string, Token specifying which result page to return. Optional.
175 maxResults: integer, Maximum number of entries returned on one result page. Optional.
176
177Returns:
178 An object of the form:
179
180 {
181 "resourceUri": "A String", # A version-specific identifier for the watched resource.
182 "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
183 "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
184 "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
185 "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
186 "params": { # Additional parameters controlling delivery channel behavior. Optional.
187 "a_key": "A String", # Declares a new parameter by name.
188 },
189 "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
190 "address": "A String", # The address where notifications are delivered for this channel.
191 "type": "A String", # The type of delivery mechanism used for this channel.
192 "id": "A String", # A UUID or similar unique string that identifies this channel.
193 }</pre>
194</div>
195
196</body></html>