Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / cc94ec86e652769e9d3d5cb6d6491efb8d76dd21 / . / docs / dyn / chat_v1.spaces.html
blob: e34a827a6b5c9192afe1aeb0083ef0313e650a46 [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></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="chat_v1.spaces.members.html">members()</a></code>
79</p>
80<p class="firstline">Returns the members Resource.</p>
81
82<p class="toc_element">
83 <code><a href="chat_v1.spaces.messages.html">messages()</a></code>
84</p>
85<p class="firstline">Returns the messages Resource.</p>
86
87<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88 <code><a href="#close">close()</a></code></p>
89<p class="firstline">Close httplib2 connections.</p>
90<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]91 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
92<p class="firstline">Returns a space.</p>
93<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]94 <code><a href="#list">list(pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]95<p class="firstline">Lists spaces the caller is a member of.</p>
96<p class="toc_element">
97 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
98<p class="firstline">Retrieves the next page of results.</p>
99<h3>Method Details</h3>
100<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]101 <code class="details" id="close">close()</code>
102 <pre>Close httplib2 connections.</pre>
103</div>
104
105<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106 <code class="details" id="get">get(name, x__xgafv=None)</code>
107 <pre>Returns a space.
108
109Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]110 name: string, Required. Resource name of the space, in the form &quot;spaces/*&quot;. Example: spaces/AAAAMpdlehY (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]111 x__xgafv: string, V1 error format.
112 Allowed values
113 1 - v1 error format
114 2 - v2 error format
115
116Returns:
117 An object of the form:
118
119 { # A room or DM in Hangouts Chat.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]120 &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.
121 &quot;name&quot;: &quot;A String&quot;, # Resource name of the space, in the form &quot;spaces/*&quot;. Example: spaces/AAAAMpdlehYs
122 &quot;singleUserBotDm&quot;: True or False, # Whether the space is a DM between a bot and a single human.
123 &quot;threaded&quot;: True or False, # Whether the messages are threaded in this space.
124 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of a space. This is deprecated. Use `single_user_bot_dm` instead.
125}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]126</div>
127
128<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]129 <code class="details" id="list">list(pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]130 <pre>Lists spaces the caller is a member of.
131
132Args:
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]133 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 Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]134 pageToken: string, A token identifying a page of results the server should return.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]135 x__xgafv: string, V1 error format.
136 Allowed values
137 1 - v1 error format
138 2 - v2 error format
139
140Returns:
141 An object of the form:
142
143 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]144 &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.
145 &quot;spaces&quot;: [ # List of spaces in the requested (or first) page.
146 { # A room or DM in Hangouts Chat.
147 &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.
148 &quot;name&quot;: &quot;A String&quot;, # Resource name of the space, in the form &quot;spaces/*&quot;. Example: spaces/AAAAMpdlehYs
149 &quot;singleUserBotDm&quot;: True or False, # Whether the space is a DM between a bot and a single human.
150 &quot;threaded&quot;: True or False, # Whether the messages are threaded in this space.
151 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of a space. This is deprecated. Use `single_user_bot_dm` instead.
152 },
153 ],
154}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]155</div>
156
157<div class="method">
158 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
159 <pre>Retrieves the next page of results.
160
161Args:
162 previous_request: The request for the previous page. (required)
163 previous_response: The response from the request for the previous page. (required)
164
165Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]166 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]167 page. Returns None if there are no more items in the collection.
168 </pre>
169</div>
170
171</body></html>