<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="calendar_v3.html">Calendar API</a> . <a href="calendar_v3.settings.html">settings</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(setting)</a></code></p>
<p class="firstline">Returns a single user setting.</p>
<p class="toc_element">
<code><a href="#list">list(syncToken=None, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">Returns all user settings for the authenticated user.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#watch">watch(body, syncToken=None, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">Watch for changes to Settings resources.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(setting)</code>
<pre>Returns a single user setting.
Args:
setting: string, The id of the user setting. (required)
Returns:
An object of the form:
{
"kind": "calendar#setting", # Type of the resource ("calendar#setting").
"etag": "A String", # ETag of the resource.
"id": "A String", # The id of the user setting.
"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.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(syncToken=None, pageToken=None, maxResults=None)</code>
<pre>Returns all user settings for the authenticated user.
Args:
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.
If 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.
Learn more about incremental synchronization.
Optional. The default is to return all entries.
pageToken: string, Token specifying which result page to return. Optional.
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.
Returns:
An object of the form:
{
"nextPageToken": "A String", # Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
"items": [ # List of user settings.
{
"kind": "calendar#setting", # Type of the resource ("calendar#setting").
"etag": "A String", # ETag of the resource.
"id": "A String", # The id of the user setting.
"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.
},
],
"kind": "calendar#settings", # Type of the collection ("calendar#settings").
"etag": "A String", # Etag of the collection.
"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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="watch">watch(body, syncToken=None, pageToken=None, maxResults=None)</code>
<pre>Watch for changes to Settings resources.
Args:
body: object, The request body. (required)
The object takes the form of:
{
"resourceUri": "A String", # A version-specific identifier for the watched resource.
"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
"params": { # Additional parameters controlling delivery channel behavior. Optional.
"a_key": "A String", # Declares a new parameter by name.
},
"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
"address": "A String", # The address where notifications are delivered for this channel.
"type": "A String", # The type of delivery mechanism used for this channel.
"id": "A String", # A UUID or similar unique string that identifies this channel.
}
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.
If 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.
Learn more about incremental synchronization.
Optional. The default is to return all entries.
pageToken: string, Token specifying which result page to return. Optional.
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.
Returns:
An object of the form:
{
"resourceUri": "A String", # A version-specific identifier for the watched resource.
"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
"params": { # Additional parameters controlling delivery channel behavior. Optional.
"a_key": "A String", # Declares a new parameter by name.
},
"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
"address": "A String", # The address where notifications are delivered for this channel.
"type": "A String", # The type of delivery mechanism used for this channel.
"id": "A String", # A UUID or similar unique string that identifies this channel.
}</pre>
</div>
</body></html>