Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3bf2781e29cb828409f3a8a21939323286524569 / . / docs / dyn / chat_v1.spaces.members.html
blob: 4c0db6c7cd6d23aa46fa3a3cf94bcb626eccd234 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[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="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">
81 <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
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
91Args:
92 name: string, Required. Resource name of the membership to be retrieved, in the form
93"spaces/*/members/*".
94
95Example: 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
101Returns:
102 An object of the form:
103
104 { # Represents a membership relation in Hangouts Chat.
105 "member": { # A user in Hangouts Chat. # Member details.
106 "displayName": "A String", # The user's display name.
107 "type": "A String", # User type.
108 "name": "A String", # Resource name, in the format "users/*".
109 },
110 "state": "A String", # State of the membership.
111 "createTime": "A String", # The creation time of the membership a.k.a the time at which the member
112 # joined the space, if applicable.
113 "name": "A String", # Resource name of the membership, in the form "spaces/*/members/*".
114 #
115 # Example: spaces/AAAAMpdlehY/members/105115627578887013105
116 }</pre>
117</div>
118
119<div class="method">
120 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
121 <pre>Lists human memberships in a space.
122
123Args:
124 parent: string, Required. The resource name of the space for which membership list is to be
125fetched, in the form "spaces/*".
126
127Example: spaces/AAAAMpdlehY (required)
128 pageToken: string, A token identifying a page of results the server should return.
129 x__xgafv: string, V1 error format.
130 Allowed values
131 1 - v1 error format
132 2 - v2 error format
133 pageSize: integer, Requested page size. The value is capped at 1000.
134Server may return fewer results than requested.
135If unspecified, server will default to 100.
136
137Returns:
138 An object of the form:
139
140 {
141 "memberships": [ # List of memberships in the requested (or first) page.
142 { # Represents a membership relation in Hangouts Chat.
143 "member": { # A user in Hangouts Chat. # Member details.
144 "displayName": "A String", # The user's display name.
145 "type": "A String", # User type.
146 "name": "A String", # Resource name, in the format "users/*".
147 },
148 "state": "A String", # State of the membership.
149 "createTime": "A String", # The creation time of the membership a.k.a the time at which the member
150 # joined the space, if applicable.
151 "name": "A String", # Resource name of the membership, in the form "spaces/*/members/*".
152 #
153 # Example: spaces/AAAAMpdlehY/members/105115627578887013105
154 },
155 ],
156 "nextPageToken": "A String", # Continuation token to retrieve the next page of results. It will be empty
157 # for the last page of results.
158 }</pre>
159</div>
160
161<div class="method">
162 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
163 <pre>Retrieves the next page of results.
164
165Args:
166 previous_request: The request for the previous page. (required)
167 previous_response: The response from the request for the previous page. (required)
168
169Returns:
170 A request object that you can call 'execute()' on to request the next
171 page. Returns None if there are no more items in the collection.
172 </pre>
173</div>
174
175</body></html>