Composition Objects
Generated from the actual Rust signatures and rustdoc comments. Builders validate on build(); into_builder() preserves omissions. Error categories and paths are stable; prose may improve.
AreaChart
An area chart for a data visualization block.
Slack reference. Every series needs exactly one data point for each axis category.
builder
Starts a builder with the documented model defaults.
fn builder() -> AreaChartBuilder
Related types: AreaChartBuilder
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> AreaChartBuilder
Related types: AreaChartBuilder
series
Borrows or copies series. Adds data series in display order. Series names must be unique.
fn series(&self) -> &[DataSeries]
Related types: DataSeries
axis_config
Borrows or copies axis_config. Sets the axis categories and labels. Every series needs exactly one point per category.
fn axis_config(&self) -> &AxisConfig
Related types: AxisConfig
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
AreaChartBuilder
Consuming builder for AreaChart. Validation runs in Self::build.
series
Adds data series in display order. Series names must be unique. Replaces the collection; order is preserved.
fn series<I, T>(mut self, values: I) -> Self
where
I: IntoIterator<Item = T>,
T: Into<DataSeries>,
Related types: DataSeries
series_entry
Appends one item to the collection.
fn series_entry(mut self, value: impl Into<DataSeries>) -> Self
Related types: DataSeries
axis_config
Sets the axis categories and labels. Every series needs exactly one point per category.
fn axis_config(mut self, value: impl Into<AxisConfig>) -> Self
Related types: AxisConfig
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<AreaChart, ValidationError>
Related types: AreaChart, ValidationError
AxisConfig
The categories and labels shared by bar, area, and line chart axes.
builder
Starts a builder with the documented model defaults.
fn builder() -> AxisConfigBuilder
Related types: AxisConfigBuilder
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> AxisConfigBuilder
Related types: AxisConfigBuilder
categories
Borrows or copies categories. Adds axis categories in display order. Labels must be unique.
fn categories(&self) -> &[String]
x_label
Borrows or copies x_label. Sets the horizontal axis label.
fn x_label(&self) -> Option<&str>
y_label
Borrows or copies y_label. Sets the vertical axis label.
fn y_label(&self) -> Option<&str>
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
AxisConfigBuilder
Consuming builder for AxisConfig. Validation runs in Self::build.
categories
Adds axis categories in display order. Labels must be unique. Replaces the collection; order is preserved.
fn categories<I, T>(mut self, values: I) -> Self
where
I: IntoIterator<Item = T>,
T: Into<String>,
category
Appends one item to the collection.
fn category(mut self, value: impl Into<String>) -> Self
x_label
Sets the horizontal axis label.
fn x_label(mut self, value: impl Into<String>) -> Self
clear_x_label
Omits x_label, including any model default.
fn clear_x_label(mut self) -> Self
y_label
Sets the vertical axis label.
fn y_label(mut self, value: impl Into<String>) -> Self
clear_y_label
Omits y_label, including any model default.
fn clear_y_label(mut self) -> Self
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<AxisConfig, ValidationError>
Related types: AxisConfig, ValidationError
BarChart
A bar chart for a data visualization block.
Slack reference. Every series needs exactly one data point for each axis category.
builder
Starts a builder with the documented model defaults.
fn builder() -> BarChartBuilder
Related types: BarChartBuilder
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> BarChartBuilder
Related types: BarChartBuilder
series
Borrows or copies series. Adds data series in display order. Series names must be unique.
fn series(&self) -> &[DataSeries]
Related types: DataSeries
axis_config
Borrows or copies axis_config. Sets the axis categories and labels. Every series needs exactly one point per category.
fn axis_config(&self) -> &AxisConfig
Related types: AxisConfig
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
BarChartBuilder
Consuming builder for BarChart. Validation runs in Self::build.
series
Adds data series in display order. Series names must be unique. Replaces the collection; order is preserved.
fn series<I, T>(mut self, values: I) -> Self
where
I: IntoIterator<Item = T>,
T: Into<DataSeries>,
Related types: DataSeries
series_entry
Appends one item to the collection.
fn series_entry(mut self, value: impl Into<DataSeries>) -> Self
Related types: DataSeries
axis_config
Sets the axis categories and labels. Every series needs exactly one point per category.
fn axis_config(mut self, value: impl Into<AxisConfig>) -> Self
Related types: AxisConfig
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<BarChart, ValidationError>
Related types: BarChart, ValidationError
ChartSegment
One labelled segment of a pie chart.
builder
Starts a builder with the documented model defaults.
fn builder() -> ChartSegmentBuilder
Related types: ChartSegmentBuilder
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> ChartSegmentBuilder
Related types: ChartSegmentBuilder
label
Borrows or copies label. Sets the segment label.
fn label(&self) -> &str
value
Borrows or copies value. Sets the segment's size. Must be greater than zero.
fn value(&self) -> &JsonNumber
Related types: JsonNumber
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
ChartSegmentBuilder
Consuming builder for ChartSegment. Validation runs in Self::build.
label
Sets the segment label.
fn label(mut self, value: impl Into<String>) -> Self
value
Sets the segment's size. Must be greater than zero.
fn value(mut self, value: impl Into<JsonNumber>) -> Self
Related types: JsonNumber
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<ChartSegment, ValidationError>
Related types: ChartSegment, ValidationError
ColumnSettings
Alignment and wrapping settings for one table column.
builder
Starts a builder with the documented model defaults.
fn builder() -> ColumnSettingsBuilder
Related types: ColumnSettingsBuilder
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> ColumnSettingsBuilder
Related types: ColumnSettingsBuilder
align
Borrows or copies align. Sets how cell content in the column is aligned.
fn align(&self) -> Option<ColumnAlign>
Related types: ColumnAlign
is_wrapped
Borrows or copies is_wrapped. Sets whether long cell content wraps instead of being truncated.
fn is_wrapped(&self) -> Option<bool>
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
ColumnSettingsBuilder
Consuming builder for ColumnSettings. Validation runs in Self::build.
align
Sets how cell content in the column is aligned.
fn align(mut self, value: ColumnAlign) -> Self
Related types: ColumnAlign
clear_align
Omits align, including any model default.
fn clear_align(mut self) -> Self
is_wrapped
Sets whether long cell content wraps instead of being truncated.
fn is_wrapped(mut self, value: bool) -> Self
clear_is_wrapped
Omits is_wrapped, including any model default.
fn clear_is_wrapped(mut self) -> Self
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<ColumnSettings, ValidationError>
Related types: ColumnSettings, ValidationError
ConfirmationDialogue
A dialog that asks users to confirm an action before it is sent.
builder
Starts a builder with the documented model defaults.
fn builder() -> ConfirmationDialogueBuilder
Related types: ConfirmationDialogueBuilder
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> ConfirmationDialogueBuilder
Related types: ConfirmationDialogueBuilder
title
Borrows or copies title. Sets the dialog title.
fn title(&self) -> &PlainText
Related types: PlainText
text
Borrows or copies text. Sets the explanatory text in the dialog body.
fn text(&self) -> &Text
Related types: Text
confirm
Borrows or copies confirm. Sets the label of the button that confirms the action.
fn confirm(&self) -> &PlainText
Related types: PlainText
deny
Borrows or copies deny. Sets the label of the button that cancels the action.
fn deny(&self) -> &PlainText
Related types: PlainText
style
Borrows or copies style. Sets the emphasis of the confirm button.
fn style(&self) -> Option<ButtonStyle>
Related types: ButtonStyle
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
ConfirmationDialogueBuilder
Consuming builder for ConfirmationDialogue. Validation runs in Self::build.
title
Sets the dialog title.
fn title(mut self, value: impl Into<PlainTextInput>) -> Self
Related types: PlainTextInput
text
Sets the explanatory text in the dialog body.
fn text(mut self, value: impl Into<TextInput>) -> Self
Related types: TextInput
confirm
Sets the label of the button that confirms the action.
fn confirm(mut self, value: impl Into<PlainTextInput>) -> Self
Related types: PlainTextInput
deny
Sets the label of the button that cancels the action.
fn deny(mut self, value: impl Into<PlainTextInput>) -> Self
Related types: PlainTextInput
style
Sets the emphasis of the confirm button.
fn style(mut self, value: ButtonStyle) -> Self
Related types: ButtonStyle
clear_style
Omits style, including any model default.
fn clear_style(mut self) -> Self
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<ConfirmationDialogue, ValidationError>
Related types: ConfirmationDialogue, ValidationError
ConversationFilter
Limits which conversations a conversation menu offers.
Slack reference. Set at least one filter. Include only im, mpim, private, and public.
builder
Starts a builder with the documented model defaults.
fn builder() -> ConversationFilterBuilder
Related types: ConversationFilterBuilder
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> ConversationFilterBuilder
Related types: ConversationFilterBuilder
include
Borrows or copies include. Adds conversation types to offer: im, mpim, private, or public.
fn include(&self) -> Option<&[String]>
exclude_external_shared_channels
Borrows or copies exclude_external_shared_channels. Sets whether externally shared channels are excluded.
fn exclude_external_shared_channels(&self) -> Option<bool>
exclude_bot_users
Borrows or copies exclude_bot_users. Sets whether bot users are excluded.
fn exclude_bot_users(&self) -> Option<bool>
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
ConversationFilterBuilder
Consuming builder for ConversationFilter. Validation runs in Self::build.
include
Adds conversation types to offer: im, mpim, private, or public. Replaces the collection; order is preserved.
fn include<I, T>(mut self, values: I) -> Self
where
I: IntoIterator<Item = T>,
T: Into<String>,
add_include
Appends one item to the collection.
fn add_include(mut self, value: impl Into<String>) -> Self
clear_include
Omits include, including any model default.
fn clear_include(mut self) -> Self
exclude_external_shared_channels
Sets whether externally shared channels are excluded.
fn exclude_external_shared_channels(mut self, value: bool) -> Self
clear_exclude_external_shared_channels
Omits exclude_external_shared_channels, including any model default.
fn clear_exclude_external_shared_channels(mut self) -> Self
exclude_bot_users
Sets whether bot users are excluded.
fn exclude_bot_users(mut self, value: bool) -> Self
clear_exclude_bot_users
Omits exclude_bot_users, including any model default.
fn clear_exclude_bot_users(mut self) -> Self
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<ConversationFilter, ValidationError>
Related types: ConversationFilter, ValidationError
DataPoint
One value of a chart series, keyed by axis category.
builder
Starts a builder with the documented model defaults.
fn builder() -> DataPointBuilder
Related types: DataPointBuilder
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> DataPointBuilder
Related types: DataPointBuilder
label
Borrows or copies label. Sets the axis category this point belongs to.
fn label(&self) -> &str
value
Borrows or copies value. Sets the point's value.
fn value(&self) -> &JsonNumber
Related types: JsonNumber
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
DataPointBuilder
Consuming builder for DataPoint. Validation runs in Self::build.
label
Sets the axis category this point belongs to.
fn label(mut self, value: impl Into<String>) -> Self
value
Sets the point's value.
fn value(mut self, value: impl Into<JsonNumber>) -> Self
Related types: JsonNumber
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<DataPoint, ValidationError>
Related types: DataPoint, ValidationError
DataSeries
A named series of chart data points.
builder
Starts a builder with the documented model defaults.
fn builder() -> DataSeriesBuilder
Related types: DataSeriesBuilder
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> DataSeriesBuilder
Related types: DataSeriesBuilder
name
Borrows or copies name. Sets the series name shown in the legend.
fn name(&self) -> &str
data
Borrows or copies data. Adds data points in axis-category order.
fn data(&self) -> &[DataPoint]
Related types: DataPoint
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
DataSeriesBuilder
Consuming builder for DataSeries. Validation runs in Self::build.
name
Sets the series name shown in the legend.
fn name(mut self, value: impl Into<String>) -> Self
data
Adds data points in axis-category order. Replaces the collection; order is preserved.
fn data<I, T>(mut self, values: I) -> Self
where
I: IntoIterator<Item = T>,
T: Into<DataPoint>,
Related types: DataPoint
point
Appends one item to the collection.
fn point(mut self, value: impl Into<DataPoint>) -> Self
Related types: DataPoint
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<DataSeries, ValidationError>
Related types: DataSeries, ValidationError
DispatchActionConfiguration
Chooses which interactions with an input send a block_actions payload.
builder
Starts a builder with the documented model defaults.
fn builder() -> DispatchActionConfigurationBuilder
Related types: DispatchActionConfigurationBuilder
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> DispatchActionConfigurationBuilder
Related types: DispatchActionConfigurationBuilder
trigger_actions_on
Borrows or copies trigger_actions_on. Adds the interactions that send a payload: on_enter_pressed or on_character_entered.
fn trigger_actions_on(&self) -> Option<&[String]>
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
DispatchActionConfigurationBuilder
Consuming builder for DispatchActionConfiguration. Validation runs in Self::build.
trigger_actions_on
Adds the interactions that send a payload: on_enter_pressed or on_character_entered. Replaces the collection; order is preserved.
fn trigger_actions_on<I, T>(mut self, values: I) -> Self
where
I: IntoIterator<Item = T>,
T: Into<String>,
trigger_action
Appends one item to the collection.
fn trigger_action(mut self, value: impl Into<String>) -> Self
clear_trigger_actions_on
Omits trigger_actions_on, including any model default.
fn clear_trigger_actions_on(mut self) -> Self
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<DispatchActionConfiguration, ValidationError>
Related types: DispatchActionConfiguration, ValidationError
FeedbackButton
One button of a feedback buttons element.
builder
Starts a builder with the documented model defaults.
fn builder() -> FeedbackButtonBuilder
Related types: FeedbackButtonBuilder
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> FeedbackButtonBuilder
Related types: FeedbackButtonBuilder
text
Borrows or copies text. Sets the button label.
fn text(&self) -> &PlainText
Related types: PlainText
value
Borrows or copies value. Sets the application-defined value sent in interaction payloads.
fn value(&self) -> &str
accessibility_label
Borrows or copies accessibility_label. Sets the label read by screen readers in place of the visible text.
fn accessibility_label(&self) -> Option<&str>
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
FeedbackButtonBuilder
Consuming builder for FeedbackButton. Validation runs in Self::build.
text
Sets the button label.
fn text(mut self, value: impl Into<PlainTextInput>) -> Self
Related types: PlainTextInput
value
Sets the application-defined value sent in interaction payloads.
fn value(mut self, value: impl Into<String>) -> Self
accessibility_label
Sets the label read by screen readers in place of the visible text.
fn accessibility_label(mut self, value: impl Into<String>) -> Self
clear_accessibility_label
Omits accessibility_label, including any model default.
fn clear_accessibility_label(mut self) -> Self
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<FeedbackButton, ValidationError>
Related types: FeedbackButton, ValidationError
InputParameter
A named value passed to a workflow trigger.
builder
Starts a builder with the documented model defaults.
fn builder() -> InputParameterBuilder
Related types: InputParameterBuilder
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> InputParameterBuilder
Related types: InputParameterBuilder
name
Borrows or copies name. Sets the workflow input parameter name.
fn name(&self) -> &str
value
Borrows or copies value. Sets the value passed to the workflow input.
fn value(&self) -> &str
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
InputParameterBuilder
Consuming builder for InputParameter. Validation runs in Self::build.
name
Sets the workflow input parameter name.
fn name(mut self, value: impl Into<String>) -> Self
value
Sets the value passed to the workflow input.
fn value(mut self, value: impl Into<String>) -> Self
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<InputParameter, ValidationError>
Related types: InputParameter, ValidationError
LineChart
A line chart for a data visualization block.
Slack reference. Every series needs exactly one data point for each axis category.
builder
Starts a builder with the documented model defaults.
fn builder() -> LineChartBuilder
Related types: LineChartBuilder
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> LineChartBuilder
Related types: LineChartBuilder
series
Borrows or copies series. Adds data series in display order. Series names must be unique.
fn series(&self) -> &[DataSeries]
Related types: DataSeries
axis_config
Borrows or copies axis_config. Sets the axis categories and labels. Every series needs exactly one point per category.
fn axis_config(&self) -> &AxisConfig
Related types: AxisConfig
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
LineChartBuilder
Consuming builder for LineChart. Validation runs in Self::build.
series
Adds data series in display order. Series names must be unique. Replaces the collection; order is preserved.
fn series<I, T>(mut self, values: I) -> Self
where
I: IntoIterator<Item = T>,
T: Into<DataSeries>,
Related types: DataSeries
series_entry
Appends one item to the collection.
fn series_entry(mut self, value: impl Into<DataSeries>) -> Self
Related types: DataSeries
axis_config
Sets the axis categories and labels. Every series needs exactly one point per category.
fn axis_config(mut self, value: impl Into<AxisConfig>) -> Self
Related types: AxisConfig
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<LineChart, ValidationError>
Related types: LineChart, ValidationError
MarkdownText
A mrkdwn text composition object.
builder
Starts a builder with the documented model defaults.
fn builder() -> MarkdownTextBuilder
Related types: MarkdownTextBuilder
new
Constructs validated text.
Errors Returns a validation error when text violates its field limits.
fn new(text: impl Into<String>) -> Result<Self, ValidationError>
Related types: ValidationError
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> MarkdownTextBuilder
Related types: MarkdownTextBuilder
text
Borrows or copies text. Sets the mrkdwn-formatted text content.
fn text(&self) -> &str
verbatim
Borrows or copies verbatim. Sets whether Slack leaves URLs, mentions, and channel names unlinked.
fn verbatim(&self) -> Option<bool>
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
MarkdownTextBuilder
Consuming builder for MarkdownText. Validation runs in Self::build.
text
Sets the mrkdwn-formatted text content.
fn text(mut self, value: impl Into<String>) -> Self
verbatim
Sets whether Slack leaves URLs, mentions, and channel names unlinked.
fn verbatim(mut self, value: bool) -> Self
clear_verbatim
Omits verbatim, including any model default.
fn clear_verbatim(mut self) -> Self
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<MarkdownText, ValidationError>
Related types: MarkdownText, ValidationError
PieChart
A pie chart for a data visualization block.
builder
Starts a builder with the documented model defaults.
fn builder() -> PieChartBuilder
Related types: PieChartBuilder
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> PieChartBuilder
Related types: PieChartBuilder
segments
Borrows or copies segments. Adds pie segments in display order.
fn segments(&self) -> &[ChartSegment]
Related types: ChartSegment
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
PieChartBuilder
Consuming builder for PieChart. Validation runs in Self::build.
segments
Adds pie segments in display order. Replaces the collection; order is preserved.
fn segments<I, T>(mut self, values: I) -> Self
where
I: IntoIterator<Item = T>,
T: Into<ChartSegment>,
Related types: ChartSegment
segment
Appends one item to the collection.
fn segment(mut self, value: impl Into<ChartSegment>) -> Self
Related types: ChartSegment
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<PieChart, ValidationError>
Related types: PieChart, ValidationError
PlainText
A plain-text composition object.
builder
Starts a builder with the documented model defaults.
fn builder() -> PlainTextBuilder
Related types: PlainTextBuilder
new
Constructs validated text.
Errors Returns a validation error when text violates its field limits.
fn new(text: impl Into<String>) -> Result<Self, ValidationError>
Related types: ValidationError
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> PlainTextBuilder
Related types: PlainTextBuilder
text
Borrows or copies text. Sets the text content.
fn text(&self) -> &str
emoji
Borrows or copies emoji. Sets whether emoji shortcodes such as 🎉 are rendered as emoji.
fn emoji(&self) -> Option<bool>
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
PlainTextBuilder
Consuming builder for PlainText. Validation runs in Self::build.
text
Sets the text content.
fn text(mut self, value: impl Into<String>) -> Self
emoji
Sets whether emoji shortcodes such as 🎉 are rendered as emoji.
fn emoji(mut self, value: bool) -> Self
clear_emoji
Omits emoji, including any model default.
fn clear_emoji(mut self) -> Self
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<PlainText, ValidationError>
Related types: PlainText, ValidationError
RawNumber
A numeric data table cell with display text.
builder
Starts a builder with the documented model defaults.
fn builder() -> RawNumberBuilder
Related types: RawNumberBuilder
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> RawNumberBuilder
Related types: RawNumberBuilder
value
Borrows or copies value. Sets the numeric value used for sorting.
fn value(&self) -> &JsonNumber
Related types: JsonNumber
text
Borrows or copies text. Sets the formatted text displayed for the number, such as 1,234.5.
fn text(&self) -> &str
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
RawNumberBuilder
Consuming builder for RawNumber. Validation runs in Self::build.
value
Sets the numeric value used for sorting.
fn value(mut self, value: impl Into<JsonNumber>) -> Self
Related types: JsonNumber
text
Sets the formatted text displayed for the number, such as 1,234.5.
fn text(mut self, value: impl Into<String>) -> Self
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<RawNumber, ValidationError>
Related types: RawNumber, ValidationError
RawText
An unformatted table cell.
builder
Starts a builder with the documented model defaults.
fn builder() -> RawTextBuilder
Related types: RawTextBuilder
new
Constructs validated text.
Errors Returns a validation error when text violates its field limits.
fn new(text: impl Into<String>) -> Result<Self, ValidationError>
Related types: ValidationError
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> RawTextBuilder
Related types: RawTextBuilder
text
Borrows or copies text. Sets the cell text.
fn text(&self) -> &str
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
RawTextBuilder
Consuming builder for RawText. Validation runs in Self::build.
text
Sets the cell text.
fn text(mut self, value: impl Into<String>) -> Self
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<RawText, ValidationError>
Related types: RawText, ValidationError
RichTextChannel
A channel mention inside rich text.
builder
Starts a builder with the documented model defaults.
fn builder() -> RichTextChannelBuilder
Related types: RichTextChannelBuilder
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> RichTextChannelBuilder
Related types: RichTextChannelBuilder
channel_id
Borrows or copies channel_id. Sets the ID of the mentioned channel.
fn channel_id(&self) -> &str
style
Borrows or copies style. Sets the mention style.
fn style(&self) -> Option<&RichTextStyle>
Related types: RichTextStyle
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
RichTextChannelBuilder
Consuming builder for RichTextChannel. Validation runs in Self::build.
channel_id
Sets the ID of the mentioned channel.
fn channel_id(mut self, value: impl Into<String>) -> Self
style
Sets the mention style.
fn style(mut self, value: RichTextStyle) -> Self
Related types: RichTextStyle
clear_style
Omits style, including any model default.
fn clear_style(mut self) -> Self
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<RichTextChannel, ValidationError>
Related types: RichTextChannel, ValidationError
RichTextCodeBlock
A preformatted code block inside rich text.
builder
Starts a builder with the documented model defaults.
fn builder() -> RichTextCodeBlockBuilder
Related types: RichTextCodeBlockBuilder
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> RichTextCodeBlockBuilder
Related types: RichTextCodeBlockBuilder
elements
Borrows or copies elements. Adds inline rich text elements in display order.
fn elements(&self) -> &[RichTextSectionElement]
Related types: RichTextSectionElement
border
Borrows or copies border. Sets the width of the left border, in pixels.
fn border(&self) -> Option<i64>
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
RichTextCodeBlockBuilder
Consuming builder for RichTextCodeBlock. Validation runs in Self::build.
elements
Adds inline rich text elements in display order. Replaces the collection; order is preserved.
fn elements<I, T>(mut self, values: I) -> Self
where
I: IntoIterator<Item = T>,
T: Into<RichTextSectionElement>,
Related types: RichTextSectionElement
element
Appends one item to the collection.
fn element(mut self, value: impl Into<RichTextSectionElement>) -> Self
Related types: RichTextSectionElement
border
Sets the width of the left border, in pixels.
fn border(mut self, value: i64) -> Self
clear_border
Omits border, including any model default.
fn clear_border(mut self) -> Self
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<RichTextCodeBlock, ValidationError>
Related types: RichTextCodeBlock, ValidationError
RichTextEmoji
An emoji inside rich text.
builder
Starts a builder with the documented model defaults.
fn builder() -> RichTextEmojiBuilder
Related types: RichTextEmojiBuilder
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> RichTextEmojiBuilder
Related types: RichTextEmojiBuilder
name
Borrows or copies name. Sets the emoji shortcode name, without colons.
fn name(&self) -> &str
skin_tone
Borrows or copies skin_tone. Sets the emoji skin tone, from 1 to 6.
fn skin_tone(&self) -> Option<i64>
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
RichTextEmojiBuilder
Consuming builder for RichTextEmoji. Validation runs in Self::build.
name
Sets the emoji shortcode name, without colons.
fn name(mut self, value: impl Into<String>) -> Self
skin_tone
Sets the emoji skin tone, from 1 to 6.
fn skin_tone(mut self, value: i64) -> Self
clear_skin_tone
Omits skin_tone, including any model default.
fn clear_skin_tone(mut self) -> Self
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<RichTextEmoji, ValidationError>
Related types: RichTextEmoji, ValidationError
RichTextLink
A hyperlink inside rich text.
builder
Starts a builder with the documented model defaults.
fn builder() -> RichTextLinkBuilder
Related types: RichTextLinkBuilder
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> RichTextLinkBuilder
Related types: RichTextLinkBuilder
url
Borrows or copies url. Sets the link target.
fn url(&self) -> &str
text
Borrows or copies text. Sets the visible link text. Slack shows the URL when omitted.
fn text(&self) -> Option<&str>
style
Borrows or copies style. Sets the visual style.
fn style(&self) -> Option<&RichTextStyle>
Related types: RichTextStyle
r#unsafe
Borrows or copies unsafe. Sets whether Slack treats the link as unsafe.
fn r#unsafe(&self) -> Option<bool>
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
RichTextLinkBuilder
Consuming builder for RichTextLink. Validation runs in Self::build.
url
Sets the link target.
fn url(mut self, value: impl Into<String>) -> Self
text
Sets the visible link text. Slack shows the URL when omitted.
fn text(mut self, value: impl Into<String>) -> Self
clear_text
Omits text, including any model default.
fn clear_text(mut self) -> Self
style
Sets the visual style.
fn style(mut self, value: RichTextStyle) -> Self
Related types: RichTextStyle
clear_style
Omits style, including any model default.
fn clear_style(mut self) -> Self
r#unsafe
Sets whether Slack treats the link as unsafe.
fn r#unsafe(mut self, value: bool) -> Self
clear_unsafe
Omits unsafe, including any model default.
fn clear_unsafe(mut self) -> Self
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<RichTextLink, ValidationError>
Related types: RichTextLink, ValidationError
RichTextList
A bulleted or numbered list inside rich text.
builder
Starts a builder with the documented model defaults.
fn builder() -> RichTextListBuilder
Related types: RichTextListBuilder
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> RichTextListBuilder
Related types: RichTextListBuilder
style
Borrows or copies style. Sets whether the list is bulleted or numbered.
fn style(&self) -> RichTextListStyle
Related types: RichTextListStyle
elements
Borrows or copies elements. Adds list items, one rich text section per item.
fn elements(&self) -> &[RichTextSection]
Related types: RichTextSection
indent
Borrows or copies indent. Sets the list's indentation level.
fn indent(&self) -> Option<i64>
offset
Borrows or copies offset. Sets the number of items to skip when numbering an ordered list.
fn offset(&self) -> Option<i64>
border
Borrows or copies border. Sets the width of the left border, in pixels.
fn border(&self) -> Option<i64>
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
RichTextListBuilder
Consuming builder for RichTextList. Validation runs in Self::build.
style
Sets whether the list is bulleted or numbered.
fn style(mut self, value: RichTextListStyle) -> Self
Related types: RichTextListStyle
elements
Adds list items, one rich text section per item. Replaces the collection; order is preserved.
fn elements<I, T>(mut self, values: I) -> Self
where
I: IntoIterator<Item = T>,
T: Into<RichTextSection>,
Related types: RichTextSection
element
Appends one item to the collection.
fn element(mut self, value: impl Into<RichTextSection>) -> Self
Related types: RichTextSection
indent
Sets the list's indentation level.
fn indent(mut self, value: i64) -> Self
clear_indent
Omits indent, including any model default.
fn clear_indent(mut self) -> Self
offset
Sets the number of items to skip when numbering an ordered list.
fn offset(mut self, value: i64) -> Self
clear_offset
Omits offset, including any model default.
fn clear_offset(mut self) -> Self
border
Sets the width of the left border, in pixels.
fn border(mut self, value: i64) -> Self
clear_border
Omits border, including any model default.
fn clear_border(mut self) -> Self
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<RichTextList, ValidationError>
Related types: RichTextList, ValidationError
RichTextQuote
A quotation inside rich text.
builder
Starts a builder with the documented model defaults.
fn builder() -> RichTextQuoteBuilder
Related types: RichTextQuoteBuilder
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> RichTextQuoteBuilder
Related types: RichTextQuoteBuilder
elements
Borrows or copies elements. Adds inline rich text elements in display order.
fn elements(&self) -> &[RichTextSectionElement]
Related types: RichTextSectionElement
border
Borrows or copies border. Sets the width of the left border, in pixels.
fn border(&self) -> Option<i64>
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
RichTextQuoteBuilder
Consuming builder for RichTextQuote. Validation runs in Self::build.
elements
Adds inline rich text elements in display order. Replaces the collection; order is preserved.
fn elements<I, T>(mut self, values: I) -> Self
where
I: IntoIterator<Item = T>,
T: Into<RichTextSectionElement>,
Related types: RichTextSectionElement
element
Appends one item to the collection.
fn element(mut self, value: impl Into<RichTextSectionElement>) -> Self
Related types: RichTextSectionElement
border
Sets the width of the left border, in pixels.
fn border(mut self, value: i64) -> Self
clear_border
Omits border, including any model default.
fn clear_border(mut self) -> Self
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<RichTextQuote, ValidationError>
Related types: RichTextQuote, ValidationError
RichTextSection
A paragraph of inline rich text elements.
builder
Starts a builder with the documented model defaults.
fn builder() -> RichTextSectionBuilder
Related types: RichTextSectionBuilder
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> RichTextSectionBuilder
Related types: RichTextSectionBuilder
elements
Borrows or copies elements. Adds inline rich text elements in display order.
fn elements(&self) -> &[RichTextSectionElement]
Related types: RichTextSectionElement
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
RichTextSectionBuilder
Consuming builder for RichTextSection. Validation runs in Self::build.
elements
Adds inline rich text elements in display order. Replaces the collection; order is preserved.
fn elements<I, T>(mut self, values: I) -> Self
where
I: IntoIterator<Item = T>,
T: Into<RichTextSectionElement>,
Related types: RichTextSectionElement
element
Appends one item to the collection.
fn element(mut self, value: impl Into<RichTextSectionElement>) -> Self
Related types: RichTextSectionElement
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<RichTextSection, ValidationError>
Related types: RichTextSection, ValidationError
RichTextText
A run of optionally styled text inside rich text.
builder
Starts a builder with the documented model defaults.
fn builder() -> RichTextTextBuilder
Related types: RichTextTextBuilder
new
Constructs validated text.
Errors Returns a validation error when text violates its field limits.
fn new(text: impl Into<String>) -> Result<Self, ValidationError>
Related types: ValidationError
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> RichTextTextBuilder
Related types: RichTextTextBuilder
text
Borrows or copies text. Sets the text content.
fn text(&self) -> &str
style
Borrows or copies style. Sets the visual style.
fn style(&self) -> Option<&RichTextStyle>
Related types: RichTextStyle
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
RichTextTextBuilder
Consuming builder for RichTextText. Validation runs in Self::build.
text
Sets the text content.
fn text(mut self, value: impl Into<String>) -> Self
style
Sets the visual style.
fn style(mut self, value: RichTextStyle) -> Self
Related types: RichTextStyle
clear_style
Omits style, including any model default.
fn clear_style(mut self) -> Self
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<RichTextText, ValidationError>
Related types: RichTextText, ValidationError
RichTextUser
A user mention inside rich text.
builder
Starts a builder with the documented model defaults.
fn builder() -> RichTextUserBuilder
Related types: RichTextUserBuilder
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> RichTextUserBuilder
Related types: RichTextUserBuilder
user_id
Borrows or copies user_id. Sets the ID of the mentioned user.
fn user_id(&self) -> &str
style
Borrows or copies style. Sets the visual style.
fn style(&self) -> Option<&RichTextStyle>
Related types: RichTextStyle
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
RichTextUserBuilder
Consuming builder for RichTextUser. Validation runs in Self::build.
user_id
Sets the ID of the mentioned user.
fn user_id(mut self, value: impl Into<String>) -> Self
style
Sets the visual style.
fn style(mut self, value: RichTextStyle) -> Self
Related types: RichTextStyle
clear_style
Omits style, including any model default.
fn clear_style(mut self) -> Self
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<RichTextUser, ValidationError>
Related types: RichTextUser, ValidationError
RichTextUserGroup
A user group mention inside rich text.
builder
Starts a builder with the documented model defaults.
fn builder() -> RichTextUserGroupBuilder
Related types: RichTextUserGroupBuilder
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> RichTextUserGroupBuilder
Related types: RichTextUserGroupBuilder
usergroup_id
Borrows or copies usergroup_id. Sets the ID of the mentioned user group.
fn usergroup_id(&self) -> &str
style
Borrows or copies style. Sets the visual style.
fn style(&self) -> Option<&RichTextStyle>
Related types: RichTextStyle
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
RichTextUserGroupBuilder
Consuming builder for RichTextUserGroup. Validation runs in Self::build.
usergroup_id
Sets the ID of the mentioned user group.
fn usergroup_id(mut self, value: impl Into<String>) -> Self
style
Sets the visual style.
fn style(mut self, value: RichTextStyle) -> Self
Related types: RichTextStyle
clear_style
Omits style, including any model default.
fn clear_style(mut self) -> Self
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<RichTextUserGroup, ValidationError>
Related types: RichTextUserGroup, ValidationError
SelectOption
A selectable option for menus, checkboxes, radio buttons, and overflow menus.
builder
Starts a builder with the documented model defaults.
fn builder() -> SelectOptionBuilder
Related types: SelectOptionBuilder
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> SelectOptionBuilder
Related types: SelectOptionBuilder
text
Borrows or copies text. Sets the option label shown to users.
fn text(&self) -> &Text
Related types: Text
value
Borrows or copies value. Sets the value sent in interaction payloads when this option is chosen.
fn value(&self) -> &str
description
Borrows or copies description. Sets supporting text shown below the label. Only rendered by checkboxes and radio buttons.
fn description(&self) -> Option<&Text>
Related types: Text
url
Borrows or copies url. Sets a URL loaded in the user's browser when an overflow menu option is chosen.
fn url(&self) -> Option<&str>
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
SelectOptionBuilder
Consuming builder for SelectOption. Validation runs in Self::build.
text
Sets the option label shown to users.
fn text(mut self, value: impl Into<TextInput>) -> Self
Related types: TextInput
value
Sets the value sent in interaction payloads when this option is chosen.
fn value(mut self, value: impl Into<String>) -> Self
description
Sets supporting text shown below the label. Only rendered by checkboxes and radio buttons.
fn description(mut self, value: impl Into<TextInput>) -> Self
Related types: TextInput
clear_description
Omits description, including any model default.
fn clear_description(mut self) -> Self
url
Sets a URL loaded in the user's browser when an overflow menu option is chosen.
fn url(mut self, value: impl Into<String>) -> Self
clear_url
Omits url, including any model default.
fn clear_url(mut self) -> Self
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<SelectOption, ValidationError>
Related types: SelectOption, ValidationError
SelectOptionGroup
A labelled group of options in a static select menu.
builder
Starts a builder with the documented model defaults.
fn builder() -> SelectOptionGroupBuilder
Related types: SelectOptionGroupBuilder
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> SelectOptionGroupBuilder
Related types: SelectOptionGroupBuilder
label
Borrows or copies label. Sets the group heading.
fn label(&self) -> &PlainText
Related types: PlainText
options
Borrows or copies options. Adds selectable options in display order.
fn options(&self) -> &[SelectOption]
Related types: SelectOption
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
SelectOptionGroupBuilder
Consuming builder for SelectOptionGroup. Validation runs in Self::build.
label
Sets the group heading.
fn label(mut self, value: impl Into<PlainTextInput>) -> Self
Related types: PlainTextInput
options
Adds selectable options in display order. Replaces the collection; order is preserved.
fn options<I, T>(mut self, values: I) -> Self
where
I: IntoIterator<Item = T>,
T: Into<SelectOption>,
Related types: SelectOption
option
Appends one item to the collection.
fn option(mut self, value: impl Into<SelectOption>) -> Self
Related types: SelectOption
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<SelectOptionGroup, ValidationError>
Related types: SelectOptionGroup, ValidationError
SlackFile
A reference to an image file hosted in Slack.
Slack reference. Provide exactly one of an ID or a URL. An ID must match ^F[A-Z0-9]{8,}$.
builder
Starts a builder with the documented model defaults.
fn builder() -> SlackFileBuilder
Related types: SlackFileBuilder
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> SlackFileBuilder
Related types: SlackFileBuilder
id
Borrows or copies id. Sets the ID of a file previously uploaded to Slack. Cannot be combined with a URL.
fn id(&self) -> Option<&str>
url
Borrows or copies url. Sets the URL of a file hosted in Slack. Cannot be combined with an ID.
fn url(&self) -> Option<&str>
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
SlackFileBuilder
Consuming builder for SlackFile. Validation runs in Self::build.
id
Sets the ID of a file previously uploaded to Slack. Cannot be combined with a URL.
fn id(mut self, value: impl Into<String>) -> Self
clear_id
Omits id, including any model default.
fn clear_id(mut self) -> Self
url
Sets the URL of a file hosted in Slack. Cannot be combined with an ID.
fn url(mut self, value: impl Into<String>) -> Self
clear_url
Omits url, including any model default.
fn clear_url(mut self) -> Self
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<SlackFile, ValidationError>
Related types: SlackFile, ValidationError
SlackIcon
A Slack-provided icon, referenced by name.
builder
Starts a builder with the documented model defaults.
fn builder() -> SlackIconBuilder
Related types: SlackIconBuilder
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> SlackIconBuilder
Related types: SlackIconBuilder
name
Borrows or copies name. Sets the name of the Slack-provided icon, such as rocket.
fn name(&self) -> &str
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
SlackIconBuilder
Consuming builder for SlackIcon. Validation runs in Self::build.
name
Sets the name of the Slack-provided icon, such as rocket.
fn name(mut self, value: impl Into<String>) -> Self
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<SlackIcon, ValidationError>
Related types: SlackIcon, ValidationError
Trigger
A link trigger that starts a workflow.
builder
Starts a builder with the documented model defaults.
fn builder() -> TriggerBuilder
Related types: TriggerBuilder
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> TriggerBuilder
Related types: TriggerBuilder
url
Borrows or copies url. Sets the link trigger URL.
fn url(&self) -> &str
customizable_input_parameters
Borrows or copies customizable_input_parameters. Adds the input values passed to the workflow's trigger.
fn customizable_input_parameters(&self) -> Option<&[InputParameter]>
Related types: InputParameter
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
TriggerBuilder
Consuming builder for Trigger. Validation runs in Self::build.
url
Sets the link trigger URL.
fn url(mut self, value: impl Into<String>) -> Self
customizable_input_parameters
Adds the input values passed to the workflow's trigger. Replaces the collection; order is preserved.
fn customizable_input_parameters<I, T>(mut self, values: I) -> Self
where
I: IntoIterator<Item = T>,
T: Into<InputParameter>,
Related types: InputParameter
customizable_input_parameter
Appends one item to the collection.
fn customizable_input_parameter(mut self, value: impl Into<InputParameter>) -> Self
Related types: InputParameter
clear_customizable_input_parameters
Omits customizable_input_parameters, including any model default.
fn clear_customizable_input_parameters(mut self) -> Self
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<Trigger, ValidationError>
Related types: Trigger, ValidationError
UrlSource
A linked source cited by a task card.
builder
Starts a builder with the documented model defaults.
fn builder() -> UrlSourceBuilder
Related types: UrlSourceBuilder
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> UrlSourceBuilder
Related types: UrlSourceBuilder
url
Borrows or copies url. Sets the source URL.
fn url(&self) -> &str
text
Borrows or copies text. Sets the source link text.
fn text(&self) -> &str
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
UrlSourceBuilder
Consuming builder for UrlSource. Validation runs in Self::build.
url
Sets the source URL.
fn url(mut self, value: impl Into<String>) -> Self
text
Sets the source link text.
fn text(mut self, value: impl Into<String>) -> Self
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<UrlSource, ValidationError>
Related types: UrlSource, ValidationError
Workflow
The workflow started by a workflow button.
builder
Starts a builder with the documented model defaults.
fn builder() -> WorkflowBuilder
Related types: WorkflowBuilder
into_builder
Moves every field into an editable builder, preserving explicit omissions.
fn into_builder(self) -> WorkflowBuilder
Related types: WorkflowBuilder
trigger
Borrows or copies trigger. Sets the link trigger that starts the workflow.
fn trigger(&self) -> &Trigger
Related types: Trigger
extensions
Borrows checked, unmodeled JSON extension fields.
fn extensions(&self) -> &Map<String, Value>
from_url
Builds a workflow from a trigger URL and ordered, validated input parameters.
An empty iterator omits customizable_input_parameters.
Errors
Returns the same validation errors as Trigger::builder and Workflow::builder.
fn from_url(
url: impl Into<String>,
parameters: impl IntoIterator<Item = InputParameter>,
) -> Result<Self, ValidationError>
Related types: InputParameter, ValidationError
WorkflowBuilder
Consuming builder for Workflow. Validation runs in Self::build.
trigger
Sets the link trigger that starts the workflow.
fn trigger(mut self, value: impl Into<Trigger>) -> Self
Related types: Trigger
extension
Adds or replaces an unmodeled extension; reserved names fail at build time.
fn extension(mut self, key: impl Into<String>, value: impl Into<Value>) -> Self
build
Validates all fields and their receiving context.
Errors
Returns a ValidationError for missing fields, invalid values, reserved
extension names, or unsupported field combinations and child contexts.
fn build(self) -> Result<Workflow, ValidationError>
Related types: ValidationError, Workflow