Debian Codegraph @

docs/dyn/chat_v1.users.spaces.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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">Google Chat API</a> . <a href="chat_v1.users.html">users</a> . <a href="chat_v1.users.spaces.html">spaces</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="chat_v1.users.spaces.spaceNotificationSetting.html">spaceNotificationSetting()</a></code>
79 </p>
80 <p class="firstline">Returns the spaceNotificationSetting Resource.</p>
81
82 <p class="toc_element">
83 <code><a href="chat_v1.users.spaces.threads.html">threads()</a></code>
84 </p>
85 <p class="firstline">Returns the threads Resource.</p>
86
87 <p class="toc_element">
88 <code><a href="#close">close()</a></code></p>
89 <p class="firstline">Close httplib2 connections.</p>
90 <p class="toc_element">
91 <code><a href="#getSpaceReadState">getSpaceReadState(name, x__xgafv=None)</a></code></p>
92 <p class="firstline">Returns details about a user's read state within a space, used to identify read and unread messages. For an example, see [Get details about a user's space read state](https://developers.google.com/workspace/chat/get-space-read-state). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate.readonly` - `https://www.googleapis.com/auth/chat.users.readstate`</p>
93 <p class="toc_element">
94 <code><a href="#updateSpaceReadState">updateSpaceReadState(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
95 <p class="firstline">Updates a user's read state within a space, used to identify read and unread messages. For an example, see [Update a user's space read state](https://developers.google.com/workspace/chat/update-space-read-state). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate`</p>
96 <h3>Method Details</h3>
97 <div class="method">
98 <code class="details" id="close">close()</code>
99 <pre>Close httplib2 connections.</pre>
100 </div>
101
102 <div class="method">
103 <code class="details" id="getSpaceReadState">getSpaceReadState(name, x__xgafv=None)</code>
104 <pre>Returns details about a user&#x27;s read state within a space, used to identify read and unread messages. For an example, see [Get details about a user&#x27;s space read state](https://developers.google.com/workspace/chat/get-space-read-state). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate.readonly` - `https://www.googleapis.com/auth/chat.users.readstate`
105
106 Args:
107 name: string, Required. Resource name of the space read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me/spaces/{space}/spaceReadState`. - Their Workspace email address. For example, `users/[email protected]/spaces/{space}/spaceReadState`. - Their user id. For example, `users/123456789/spaces/{space}/spaceReadState`. Format: users/{user}/spaces/{space}/spaceReadState (required)
108 x__xgafv: string, V1 error format.
109 Allowed values
110 1 - v1 error format
111 2 - v2 error format
112
113 Returns:
114 An object of the form:
115
116 { # A user&#x27;s read state within a space, used to identify read and unread messages.
117 &quot;lastReadTime&quot;: &quot;A String&quot;, # Optional. The time when the user&#x27;s space read state was updated. Usually this corresponds with either the timestamp of the last read message, or a timestamp specified by the user to mark the last read position in a space.
118 &quot;name&quot;: &quot;A String&quot;, # Resource name of the space read state. Format: `users/{user}/spaces/{space}/spaceReadState`
119 }</pre>
120 </div>
121
122 <div class="method">
123 <code class="details" id="updateSpaceReadState">updateSpaceReadState(name, body=None, updateMask=None, x__xgafv=None)</code>
124 <pre>Updates a user&#x27;s read state within a space, used to identify read and unread messages. For an example, see [Update a user&#x27;s space read state](https://developers.google.com/workspace/chat/update-space-read-state). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate`
125
126 Args:
127 name: string, Resource name of the space read state. Format: `users/{user}/spaces/{space}/spaceReadState` (required)
128 body: object, The request body.
129 The object takes the form of:
130
131 { # A user&#x27;s read state within a space, used to identify read and unread messages.
132 &quot;lastReadTime&quot;: &quot;A String&quot;, # Optional. The time when the user&#x27;s space read state was updated. Usually this corresponds with either the timestamp of the last read message, or a timestamp specified by the user to mark the last read position in a space.
133 &quot;name&quot;: &quot;A String&quot;, # Resource name of the space read state. Format: `users/{user}/spaces/{space}/spaceReadState`
134 }
135
136 updateMask: string, Required. The field paths to update. Currently supported field paths: - `last_read_time` When the `last_read_time` is before the latest message create time, the space appears as unread in the UI. To mark the space as read, set `last_read_time` to any value later (larger) than the latest message create time. The `last_read_time` is coerced to match the latest message create time. Note that the space read state only affects the read state of messages that are visible in the space&#x27;s top-level conversation. Replies in threads are unaffected by this timestamp, and instead rely on the thread read state.
137 x__xgafv: string, V1 error format.
138 Allowed values
139 1 - v1 error format
140 2 - v2 error format
141
142 Returns:
143 An object of the form:
144
145 { # A user&#x27;s read state within a space, used to identify read and unread messages.
146 &quot;lastReadTime&quot;: &quot;A String&quot;, # Optional. The time when the user&#x27;s space read state was updated. Usually this corresponds with either the timestamp of the last read message, or a timestamp specified by the user to mark the last read position in a space.
147 &quot;name&quot;: &quot;A String&quot;, # Resource name of the space read state. Format: `users/{user}/spaces/{space}/spaceReadState`
148 }</pre>
149 </div>
150
151 </body></html>