Skip to main content

@slack/web-api / ChatStartStreamArguments

Interface: ChatStartStreamArguments

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

Extends​

  • TokenOverridable.Channel.Partial<MarkdownText>.ThreadTS

Properties​

channel​

channel: string;

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

Description​

Channel ID for the message.

Inherited from​

Channel.channel

chunks?​

optional chunks: AnyChunk[];

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

Description​

An array of chunk objects to start the stream with. 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

recipient_team_id?​

optional recipient_team_id: string;

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

Description​

The ID of the team that is associated with recipient_user_id. This is required when starting a streaming conversation outside of a DM.

recipient_user_id?​

optional recipient_user_id: string;

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

Description​

The ID of the user to receive the streaming conversation messages. This is required when starting a streaming conversation outside of a DM.

task_display_mode?​

optional task_display_mode: string;

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

Description​

Specifies how tasks are displayed in the message. A "timeline" displays individual tasks with text and "plan" displays all tasks together.

thread_ts​

thread_ts: string;

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

Description​

Provide another message's ts value to post this message in a thread. Avoid using a reply's ts value; use its parent's value instead.

Inherited from​

ThreadTS.thread_ts

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