Blame - docs/dyn/calendar_v3.settings.html - platform/external/python/google-api-python-client

blob: c43127b4302ce8bb833dc1632edcacbca10196e0 [file] [log] [blame]

John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, 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
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, 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 Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	78	<code><a href="#close">close()</a></code></p>
				79	<p class="firstline">Close httplib2 connections.</p>
				80	<p class="toc_element">
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	81	<code><a href="#get">get(setting)</a></code></p>
				82	<p class="firstline">Returns a single user setting.</p>
				83	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	84	<code><a href="#list">list(syncToken=None, maxResults=None, pageToken=None)</a></code></p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	85	<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">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	90	<code><a href="#watch">watch(body=None, maxResults=None, pageToken=None, syncToken=None)</a></code></p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	91	<p class="firstline">Watch for changes to Settings resources.</p>
				92	<h3>Method Details</h3>
				93	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	94	<code class="details" id="close">close()</code>
				95	<pre>Close httplib2 connections.</pre>
				96	</div>
				97
				98	<div class="method">
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	99	<code class="details" id="get">get(setting)</code>
				100	<pre>Returns a single user setting.
				101
				102	Args:
				103	setting: string, The id of the user setting. (required)
				104
				105	Returns:
				106	An object of the form:
				107
				108	{
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	109	"id": "A String", # The id of the user setting.
				110	"etag": "A String", # ETag of the resource.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	111	"kind": "calendar#setting", # Type of the resource ("calendar#setting").
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	112	"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.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	113	}</pre>
				114	</div>
				115
				116	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	117	<code class="details" id="list">list(syncToken=None, maxResults=None, pageToken=None)</code>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	118	<pre>Returns all user settings for the authenticated user.
				119
				120	Args:
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	121	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.
				122	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.
				123	Learn more about incremental synchronization.
				124	Optional. The default is to return all entries.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	125	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.
				126	pageToken: string, Token specifying which result page to return. Optional.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	127
				128	Returns:
				129	An object of the form:
				130
				131	{
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	132	"etag": "A String", # Etag of the collection.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	133	"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.
				134	"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.
				135	"kind": "calendar#settings", # Type of the collection ("calendar#settings").
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	136	"items": [ # List of user settings.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	137	{
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	138	"id": "A String", # The id of the user setting.
				139	"etag": "A String", # ETag of the resource.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	140	"kind": "calendar#setting", # Type of the resource ("calendar#setting").
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	141	"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.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	142	},
				143	],
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	144	}</pre>
				145	</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
				151	Args:
				152	previous_request: The request for the previous page. (required)
				153	previous_response: The response from the request for the previous page. (required)
				154
				155	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	156	A request object that you can call 'execute()' on to request the next
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	157	page. Returns None if there are no more items in the collection.
				158	</pre>
				159	</div>
				160
				161	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	162	<code class="details" id="watch">watch(body=None, maxResults=None, pageToken=None, syncToken=None)</code>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	163	<pre>Watch for changes to Settings resources.
				164
				165	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	166	body: object, The request body.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	167	The object takes the form of:
				168
				169	{
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	170	"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	171	"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	172	"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
				173	"type": "A String", # The type of delivery mechanism used for this channel.
				174	"id": "A String", # A UUID or similar unique string that identifies this channel.
				175	"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
				176	"resourceUri": "A String", # A version-specific identifier for the watched resource.
				177	"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	178	"params": { # Additional parameters controlling delivery channel behavior. Optional.
				179	"a_key": "A String", # Declares a new parameter by name.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	180	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	181	"address": "A String", # The address where notifications are delivered for this channel.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	182	}
				183
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	184	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.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	185	pageToken: string, Token specifying which result page to return. Optional.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	186	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.
				187	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.
				188	Learn more about incremental synchronization.
				189	Optional. The default is to return all entries.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	190
				191	Returns:
				192	An object of the form:
				193
				194	{
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	195	"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	196	"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	197	"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
				198	"type": "A String", # The type of delivery mechanism used for this channel.
				199	"id": "A String", # A UUID or similar unique string that identifies this channel.
				200	"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
				201	"resourceUri": "A String", # A version-specific identifier for the watched resource.
				202	"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	203	"params": { # Additional parameters controlling delivery channel behavior. Optional.
				204	"a_key": "A String", # Declares a new parameter by name.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	205	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	206	"address": "A String", # The address where notifications are delivered for this channel.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	207	}</pre>
				208	</div>
				209
				210	</body></html>