start_stream

This module is generated by gleam run -m slackline_codegen/generate. Do not edit it by hand.

Setters for the optional arguments of chat.startStream. Each setter takes the call that chat.start_stream returns and sets one argument:

chat.start_stream(channel: "channel")
|> start_stream.chunks(chunks)

Values

chunks

</>

pub fn chunks(
  call: slackline.Call(chat.StartStream, r),
  chunks: List(chat.StreamChunk),
) -> slackline.Call(chat.StartStream, r)

Streaming chunks: markdown text, task updates, plan updates or blocks. Cannot be mixed with markdown_text within one stream.

icon_emoji

</>

pub fn icon_emoji(
  call: slackline.Call(chat.StartStream, r),
  icon_emoji: String,
) -> slackline.Call(chat.StartStream, r)

Emoji to use as the icon for this message. Overrides icon_url.

icon_url

</>

pub fn icon_url(
  call: slackline.Call(chat.StartStream, r),
  icon_url: String,
) -> slackline.Call(chat.StartStream, r)

Image URL to use as the icon for this message.

markdown_text

</>

pub fn markdown_text(
  call: slackline.Call(chat.StartStream, r),
  markdown_text: String,
) -> slackline.Call(chat.StartStream, r)

Accepts message text formatted in markdown. Limit this field to 12,000 characters.

recipient_team_id

</>

pub fn recipient_team_id(
  call: slackline.Call(chat.StartStream, r),
  recipient_team_id: String,
) -> slackline.Call(chat.StartStream, r)

The encoded ID of the team the user receiving the streaming text belongs to. Required when streaming to channels.

recipient_user_id

</>

pub fn recipient_user_id(
  call: slackline.Call(chat.StartStream, r),
  recipient_user_id: String,
) -> slackline.Call(chat.StartStream, r)

The encoded ID of the user to receive the streaming text. Required when streaming to channels.

task_display_mode

</>

pub fn task_display_mode(
  call: slackline.Call(chat.StartStream, r),
  task_display_mode: chat.TaskDisplayMode,
) -> slackline.Call(chat.StartStream, r)

Specifies how tasks are displayed in the message. timeline task updates render as individual task cards interleaved with streamed text. plan task updates render together in a plan block. Acceptable values: timeline plan Defaults to timeline.

thread_ts

</>

pub fn thread_ts(
  call: slackline.Call(chat.StartStream, r),
  thread_ts: String,
) -> slackline.Call(chat.StartStream, r)

Provide another message’s ts value to reply to. Omit it to stream a top-level message instead of a thread reply; this is only supported in channels where the whole channel is one session, such as Slack Code, and returns invalid_thread_ts elsewhere. Passing "0" is equivalent to omitting it.

username

</>

pub fn username(
  call: slackline.Call(chat.StartStream, r),
  username: String,
) -> slackline.Call(chat.StartStream, r)

The bot’s username to display.