Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 8045c4550a7f366dd071a6ffb27dba362e59bf95 / . / docs / dyn / chat_v1.spaces.members.html
blob: 330620b052a3d727650655c77f418a876073447a [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
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]75<h1><a href="chat_v1.html">Google Chat API</a> . <a href="chat_v1.spaces.html">spaces</a> . <a href="chat_v1.spaces.members.html">members</a></h1>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-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">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]81 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Returns a membership.</p>
83<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]84 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]85<p class="firstline">Lists human memberships in a space.</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<h3>Method Details</h3>
90<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93</div>
94
95<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]96 <code class="details" id="get">get(name, x__xgafv=None)</code>
97 <pre>Returns a membership.
98
99Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]100 name: string, Required. Resource name of the membership to be retrieved, in the form &quot;spaces/*/members/*&quot;. Example: spaces/AAAAMpdlehY/members/105115627578887013105 (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]101 x__xgafv: string, V1 error format.
102 Allowed values
103 1 - v1 error format
104 2 - v2 error format
105
106Returns:
107 An object of the form:
108
109 { # Represents a membership relation in Hangouts Chat.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]110 &quot;createTime&quot;: &quot;A String&quot;, # The creation time of the membership a.k.a the time at which the member joined the space, if applicable.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]111 &quot;member&quot;: { # A user in Google Chat. # A User in Hangout Chat
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]112 &quot;displayName&quot;: &quot;A String&quot;, # The user&#x27;s display name.
113 &quot;domainId&quot;: &quot;A String&quot;, # Obfuscated domain information.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]114 &quot;isAnonymous&quot;: True or False, # True when the user is deleted or the user&#x27;s profile is not visible.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]115 &quot;name&quot;: &quot;A String&quot;, # Resource name, in the format &quot;users/*&quot;.
116 &quot;type&quot;: &quot;A String&quot;, # User type.
117 },
118 &quot;name&quot;: &quot;A String&quot;,
119 &quot;state&quot;: &quot;A String&quot;, # State of the membership.
120}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]121</div>
122
123<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]124 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]125 <pre>Lists human memberships in a space.
126
127Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]128 parent: string, Required. The resource name of the space for which membership list is to be fetched, in the form &quot;spaces/*&quot;. Example: spaces/AAAAMpdlehY (required)
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]129 pageSize: integer, Requested page size. The value is capped at 1000. Server may return fewer results than requested. If unspecified, server will default to 100.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]130 pageToken: string, A token identifying a page of results the server should return.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]131 x__xgafv: string, V1 error format.
132 Allowed values
133 1 - v1 error format
134 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]135
136Returns:
137 An object of the form:
138
139 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]140 &quot;memberships&quot;: [ # List of memberships in the requested (or first) page.
141 { # Represents a membership relation in Hangouts Chat.
142 &quot;createTime&quot;: &quot;A String&quot;, # The creation time of the membership a.k.a the time at which the member joined the space, if applicable.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]143 &quot;member&quot;: { # A user in Google Chat. # A User in Hangout Chat
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]144 &quot;displayName&quot;: &quot;A String&quot;, # The user&#x27;s display name.
145 &quot;domainId&quot;: &quot;A String&quot;, # Obfuscated domain information.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]146 &quot;isAnonymous&quot;: True or False, # True when the user is deleted or the user&#x27;s profile is not visible.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]147 &quot;name&quot;: &quot;A String&quot;, # Resource name, in the format &quot;users/*&quot;.
148 &quot;type&quot;: &quot;A String&quot;, # User type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]149 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]150 &quot;name&quot;: &quot;A String&quot;,
151 &quot;state&quot;: &quot;A String&quot;, # State of the membership.
152 },
153 ],
154 &quot;nextPageToken&quot;: &quot;A String&quot;, # Continuation token to retrieve the next page of results. It will be empty for the last page of results.
155}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]156</div>
157
158<div class="method">
159 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
160 <pre>Retrieves the next page of results.
161
162Args:
163 previous_request: The request for the previous page. (required)
164 previous_response: The response from the request for the previous page. (required)
165
166Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]167 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]168 page. Returns None if there are no more items in the collection.
169 </pre>
170</div>
171
172</body></html>