Skip to main content

@slack/web-api / ChatAppendStreamArguments

Interface: ChatAppendStreamArguments

Defined in: packages/web-api/src/types/request/chat.ts:172

Extends

  • TokenOverridable.ChannelAndTS.Partial<MarkdownText>

Properties

channel

channel: string;

Defined in: packages/web-api/src/types/request/chat.ts:22

Description

Channel ID for the message.

Inherited from

ChannelAndTS.channel

chunks?

optional chunks: AnyChunk[];

Defined in: packages/web-api/src/types/request/chat.ts:177

Description

An array of chunk objects to append to the stream. Either markdown_text or chunks is required.


markdown_text?

optional markdown_text: string;

Defined in: packages/web-api/src/types/request/chat.ts:63

Description

Accepts message text formatted in markdown. This argument should not be used in conjunction with blocks or text. Limit this field to 12,000 characters.

Example

**This is bold text**

Inherited from

Partial.markdown_text

token?

optional token: string;

Defined in: packages/web-api/src/types/request/common.ts:43

Description

Overridable authentication token bearing required scopes.

Inherited from

TokenOverridable.token

ts

ts: string;

Defined in: packages/web-api/src/types/request/chat.ts:26

Description

Timestamp of the message.

Inherited from

ChannelAndTS.ts