forked from slackapi/python-slack-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathchat_stream.html
More file actions
506 lines (481 loc) · 25.8 KB
/
chat_stream.html
File metadata and controls
506 lines (481 loc) · 25.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
<meta name="generator" content="pdoc3 0.11.6">
<title>slack_sdk.web.chat_stream API documentation</title>
<meta name="description" content="">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source > summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible;min-width:max-content}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin:1em 0}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => {
hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
hljs.highlightAll();
/* Collapse source docstrings */
setTimeout(() => {
[...document.querySelectorAll('.hljs.language-python > .hljs-string')]
.filter(el => el.innerHTML.length > 200 && ['"""', "'''"].includes(el.innerHTML.substring(0, 3)))
.forEach(el => {
let d = document.createElement('details');
d.classList.add('hljs-string');
d.innerHTML = '<summary>"""</summary>' + el.innerHTML.substring(3);
el.replaceWith(d);
});
}, 100);
})</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>slack_sdk.web.chat_stream</code></h1>
</header>
<section id="section-intro">
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="slack_sdk.web.chat_stream.ChatStream"><code class="flex name class">
<span>class <span class="ident">ChatStream</span></span>
<span>(</span><span>client: WebClient,<br>*,<br>channel: str,<br>logger: logging.Logger,<br>thread_ts: str,<br>buffer_size: int,<br>recipient_team_id: str | None = None,<br>recipient_user_id: str | None = None,<br>**kwargs)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class ChatStream:
"""A helper class for streaming markdown text into a conversation using the chat streaming APIs.
This class provides a convenient interface for the chat.startStream, chat.appendStream, and chat.stopStream API
methods, with automatic buffering and state management.
"""
def __init__(
self,
client: "WebClient",
*,
channel: str,
logger: logging.Logger,
thread_ts: str,
buffer_size: int,
recipient_team_id: Optional[str] = None,
recipient_user_id: Optional[str] = None,
**kwargs,
):
"""Initialize a new ChatStream instance.
The __init__ method creates a unique ChatStream instance that keeps track of one chat stream.
Args:
client: The WebClient instance to use for API calls.
channel: An encoded ID that represents a channel, private group, or DM.
logger: A logging channel for outputs.
thread_ts: Provide another message's ts value to reply to. Streamed messages should always be replies to a user
request.
recipient_team_id: The encoded ID of the team the user receiving the streaming text belongs to. Required when
streaming to channels.
recipient_user_id: The encoded ID of the user to receive the streaming text. Required when streaming to channels.
buffer_size: The length of markdown_text to buffer in-memory before calling a method. Increasing this value
decreases the number of method calls made for the same amount of text, which is useful to avoid rate limits.
**kwargs: Additional arguments passed to the underlying API calls.
"""
self._client = client
self._logger = logger
self._token: Optional[str] = kwargs.pop("token", None)
self._stream_args = {
"channel": channel,
"thread_ts": thread_ts,
"recipient_team_id": recipient_team_id,
"recipient_user_id": recipient_user_id,
**kwargs,
}
self._buffer = ""
self._state = "starting"
self._stream_ts: Optional[str] = None
self._buffer_size = buffer_size
def append(
self,
*,
markdown_text: str,
**kwargs,
) -> Optional[SlackResponse]:
"""Append to the stream.
The "append" method appends to the chat stream being used. This method can be called multiple times. After the stream
is stopped this method cannot be called.
Args:
markdown_text: Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is
what will be appended to the message received so far.
**kwargs: Additional arguments passed to the underlying API calls.
Returns:
SlackResponse if the buffer was flushed, None if buffering.
Raises:
SlackRequestError: If the stream is already completed.
Example:
```python
streamer = client.chat_stream(
channel="C0123456789",
thread_ts="1700000001.123456",
recipient_team_id="T0123456789",
recipient_user_id="U0123456789",
)
streamer.append(markdown_text="**hello wo")
streamer.append(markdown_text="rld!**")
streamer.stop()
```
"""
if self._state == "completed":
raise e.SlackRequestError(f"Cannot append to stream: stream state is {self._state}")
if kwargs.get("token"):
self._token = kwargs.pop("token")
self._buffer += markdown_text
if len(self._buffer) >= self._buffer_size:
return self._flush_buffer(**kwargs)
details = {
"buffer_length": len(self._buffer),
"buffer_size": self._buffer_size,
"channel": self._stream_args.get("channel"),
"recipient_team_id": self._stream_args.get("recipient_team_id"),
"recipient_user_id": self._stream_args.get("recipient_user_id"),
"thread_ts": self._stream_args.get("thread_ts"),
}
self._logger.debug(f"ChatStream appended to buffer: {json.dumps(details)}")
return None
def stop(
self,
*,
markdown_text: Optional[str] = None,
blocks: Optional[Union[str, Sequence[Union[Dict, Block]]]] = None,
metadata: Optional[Union[Dict, Metadata]] = None,
**kwargs,
) -> SlackResponse:
"""Stop the stream and finalize the message.
Args:
blocks: A list of blocks that will be rendered at the bottom of the finalized message.
markdown_text: Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is
what will be appended to the message received so far.
metadata: JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you
post to Slack is accessible to any app or user who is a member of that workspace.
**kwargs: Additional arguments passed to the underlying API calls.
Returns:
SlackResponse from the chat.stopStream API call.
Raises:
SlackRequestError: If the stream is already completed.
Example:
```python
streamer = client.chat_stream(
channel="C0123456789",
thread_ts="1700000001.123456",
recipient_team_id="T0123456789",
recipient_user_id="U0123456789",
)
streamer.append(markdown_text="**hello wo")
streamer.append(markdown_text="rld!**")
streamer.stop()
```
"""
if self._state == "completed":
raise e.SlackRequestError(f"Cannot stop stream: stream state is {self._state}")
if kwargs.get("token"):
self._token = kwargs.pop("token")
if markdown_text:
self._buffer += markdown_text
if not self._stream_ts:
response = self._client.chat_startStream(
**self._stream_args,
token=self._token,
)
if not response.get("ts"):
raise e.SlackRequestError("Failed to stop stream: stream not started")
self._stream_ts = str(response["ts"])
self._state = "in_progress"
response = self._client.chat_stopStream(
token=self._token,
channel=self._stream_args["channel"],
ts=self._stream_ts,
blocks=blocks,
markdown_text=self._buffer,
metadata=metadata,
**kwargs,
)
self._state = "completed"
return response
def _flush_buffer(self, **kwargs) -> SlackResponse:
"""Flush the internal buffer by making appropriate API calls."""
if not self._stream_ts:
response = self._client.chat_startStream(
**self._stream_args,
token=self._token,
**kwargs,
markdown_text=self._buffer,
)
self._stream_ts = response.get("ts")
self._state = "in_progress"
else:
response = self._client.chat_appendStream(
token=self._token,
channel=self._stream_args["channel"],
ts=self._stream_ts,
**kwargs,
markdown_text=self._buffer,
)
self._buffer = ""
return response</code></pre>
</details>
<div class="desc"><p>A helper class for streaming markdown text into a conversation using the chat streaming APIs.</p>
<p>This class provides a convenient interface for the chat.startStream, chat.appendStream, and chat.stopStream API
methods, with automatic buffering and state management.</p>
<p>Initialize a new ChatStream instance.</p>
<p>The <strong>init</strong> method creates a unique ChatStream instance that keeps track of one chat stream.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>client</code></strong></dt>
<dd>The WebClient instance to use for API calls.</dd>
<dt><strong><code>channel</code></strong></dt>
<dd>An encoded ID that represents a channel, private group, or DM.</dd>
<dt><strong><code>logger</code></strong></dt>
<dd>A logging channel for outputs.</dd>
<dt><strong><code>thread_ts</code></strong></dt>
<dd>Provide another message's ts value to reply to. Streamed messages should always be replies to a user
request.</dd>
<dt><strong><code>recipient_team_id</code></strong></dt>
<dd>The encoded ID of the team the user receiving the streaming text belongs to. Required when
streaming to channels.</dd>
<dt><strong><code>recipient_user_id</code></strong></dt>
<dd>The encoded ID of the user to receive the streaming text. Required when streaming to channels.</dd>
<dt><strong><code>buffer_size</code></strong></dt>
<dd>The length of markdown_text to buffer in-memory before calling a method. Increasing this value
decreases the number of method calls made for the same amount of text, which is useful to avoid rate limits.</dd>
<dt><strong><code>**kwargs</code></strong></dt>
<dd>Additional arguments passed to the underlying API calls.</dd>
</dl></div>
<h3>Methods</h3>
<dl>
<dt id="slack_sdk.web.chat_stream.ChatStream.append"><code class="name flex">
<span>def <span class="ident">append</span></span>(<span>self, *, markdown_text: str, **kwargs) ‑> <a title="slack_sdk.web.slack_response.SlackResponse" href="slack_response.html#slack_sdk.web.slack_response.SlackResponse">SlackResponse</a> | None</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def append(
self,
*,
markdown_text: str,
**kwargs,
) -> Optional[SlackResponse]:
"""Append to the stream.
The "append" method appends to the chat stream being used. This method can be called multiple times. After the stream
is stopped this method cannot be called.
Args:
markdown_text: Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is
what will be appended to the message received so far.
**kwargs: Additional arguments passed to the underlying API calls.
Returns:
SlackResponse if the buffer was flushed, None if buffering.
Raises:
SlackRequestError: If the stream is already completed.
Example:
```python
streamer = client.chat_stream(
channel="C0123456789",
thread_ts="1700000001.123456",
recipient_team_id="T0123456789",
recipient_user_id="U0123456789",
)
streamer.append(markdown_text="**hello wo")
streamer.append(markdown_text="rld!**")
streamer.stop()
```
"""
if self._state == "completed":
raise e.SlackRequestError(f"Cannot append to stream: stream state is {self._state}")
if kwargs.get("token"):
self._token = kwargs.pop("token")
self._buffer += markdown_text
if len(self._buffer) >= self._buffer_size:
return self._flush_buffer(**kwargs)
details = {
"buffer_length": len(self._buffer),
"buffer_size": self._buffer_size,
"channel": self._stream_args.get("channel"),
"recipient_team_id": self._stream_args.get("recipient_team_id"),
"recipient_user_id": self._stream_args.get("recipient_user_id"),
"thread_ts": self._stream_args.get("thread_ts"),
}
self._logger.debug(f"ChatStream appended to buffer: {json.dumps(details)}")
return None</code></pre>
</details>
<div class="desc"><p>Append to the stream.</p>
<p>The "append" method appends to the chat stream being used. This method can be called multiple times. After the stream
is stopped this method cannot be called.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>markdown_text</code></strong></dt>
<dd>Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is
what will be appended to the message received so far.</dd>
<dt><strong><code>**kwargs</code></strong></dt>
<dd>Additional arguments passed to the underlying API calls.</dd>
</dl>
<h2 id="returns">Returns</h2>
<p>SlackResponse if the buffer was flushed, None if buffering.</p>
<h2 id="raises">Raises</h2>
<dl>
<dt><code>SlackRequestError</code></dt>
<dd>If the stream is already completed.</dd>
</dl>
<h2 id="example">Example</h2>
<pre><code class="language-python">streamer = client.chat_stream(
channel="C0123456789",
thread_ts="1700000001.123456",
recipient_team_id="T0123456789",
recipient_user_id="U0123456789",
)
streamer.append(markdown_text="**hello wo")
streamer.append(markdown_text="rld!**")
streamer.stop()
</code></pre></div>
</dd>
<dt id="slack_sdk.web.chat_stream.ChatStream.stop"><code class="name flex">
<span>def <span class="ident">stop</span></span>(<span>self,<br>*,<br>markdown_text: str | None = None,<br>blocks: str | Sequence[Dict | <a title="slack_sdk.models.blocks.blocks.Block" href="../models/blocks/blocks.html#slack_sdk.models.blocks.blocks.Block">Block</a>] | None = None,<br>metadata: Dict | <a title="slack_sdk.models.metadata.Metadata" href="../models/metadata/index.html#slack_sdk.models.metadata.Metadata">Metadata</a> | None = None,<br>**kwargs) ‑> <a title="slack_sdk.web.slack_response.SlackResponse" href="slack_response.html#slack_sdk.web.slack_response.SlackResponse">SlackResponse</a></span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def stop(
self,
*,
markdown_text: Optional[str] = None,
blocks: Optional[Union[str, Sequence[Union[Dict, Block]]]] = None,
metadata: Optional[Union[Dict, Metadata]] = None,
**kwargs,
) -> SlackResponse:
"""Stop the stream and finalize the message.
Args:
blocks: A list of blocks that will be rendered at the bottom of the finalized message.
markdown_text: Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is
what will be appended to the message received so far.
metadata: JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you
post to Slack is accessible to any app or user who is a member of that workspace.
**kwargs: Additional arguments passed to the underlying API calls.
Returns:
SlackResponse from the chat.stopStream API call.
Raises:
SlackRequestError: If the stream is already completed.
Example:
```python
streamer = client.chat_stream(
channel="C0123456789",
thread_ts="1700000001.123456",
recipient_team_id="T0123456789",
recipient_user_id="U0123456789",
)
streamer.append(markdown_text="**hello wo")
streamer.append(markdown_text="rld!**")
streamer.stop()
```
"""
if self._state == "completed":
raise e.SlackRequestError(f"Cannot stop stream: stream state is {self._state}")
if kwargs.get("token"):
self._token = kwargs.pop("token")
if markdown_text:
self._buffer += markdown_text
if not self._stream_ts:
response = self._client.chat_startStream(
**self._stream_args,
token=self._token,
)
if not response.get("ts"):
raise e.SlackRequestError("Failed to stop stream: stream not started")
self._stream_ts = str(response["ts"])
self._state = "in_progress"
response = self._client.chat_stopStream(
token=self._token,
channel=self._stream_args["channel"],
ts=self._stream_ts,
blocks=blocks,
markdown_text=self._buffer,
metadata=metadata,
**kwargs,
)
self._state = "completed"
return response</code></pre>
</details>
<div class="desc"><p>Stop the stream and finalize the message.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>blocks</code></strong></dt>
<dd>A list of blocks that will be rendered at the bottom of the finalized message.</dd>
<dt><strong><code>markdown_text</code></strong></dt>
<dd>Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is
what will be appended to the message received so far.</dd>
<dt><strong><code>metadata</code></strong></dt>
<dd>JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you
post to Slack is accessible to any app or user who is a member of that workspace.</dd>
<dt><strong><code>**kwargs</code></strong></dt>
<dd>Additional arguments passed to the underlying API calls.</dd>
</dl>
<h2 id="returns">Returns</h2>
<p>SlackResponse from the chat.stopStream API call.</p>
<h2 id="raises">Raises</h2>
<dl>
<dt><code>SlackRequestError</code></dt>
<dd>If the stream is already completed.</dd>
</dl>
<h2 id="example">Example</h2>
<pre><code class="language-python">streamer = client.chat_stream(
channel="C0123456789",
thread_ts="1700000001.123456",
recipient_team_id="T0123456789",
recipient_user_id="U0123456789",
)
streamer.append(markdown_text="**hello wo")
streamer.append(markdown_text="rld!**")
streamer.stop()
</code></pre></div>
</dd>
</dl>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="slack_sdk.web" href="index.html">slack_sdk.web</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="slack_sdk.web.chat_stream.ChatStream" href="#slack_sdk.web.chat_stream.ChatStream">ChatStream</a></code></h4>
<ul class="">
<li><code><a title="slack_sdk.web.chat_stream.ChatStream.append" href="#slack_sdk.web.chat_stream.ChatStream.append">append</a></code></li>
<li><code><a title="slack_sdk.web.chat_stream.ChatStream.stop" href="#slack_sdk.web.chat_stream.ChatStream.stop">stop</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.6</a>.</p>
</footer>
</body>
</html>