Struct slack_blocks::elems::select::external::External

pub struct External<'a> { /* fields omitted */ }

Select menu with external data source

slack api docs 🔗

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>

pub fn builder() -> ExternalBuilderInit<'a>

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

👎 Deprecated since 0.16.7:

Use External::builder instead

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_ids 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

👎 Deprecated since 0.16.7:

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

👎 Deprecated since 0.16.7:

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 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},
  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

👎 Deprecated since 0.16.7:

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 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::{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>

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::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<'a> Clone for External<'a>

fn clone(&self) -> External<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for External<'a>

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

Formats the value using the given formatter.

impl<'de, 'a> Deserialize<'de> for External<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<'a> From<External<'a>> for SupportedElement<'a>

fn from(src: External<'a>) -> Self

Performs the conversion.

impl<'a> From<External<'a>> for SupportedElement<'a>

fn from(src: External<'a>) -> Self

Performs the conversion.

impl<'a> From<External<'a>> for Select<'a>

fn from(src: External<'a>) -> Self

Performs the conversion.

impl<'a> From<External<'a>> for BlockElement<'a>

fn from(src: External<'a>) -> Self

Performs the conversion.

impl<'a> Hash for External<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq<External<'a>> for External<'a>

fn eq(&self, other: &External<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &External<'a>) -> bool

This method tests for !=.

impl<'a> Serialize for External<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'a> Validate for External<'a>

fn validate(&self) -> Result<(), ValidationErrors>

impl<'a> StructuralPartialEq for External<'a>