Struct slack_blocks::elems::select::External [−][src]
pub struct External<'a> { /* fields omitted */ }
Expand description
Select menu with external data source
This select menu will load its options from an external data source, allowing for a dynamic list of options.
Setup
Slack API doc guide for setting up an external data source 🔗
Implementations
impl<'a> External<'a>
[src]
impl<'a> External<'a>
[src]pub fn builder() -> ExternalBuilderInit<'a>
[src]
pub fn builder() -> ExternalBuilderInit<'a>
[src]Build a new external select element
Examples
use std::convert::TryFrom; use slack_blocks::{blocks::{Actions, Block}, compose::Opt, elems::{select, BlockElement}, text}; let select: BlockElement = select::External::builder().placeholder("Choose your favorite city!") .action_id("fave_city") .build() .into(); let block: Block = Actions::try_from(select).unwrap().into();
pub fn from_placeholder_and_action_id(
placeholder: impl Into<Plain>,
action_id: impl Into<Cow<'a, str>>
) -> Self
[src]
👎 Deprecated since 0.16.7: Use External::builder instead
pub fn from_placeholder_and_action_id(
placeholder: impl Into<Plain>,
action_id: impl Into<Cow<'a, str>>
) -> Self
[src]Use External::builder instead
Construct an External Select element, letting users choose an option from an external data source.
Arguments
-
placeholder
- Aplain_text
only text object 🔗 that defines the placeholder text shown on the menu. Maximum length for thetext
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 otheraction_id
s used elsewhere by your app. Maximum length for this field is 255 characters.
Example
use std::convert::TryFrom; use std::iter; use slack_blocks::elems::{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 with_confirm(self, confirm: Confirm) -> Self
[src]
👎 Deprecated since 0.16.7: Use External::builder instead
pub fn with_confirm(self, confirm: Confirm) -> Self
[src]Use External::builder instead
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.
Example
use std::iter; use std::convert::TryFrom; use slack_blocks::{ blocks::{Block, Actions}, elems::{BlockElement, select::Select}, compose::{text, Confirm, text::ToSlackPlaintext}, }; 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 >
pub fn with_min_query_length(self, min_query_length: u64) -> Self
[src]
👎 Deprecated since 0.16.7: Use External::builder instead
pub fn with_min_query_length(self, min_query_length: u64) -> Self
[src]Use External::builder instead
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 themin_query_length
attribute to tell Slack the fewest number of typed characters required before dispatch. The default value is3
.
Example
use std::iter; use std::convert::TryFrom; use slack_blocks::{ blocks::{Block, Actions}, elems::{BlockElement, select::Select}, compose::{text, text::ToSlackPlaintext}, }; 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 >
pub fn with_initial_option(
self,
option: impl Into<OptOrOptGroup<'a, Plain, NoUrl>>
) -> Self
[src]
👎 Deprecated since 0.16.7: Use External::builder instead
pub fn with_initial_option(
self,
option: impl Into<OptOrOptGroup<'a, Plain, NoUrl>>
) -> Self
[src]Use External::builder instead
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 themin_query_length
attribute to tell Slack the fewest number of typed characters required before dispatch. The default value is3
.
Example
use std::{convert::TryFrom, iter}; use slack_blocks::{blocks::{Actions, Block}, compose::{opt::Opt, text, text::ToSlackPlaintext}, elems::{select::Select, BlockElement}}; 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 >
pub fn validate(&self) -> Result<(), ValidationErrors>
[src]
pub fn validate(&self) -> Result<(), ValidationErrors>
[src]Validate that this user select agrees with Slack’s model requirements
Errors
- If
from_placeholder_and_action_id
was called withplaceholder
longer than 150 chars - If
from_placeholder_and_action_id
was called withaction_id
longer than 255 chars
Example
use slack_blocks::elems::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(_)))
Trait Implementations
impl<'de, 'a> Deserialize<'de> for External<'a>
[src]
impl<'de, 'a> Deserialize<'de> for External<'a>
[src]fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]Deserialize this value from the given Serde deserializer. Read more
impl<'a> From<External<'a>> for SupportedElement<'a>
[src]
impl<'a> From<External<'a>> for SupportedElement<'a>
[src]impl<'a> From<External<'a>> for SupportedElement<'a>
[src]
impl<'a> From<External<'a>> for SupportedElement<'a>
[src]impl<'a> From<External<'a>> for BlockElement<'a>
[src]
impl<'a> From<External<'a>> for BlockElement<'a>
[src]impl<'a> StructuralPartialEq for External<'a>
[src]
Auto Trait Implementations
impl<'a> RefUnwindSafe for External<'a>
impl<'a> Send for External<'a>
impl<'a> Sync for External<'a>
impl<'a> Unpin for External<'a>
impl<'a> UnwindSafe for External<'a>
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,