Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / chat_v1.spaces.html
blob: 908572eb1b7263ffc3aacc309b39286c5c15be4a [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">
88 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
89<p class="firstline">Returns a space.</p>
90<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]91 <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]92<p class="firstline">Lists spaces the caller is a member of.</p>
93<p class="toc_element">
94 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
95<p class="firstline">Retrieves the next page of results.</p>
96<h3>Method Details</h3>
97<div class="method">
98 <code class="details" id="get">get(name, x__xgafv=None)</code>
99 <pre>Returns a space.
100
101Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]102 name: string, Required. Resource name of the space, in the form &quot;spaces/*&quot;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103
104Example: spaces/AAAAMpdlehY (required)
105 x__xgafv: string, V1 error format.
106 Allowed values
107 1 - v1 error format
108 2 - v2 error format
109
110Returns:
111 An object of the form:
112
113 { # A room or DM in Hangouts Chat.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]114 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name (only if the space is a room).
115 # Please note that this field might not be populated in direct messages
116 # between humans.
117 &quot;threaded&quot;: True or False, # Whether the messages are threaded in this space.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]118 &quot;name&quot;: &quot;A String&quot;, # Resource name of the space, in the form &quot;spaces/*&quot;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]119 #
120 # Example: spaces/AAAAMpdlehYs
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]121 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of a space.
122 # This is deprecated. Use `single_user_bot_dm` instead.
123 &quot;singleUserBotDm&quot;: True or False, # Whether the space is a DM between a bot and a single human.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]124 }</pre>
125</div>
126
127<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]128 <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]129 <pre>Lists spaces the caller is a member of.
130
131Args:
132 pageSize: integer, Requested page size. The value is capped at 1000.
133Server may return fewer results than requested.
134If unspecified, server will default to 100.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]135 pageToken: string, A token identifying a page of results the server should return.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]136 x__xgafv: string, V1 error format.
137 Allowed values
138 1 - v1 error format
139 2 - v2 error format
140
141Returns:
142 An object of the form:
143
144 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]145 &quot;spaces&quot;: [ # List of spaces in the requested (or first) page.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]146 { # A room or DM in Hangouts Chat.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]147 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name (only if the space is a room).
148 # Please note that this field might not be populated in direct messages
149 # between humans.
150 &quot;threaded&quot;: True or False, # Whether the messages are threaded in this space.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]151 &quot;name&quot;: &quot;A String&quot;, # Resource name of the space, in the form &quot;spaces/*&quot;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]152 #
153 # Example: spaces/AAAAMpdlehYs
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]154 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of a space.
155 # This is deprecated. Use `single_user_bot_dm` instead.
156 &quot;singleUserBotDm&quot;: True or False, # Whether the space is a DM between a bot and a single human.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]157 },
158 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]159 &quot;nextPageToken&quot;: &quot;A String&quot;, # Continuation token to retrieve the next page of results. It will be empty
160 # for the last page of results. Tokens expire in an hour. An error is thrown
161 # if an expired token is passed.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]162 }</pre>
163</div>
164
165<div class="method">
166 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
167 <pre>Retrieves the next page of results.
168
169Args:
170 previous_request: The request for the previous page. (required)
171 previous_response: The response from the request for the previous page. (required)
172
173Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]174 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]175 page. Returns None if there are no more items in the collection.
176 </pre>
177</div>
178
179</body></html>