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 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
use serde::{Deserialize, Serialize}; use std::borrow::Cow; use validator::Validate; use crate::compose::{opt::marker::FromText, Confirm, OptOrOptGroup}; use crate::text; use crate::val_helpr::ValidationResult; /// ## Select menu with external data source /// [slack api docs 🔗](https://api.slack.com/reference/block-kit/block-elements#external_select) /// /// This select menu will load its options from an external data source, /// allowing for a dynamic list of options. /// /// ### Setup /// For a guide to set up your app to use this element type, go to the Slack /// API section for [Select menu with external data source 🔗]. /// #[derive(Clone, Debug, Deserialize, Hash, PartialEq, Serialize, Validate)] pub struct External<'a> { #[validate(custom = "super::validate::placeholder")] placeholder: text::Text, #[validate(length(max = 255))] action_id: Cow<'a, str>, initial_option: Option<OptOrOptGroup<FromText<text::Plain>>>, min_query_length: Option<u64>, #[serde(skip_serializing_if = "Option::is_none")] #[validate] confirm: Option<Confirm>, } impl<'a> External<'a> { /// Construct an External Select element, letting users choose an option from an external data source. /// /// # Arguments /// - `placeholder` - A [`plain_text` only text object 🔗] that defines /// the placeholder text shown on the menu. /// Maximum length for the `text` in this field is 150 characters. /// /// - `action_id` - An identifier for the action triggered when a menu option is selected. /// You can use this when you receive an interaction payload to [identify the source of the action 🔗]. /// Should be unique among all other `action_id`s used elsewhere by your app. /// Maximum length for this field is 255 characters. /// /// [`plain_text` only text object 🔗]: https://api.slack.comhttps://api.slack.com/reference/block-kit/composition-objects#text /// [identify the source of the action 🔗]: https://api.slack.comhttps://api.slack.com/interactivity/handling#payloads /// /// # Example /// ``` /// use std::convert::TryFrom; /// use std::iter; /// /// use slack_blocks::block_elements::{BlockElement, select}; /// use slack_blocks::blocks; /// use slack_blocks::text; /// use text::ToSlackPlaintext; /// /// let select: BlockElement = select::External /// ::from_placeholder_and_action_id("Channel", "ABC123") /// .into(); /// /// let title = "Pick a user to ban...".plaintext(); /// /// let blocks: Vec<blocks::Block> = vec![ /// blocks::Section::from_text(title).into(), /// blocks::Actions::try_from(vec![select]).unwrap().into(), /// ]; /// /// // <send `blocks` to slack's API> /// ``` pub fn from_placeholder_and_action_id( placeholder: impl Into<text::Plain>, action_id: impl Into<Cow<'a, str>>, ) -> Self { Self { placeholder: placeholder.into().into(), action_id: action_id.into(), confirm: None, initial_option: None, min_query_length: None, } } /// Optional method that allows you to add a /// confirmation dialog that appears after a /// menu item is selected. /// /// # Arguments /// - `confirm` - A [confirm object 🔗] that defines an /// optional confirmation dialog that appears after /// a menu item is selected. /// /// [confirm object 🔗]: https://api.slack.comhttps://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 user to ban!", "ban_hammer") /// .with_confirm(confirm) /// .choose_from_users() /// .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 } /// Optional method that allows you to add a /// confirmation dialog that appears after a /// menu item is selected. /// /// # Arguments /// - `min_query_length` - When the typeahead field is used, a request will be sent on every character change. /// If you prefer fewer requests or more fully ideated queries, use the `min_query_length` attribute to tell Slack the fewest number of typed characters required before dispatch. /// The default value is `3`. /// /// # Example /// ``` /// use std::iter; /// use std::convert::TryFrom; /// /// use slack_blocks::{ /// blocks::{Block, Actions}, /// block_elements::{BlockElement, select::Select}, /// compose::{text, text::ToSlackPlaintext}, /// }; /// /// # use std::error::Error; /// # pub fn main() -> Result<(), Box<dyn Error>> { /// /// let select: BlockElement = Select::from_placeholder_and_action_id("Pick your favorite cheese!", "cheese_chosen") /// .choose_from_external() /// // we want a responsive typeahead because some cheese names are short! /// .with_min_query_length(1) /// .into(); /// /// let block: Block = Actions::try_from(select).unwrap().into(); /// /// // < send `block` to slack API > /// # Ok(()) /// # } /// ``` pub fn with_min_query_length(mut self, min_query_length: u64) -> Self { self.min_query_length = Some(min_query_length); self } /// Optional method that allows you to add a /// confirmation dialog that appears after a /// menu item is selected. /// /// # Arguments /// - `min_query_length` - When the typeahead field is used, a request will be sent on every character change. /// If you prefer fewer requests or more fully ideated queries, use the `min_query_length` attribute to tell Slack the fewest number of typed characters required before dispatch. /// The default value is `3`. /// /// # Example /// ``` /// use std::iter; /// use std::convert::TryFrom; /// /// use slack_blocks::{ /// blocks::{Block, Actions}, /// block_elements::{BlockElement, select::Select}, /// compose::{opt::Opt, text, text::ToSlackPlaintext}, /// }; /// /// # use std::error::Error; /// # pub fn main() -> Result<(), Box<dyn Error>> { /// /// let brie = Opt::from_plain_text_and_value("Brie", "cheese_brie"); /// /// let select: BlockElement = Select::from_placeholder_and_action_id( /// "Pick your favorite cheese!", /// "cheese_chosen", /// ) /// .choose_from_external() /// .with_initial_option(brie) /// .into(); /// /// let block: Block = Actions::try_from(select).unwrap().into(); /// /// // < send `block` to slack API > /// # Ok(()) /// # } /// ``` pub fn with_initial_option( mut self, option: impl Into<OptOrOptGroup<FromText<text::Plain>>>, ) -> Self { self.initial_option = Some(option.into()); self } /// Validate that this user select agrees with Slack's model requirements /// /// # Errors /// - If `from_placeholder_and_action_id` was called with /// `placeholder` longer than 150 chars /// - If `from_placeholder_and_action_id` was called with /// `action_id` longer than 255 chars /// /// # Example /// ``` /// use slack_blocks::block_elements::select; /// /// let select = select::External::from_placeholder_and_action_id( /// r#"Hey I really would appreciate it if you chose /// a channel relatively soon, so that we can figure out /// where we need to send this poll, ok? it's kind of /// important that you specify where this poll should be /// sent, in case we haven't made that super clear. /// If you understand, could you pick a channel, already??"#, /// "ABC123" /// ); /// /// assert!(matches!(select.validate(), Err(_))) /// ``` pub fn validate(&self) -> ValidationResult { Validate::validate(self) } }