Struct ChatStartStreamRequest 

#[non_exhaustive]
pub struct ChatStartStreamRequest {
    pub channel: String,
    pub chunks: Option<Vec<Value>>,
    pub markdown_text: Option<String>,
    pub thread_ts: Option<String>,
    pub recipient_user_id: Option<String>,
    pub recipient_team_id: Option<String>,
    pub task_display_mode: Option<String>,
    pub icon_emoji: Option<String>,
    pub icon_url: Option<String>,
    pub username: Option<String>,
}

Arguments for the Slack Web API method chat.startStream: Start a new streaming conversation

Send it with SlackClient::chat_start_stream.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

channel: String

An encoded ID that represents a channel, thread, or DM.

chunks: Option<Vec<Value>>

Array of streaming chunks. Can include markdown text chunk objects, task update chunk objects, plan update chunks, or blocks chunks.

markdown_text: Option<String>

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

thread_ts: Option<String>

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.

recipient_user_id: Option<String>

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

recipient_team_id: Option<String>

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

task_display_mode: Option<String>

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.

icon_emoji: Option<String>

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

icon_url: Option<String>

Image URL to use as the icon for this message.

username: Option<String>

The bot’s username to display.

Implementations

impl ChatStartStreamRequest

pub fn new(channel: impl Into<String>) -> Self

pub fn chunks(self, chunks: Vec<Value>) -> Self

pub fn markdown_text(self, markdown_text: impl Into<String>) -> Self

pub fn thread_ts(self, thread_ts: impl Into<String>) -> Self

pub fn recipient_user_id(self, recipient_user_id: impl Into<String>) -> Self

pub fn recipient_team_id(self, recipient_team_id: impl Into<String>) -> Self

pub fn task_display_mode(self, task_display_mode: impl Into<String>) -> Self

pub fn icon_emoji(self, icon_emoji: impl Into<String>) -> Self

pub fn icon_url(self, icon_url: impl Into<String>) -> Self

pub fn username(self, username: impl Into<String>) -> Self

Trait Implementations

impl Clone for ChatStartStreamRequest

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ChatStartStreamRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ChatStartStreamRequest

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ChatStartStreamRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SlackApiMethod for ChatStartStreamRequest

const METHOD: &'static str = "chat.startStream"

Method name, such as chat.postMessage.

type Response = ChatStartStreamResponse

Type of a successful response.

impl StructuralPartialEq for ChatStartStreamRequest