Blame - docs/dyn/chat_v1.spaces.members.html - platform/external/python/google-api-python-client

blob: 58d2a7df48c3e88724445844c9308cebae1975c9 [file] [log] [blame]

Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[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="chat_v1.html">Hangouts Chat API</a> . <a href="chat_v1.spaces.html">spaces</a> . <a href="chat_v1.spaces.members.html">members</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				79	<p class="firstline">Returns a membership.</p>
				80	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	81	<code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	82	<p class="firstline">Lists human memberships in a space.</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	<h3>Method Details</h3>
				87	<div class="method">
				88	<code class="details" id="get">get(name, x__xgafv=None)</code>
				89	<pre>Returns a membership.
				90
				91	Args:
				92	name: string, Required. Resource name of the membership to be retrieved, in the form
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	93	"spaces//members/".
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	94
				95	Example: spaces/AAAAMpdlehY/members/105115627578887013105 (required)
				96	x__xgafv: string, V1 error format.
				97	Allowed values
				98	1 - v1 error format
				99	2 - v2 error format
				100
				101	Returns:
				102	An object of the form:
				103
				104	{ # Represents a membership relation in Hangouts Chat.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	105	"name": "A String", # Resource name of the membership, in the form "spaces//members/".
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	106	#
				107	# Example: spaces/AAAAMpdlehY/members/105115627578887013105
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	108	"member": { # A user in Hangouts Chat. # Member details.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	109	"name": "A String", # Resource name, in the format "users/*".
				110	"displayName": "A String", # The user's display name.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	111	"type": "A String", # User type.
				112	"domainId": "A String", # Obfuscated domain information.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	113	},
				114	"createTime": "A String", # The creation time of the membership a.k.a the time at which the member
				115	# joined the space, if applicable.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	116	"state": "A String", # State of the membership.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	117	}</pre>
				118	</div>
				119
				120	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	121	<code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	122	<pre>Lists human memberships in a space.
				123
				124	Args:
				125	parent: string, Required. The resource name of the space for which membership list is to be
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	126	fetched, in the form "spaces/*".
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	127
				128	Example: spaces/AAAAMpdlehY (required)
				129	pageToken: string, A token identifying a page of results the server should return.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	130	pageSize: integer, Requested page size. The value is capped at 1000.
				131	Server may return fewer results than requested.
				132	If unspecified, server will default to 100.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	133	x__xgafv: string, V1 error format.
				134	Allowed values
				135	1 - v1 error format
				136	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	137
				138	Returns:
				139	An object of the form:
				140
				141	{
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	142	"memberships": [ # List of memberships in the requested (or first) page.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	143	{ # Represents a membership relation in Hangouts Chat.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	144	"name": "A String", # Resource name of the membership, in the form "spaces//members/".
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	145	#
				146	# Example: spaces/AAAAMpdlehY/members/105115627578887013105
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	147	"member": { # A user in Hangouts Chat. # Member details.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	148	"name": "A String", # Resource name, in the format "users/*".
				149	"displayName": "A String", # The user's display name.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	150	"type": "A String", # User type.
				151	"domainId": "A String", # Obfuscated domain information.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	152	},
				153	"createTime": "A String", # The creation time of the membership a.k.a the time at which the member
				154	# joined the space, if applicable.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	155	"state": "A String", # State of the membership.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	156	},
				157	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	158	"nextPageToken": "A String", # Continuation token to retrieve the next page of results. It will be empty
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	159	# for the last page of results.
				160	}</pre>
				161	</div>
				162
				163	<div class="method">
				164	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				165	<pre>Retrieves the next page of results.
				166
				167	Args:
				168	previous_request: The request for the previous page. (required)
				169	previous_response: The response from the request for the previous page. (required)
				170
				171	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	172	A request object that you can call 'execute()' on to request the next
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	173	page. Returns None if there are no more items in the collection.
				174	</pre>
				175	</div>
				176
				177	</body></html>