1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
use std::borrow::Cow; use super::{Conversation, External, PublicChannel, User}; use crate::{compose::Confirm, text}; /// # Select Element Builder /// Use to construct a Select element /// and easily choose a data source pub struct SelectBuilder<'a> { pub placeholder: text::Plain, pub action_id: Cow<'a, str>, pub confirm: Option<Confirm>, } impl<'a> SelectBuilder<'a> { /// Construct a Select block element from required parts /// /// # Arguments /// - `placeholder`: A [text object 🔗] /// /// [text objects 🔗]: https://api.slack.com/reference/messaging/composition-objects#text /// /// # Example /// See example for `Select::from_placeholder_and_action_id` pub fn from_placeholder_and_action_id(placeholder: impl Into<text::Plain>, action_id: impl Into<Cow<'a, str>>) -> Self { Self { placeholder: placeholder.into(), action_id: action_id.into(), confirm: None } } /// Construct a Select block element from required parts /// /// # Arguments /// - `confirm`: A [confirm object 🔗] that defines an optional confirmation dialog that appears after a menu item is selected. /// /// [confirm object 🔗]: https://api.slack.com/reference/block-kit/composition-objects#confirm /// /// # Example /// ``` /// use std::iter; /// use std::convert::TryFrom; /// /// use slack_blocks::{ /// blocks::{Block, Actions}, /// block_elements::{BlockElement, select::Select}, /// compose::{text, Confirm, text::ToSlackPlaintext}, /// }; /// /// # use std::error::Error; /// # pub fn main() -> Result<(), Box<dyn Error>> { /// /// let confirm = Confirm::from_parts( /// "Are you sure?", /// "Think hard about this.".plaintext(), /// "Yes", /// "No", /// ); /// /// let select: BlockElement = Select::from_placeholder_and_action_id("Pick a channel to delete!", "delete_chan_select") /// .with_confirm(confirm) /// .choose_from_public_channels() /// .into(); /// /// let block: Block = Actions::try_from(select).unwrap().into(); /// /// // < send `block` to slack API > /// # Ok(()) /// # } /// ``` pub fn with_confirm(mut self, confirm: Confirm) -> Self { self.confirm = Some(confirm); self } /// Turn the builder into a Public Channel select element /// /// # Example /// ``` /// use std::iter; /// use std::convert::TryFrom; /// /// use slack_blocks::{ /// blocks::{Block, Section, Actions}, /// block_elements::{BlockElement, select::Select}, /// compose::{text, Confirm}, /// }; /// /// # use std::error::Error; /// # pub fn main() -> Result<(), Box<dyn Error>> { /// /// let confirm = Confirm::from_parts("Are you sure?", text::Mrkdwn::from("Think hard about this."), "Yes", "No"); /// /// let select: BlockElement = Select::from_placeholder_and_action_id("Pick a channel to delete!", "1234") /// .with_confirm(confirm) /// .choose_from_public_channels() /// .into(); /// /// let block: Block = Actions::try_from(select).unwrap().into(); /// /// // < send `block` to slack API > /// # Ok(()) /// # } /// ``` pub fn choose_from_public_channels(self) -> PublicChannel<'a> { let sel = PublicChannel::from_placeholder_and_action_id(self.placeholder, self.action_id); match self.confirm { | Some(confirm) => sel.with_confirm(confirm), | None => sel, } } /// Set the data source to "All conversations". See docs for `select::Conversation` for more info. /// /// # Example /// ``` /// use std::iter; /// use std::convert::TryFrom; /// /// use slack_blocks::{ /// blocks::{Block, Section, Actions}, /// block_elements::{BlockElement, select::Select}, /// compose::{text, Confirm}, /// }; /// /// use text::ToSlackPlaintext; /// /// # use std::error::Error; /// # pub fn main() -> Result<(), Box<dyn Error>> { /// /// let select: BlockElement = Select::from_placeholder_and_action_id("Channel", "get_member_channel_select") /// .choose_from_all_channels() /// .into(); /// /// let blocks: Vec<Block> = vec![ /// Section::from_text("Get the members of a channel".plaintext()).into(), /// Actions::try_from(select).unwrap().into(), /// ]; /// /// // <send `blocks` to slack's API> /// # Ok(()) /// # } /// ``` pub fn choose_from_all_channels(self) -> Conversation<'a> { let sel = Conversation::from_placeholder_and_action_id(self.placeholder, self.action_id); match self.confirm { | Some(confirm) => sel.with_confirm(confirm), | None => sel, } } /// Set the data source to "users". See docs for `select::User` for more info. /// /// # Example /// ``` /// use std::{convert::TryFrom, iter}; /// /// use slack_blocks::{block_elements::{select::Select, BlockElement}, /// blocks::{Actions, Block, Section}, /// text, /// text::ToSlackPlaintext}; /// /// let select: BlockElement = /// Select::from_placeholder_and_action_id("Choose a user to ban!!", /// "ban_chosen").choose_from_users() /// .into(); /// /// let blocks: Block = Actions::try_from(select).unwrap().into(); /// /// // <send `blocks` to slack's API> /// ``` pub fn choose_from_users(self) -> User<'a> { let sel = User::from_placeholder_and_action_id(self.placeholder, self.action_id); match self.confirm { | Some(confirm) => sel.with_confirm(confirm), | None => sel, } } /// Users will choose from an external data source. See docs for `select::External` for more info. /// /// # Example /// ``` /// use std::iter; /// use std::convert::TryFrom; /// /// use slack_blocks::{ /// text, /// text::ToSlackPlaintext, /// blocks::{Block, Section, Actions}, /// block_elements::{BlockElement, select::Select}, /// }; /// /// let select: BlockElement = Select::from_placeholder_and_action_id("Pick your favorite cheese", "cheese_chosen") /// .choose_from_external() /// .into(); /// /// let blocks: Block = Actions::try_from(select).unwrap().into(); /// /// // <send `blocks` to slack's API> /// ``` pub fn choose_from_external(self) -> External<'a> { let sel = External::from_placeholder_and_action_id(self.placeholder, self.action_id); match self.confirm { | Some(confirm) => sel.with_confirm(confirm), | None => sel, } } }