Struct slack_blocks::elems::button::build::ButtonBuilder

pub struct ButtonBuilder<'a, Text, ActionId> { /* fields omitted */ }

Button Builder

Allows you to construct safely, with compile-time checks on required setter methods.

Required Methods

ButtonBuilder::build() is only available if these methods have been called:

• action_id
• text

use std::convert::TryFrom;

use slack_blocks::{blocks, elems};

let button: elems::BlockElement = elems::Button::builder().text("do stuff!")
                                                          .action_id("stuff")
                                                          .build()
                                                          .into();
let block: blocks::Block =
  blocks::Actions::try_from(button).expect("Actions block supports buttons")
                                   .into();

Implementations

impl<'a, T, A> ButtonBuilder<'a, T, A>

pub fn new() -> Self

Construct a new button builder

pub fn style(self, style: Style) -> Self

Set style (Optional)

Decorates buttons with alternative visual color schemes.

Use this option with restraint.

If this method is not called, the default button style will be used.

pub fn confirm(self, confirm: Confirm) -> Self

Set confirm (Optional)

A confirm object 🔗 that defines an optional confirmation dialog after the button is clicked.

pub fn value(self, value: impl Into<Cow<'a, str>>) -> Self

Set value (Optional)

Add a meaningful value to send back to your app when this button is clicked.

Maximum length for this field is 2000 characters.

pub fn action_id(
    self,
    action_id: impl Into<Cow<'a, str>>
) -> ButtonBuilder<'a, T, Set<action_id>>

Set action_id (Required)

An identifier for this action.

You can use this when you receive an interaction payload to identify the source of the action 🔗.

Should be unique among all other action_ids used elsewhere by your app.

Maximum length for this field is 255 characters.

pub fn text(self, text: impl Into<Plain>) -> ButtonBuilder<'a, Set<text>, A>

Set text (Required)

A plain text object 🔗 that defines the button’s text.

Maximum length for the text in this field is 75 characters.

impl<'a> ButtonBuilder<'a, Set<text>, Set<action_id>>

pub fn build(self) -> Button<'a>

All done building, now give me a darn button!

no method name 'build' found for struct 'ButtonBuilder<...>'? Make sure all required setter methods have been called. See docs for ButtonBuilder.

use slack_blocks::elems::Button;

let foo = Button::builder().build(); // Won't compile!

use slack_blocks::{compose::Opt, elems::Button};

let foo = Button::builder().action_id("foo").text("Do foo").build();

Trait Implementations

impl<'a, Text: Debug, ActionId: Debug> Debug for ButtonBuilder<'a, Text, ActionId>

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

Formats the value using the given formatter.