blob: 908572eb1b7263ffc3aacc309b39286c5c15be4a [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">Hangouts Chat API</a> . <a href="chat_v1.spaces.html">spaces</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="chat_v1.spaces.members.html">members()</a></code>
</p>
<p class="firstline">Returns the members Resource.</p>
<p class="toc_element">
<code><a href="chat_v1.spaces.messages.html">messages()</a></code>
</p>
<p class="firstline">Returns the messages Resource.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a space.</p>
<p class="toc_element">
<code><a href="#list">list(pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists spaces the caller is a member of.</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="get">get(name, x__xgafv=None)</code>
<pre>Returns a space.
Args:
name: string, Required. Resource name of the space, in the form &quot;spaces/*&quot;.
Example: spaces/AAAAMpdlehY (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A room or DM in Hangouts Chat.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name (only if the space is a room).
# Please note that this field might not be populated in direct messages
# between humans.
&quot;threaded&quot;: True or False, # Whether the messages are threaded in this space.
&quot;name&quot;: &quot;A String&quot;, # Resource name of the space, in the form &quot;spaces/*&quot;.
#
# Example: spaces/AAAAMpdlehYs
&quot;type&quot;: &quot;A String&quot;, # Output only. The type of a space.
# This is deprecated. Use `single_user_bot_dm` instead.
&quot;singleUserBotDm&quot;: True or False, # Whether the space is a DM between a bot and a single human.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists spaces the caller is a member of.
Args:
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;spaces&quot;: [ # List of spaces in the requested (or first) page.
{ # A room or DM in Hangouts Chat.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name (only if the space is a room).
# Please note that this field might not be populated in direct messages
# between humans.
&quot;threaded&quot;: True or False, # Whether the messages are threaded in this space.
&quot;name&quot;: &quot;A String&quot;, # Resource name of the space, in the form &quot;spaces/*&quot;.
#
# Example: spaces/AAAAMpdlehYs
&quot;type&quot;: &quot;A String&quot;, # Output only. The type of a space.
# This is deprecated. Use `single_user_bot_dm` instead.
&quot;singleUserBotDm&quot;: True or False, # Whether the space is a DM between a bot and a single human.
},
],
&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. Tokens expire in an hour. An error is thrown
# if an expired token is passed.
}</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>