blob: 330620b052a3d727650655c77f418a876073447a [file] [log] [blame]
<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="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>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a membership.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists human memberships in a space.</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>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Returns a membership.
Args:
name: string, Required. Resource name of the membership to be retrieved, in the form &quot;spaces/*/members/*&quot;. Example: spaces/AAAAMpdlehY/members/105115627578887013105 (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a membership relation in Hangouts Chat.
&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.
&quot;member&quot;: { # A user in Google Chat. # A User in Hangout Chat
&quot;displayName&quot;: &quot;A String&quot;, # The user&#x27;s display name.
&quot;domainId&quot;: &quot;A String&quot;, # Obfuscated domain information.
&quot;isAnonymous&quot;: True or False, # True when the user is deleted or the user&#x27;s profile is not visible.
&quot;name&quot;: &quot;A String&quot;, # Resource name, in the format &quot;users/*&quot;.
&quot;type&quot;: &quot;A String&quot;, # User type.
},
&quot;name&quot;: &quot;A String&quot;,
&quot;state&quot;: &quot;A String&quot;, # State of the membership.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists human memberships in a space.
Args:
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)
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.
pageToken: string, A token identifying a page of results the server should return.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
&quot;memberships&quot;: [ # List of memberships in the requested (or first) page.
{ # Represents a membership relation in Hangouts Chat.
&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.
&quot;member&quot;: { # A user in Google Chat. # A User in Hangout Chat
&quot;displayName&quot;: &quot;A String&quot;, # The user&#x27;s display name.
&quot;domainId&quot;: &quot;A String&quot;, # Obfuscated domain information.
&quot;isAnonymous&quot;: True or False, # True when the user is deleted or the user&#x27;s profile is not visible.
&quot;name&quot;: &quot;A String&quot;, # Resource name, in the format &quot;users/*&quot;.
&quot;type&quot;: &quot;A String&quot;, # User type.
},
&quot;name&quot;: &quot;A String&quot;,
&quot;state&quot;: &quot;A String&quot;, # State of the membership.
},
],
&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.
}</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 &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>