Debian Codegraph @

docs/dyn/chat_v1.users.sections.items.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.sections.html">sections</a> . <a href="chat_v1.users.sections.items.html">items</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Lists items in a section. Only spaces can be section items. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). 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.sections` - `https://www.googleapis.com/auth/chat.users.sections.readonly`</p>
83 <p class="toc_element">
84 <code><a href="#list_next">list_next()</a></code></p>
85 <p class="firstline">Retrieves the next page of results.</p>
86 <p class="toc_element">
87 <code><a href="#move">move(name, body=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Moves an item from one section to another. For example, if a section contains spaces, this method can be used to move a space to a different section. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). 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.sections`</p>
89 <h3>Method Details</h3>
90 <div class="method">
91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93 </div>
94
95 <div class="method">
96 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
97 <pre>Lists items in a section. Only spaces can be section items. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). 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.sections` - `https://www.googleapis.com/auth/chat.users.sections.readonly`
98
99 Args:
100 parent: string, Required. The parent, which is the section resource name that owns this collection of section items. Only supports listing section items for the calling user. When you&#x27;re filtering by space, use the wildcard `-` to search across all sections. For example, `users/{user}/sections/-`. Format: `users/{user}/sections/{section}` (required)
101 filter: string, Optional. A query filter. Currently only supports filtering by space. For example, `space = spaces/{space}`. Invalid queries are rejected with an `INVALID_ARGUMENT` error.
102 pageSize: integer, Optional. The maximum number of section items to return. The service may return fewer than this value. If unspecified, at most 10 section items will be returned. The maximum value is 100. If you use a value more than 100, it&#x27;s automatically changed to 100. Negative values return an `INVALID_ARGUMENT` error.
103 pageToken: string, Optional. A page token, received from a previous list section items call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.
104 x__xgafv: string, V1 error format.
105 Allowed values
106 1 - v1 error format
107 2 - v2 error format
108
109 Returns:
110 An object of the form:
111
112 { # Response message for listing section items.
113 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
114 &quot;sectionItems&quot;: [ # The section items from the specified section.
115 { # A user&#x27;s defined section item. This is used to represent section items, such as spaces, grouped under a section.
116 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the section item. Format: `users/{user}/sections/{section}/items/{item}`
117 &quot;space&quot;: &quot;A String&quot;, # Optional. The space resource name. Format: `spaces/{space}`
118 },
119 ],
120 }</pre>
121 </div>
122
123 <div class="method">
124 <code class="details" id="list_next">list_next()</code>
125 <pre>Retrieves the next page of results.
126
127 Args:
128 previous_request: The request for the previous page. (required)
129 previous_response: The response from the request for the previous page. (required)
130
131 Returns:
132 A request object that you can call &#x27;execute()&#x27; on to request the next
133 page. Returns None if there are no more items in the collection.
134 </pre>
135 </div>
136
137 <div class="method">
138 <code class="details" id="move">move(name, body=None, x__xgafv=None)</code>
139 <pre>Moves an item from one section to another. For example, if a section contains spaces, this method can be used to move a space to a different section. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). 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.sections`
140
141 Args:
142 name: string, Required. The resource name of the section item to move. Format: `users/{user}/sections/{section}/items/{item}` (required)
143 body: object, The request body.
144 The object takes the form of:
145
146 { # Request message for moving a section item across sections.
147 &quot;targetSection&quot;: &quot;A String&quot;, # Required. The resource name of the section to move the section item to. Format: `users/{user}/sections/{section}`
148 }
149
150 x__xgafv: string, V1 error format.
151 Allowed values
152 1 - v1 error format
153 2 - v2 error format
154
155 Returns:
156 An object of the form:
157
158 { # Response message for moving a section item.
159 &quot;sectionItem&quot;: { # A user&#x27;s defined section item. This is used to represent section items, such as spaces, grouped under a section. # The updated section item.
160 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the section item. Format: `users/{user}/sections/{section}/items/{item}`
161 &quot;space&quot;: &quot;A String&quot;, # Optional. The space resource name. Format: `spaces/{space}`
162 },
163 }</pre>
164 </div>
165
166 </body></html>