Skip to main content

Actions

Struct Actions 

Source
pub struct Actions { /* private fields */ }
Expand description

Actions block representation.

§Fields and Validations

For more details, see the official documentation.

FieldTypeRequiredValidation
elementsVec<ActionsElement>YesMaximum of 25 items
block_idStringNoMaximum 255 characters

§Example

The following is reproduction of the 1st sample actions.

use slack_messaging::plain_text;
use slack_messaging::blocks::Actions;
use slack_messaging::blocks::elements::{Button, SelectMenuStaticOptions};
use slack_messaging::composition_objects::Opt;

let actions = Actions::builder()
    .block_id("actions1")
    .element(
        SelectMenuStaticOptions::builder()
            .action_id("select_2")
            .placeholder(plain_text!("Which witch is the witchiest witch?")?)
            .options(
                vec![
                    Opt::builder()
                        .text(plain_text!("Matilda")?)
                        .value("matilda")
                        .build()?,
                    Opt::builder()
                        .text(plain_text!("Glinda")?)
                        .value("glinda")
                        .build()?,
                    Opt::builder()
                        .text(plain_text!("Granny Weatherwax")?)
                        .value("grannyWeatherwax")
                        .build()?,
                    Opt::builder()
                        .text(plain_text!("Hermione")?)
                        .value("hermione")
                        .build()?,
                ]
            )
            .build()?
    )
    .element(
        Button::builder()
            .action_id("button_1")
            .value("cancel")
            .text(plain_text!("Cancel")?)
            .build()?
    )
    .build()?;

let expected = serde_json::json!({
    "type": "actions",
    "block_id": "actions1",
    "elements": [
        {
            "type": "static_select",
            "action_id": "select_2",
            "placeholder": {
                "type": "plain_text",
                "text": "Which witch is the witchiest witch?"
            },
            "options": [
                {
                    "text": {
                        "type": "plain_text",
                        "text": "Matilda"
                    },
                    "value": "matilda"
                },
                {
                    "text": {
                        "type": "plain_text",
                        "text": "Glinda"
                    },
                    "value": "glinda"
                },
                {
                    "text": {
                        "type": "plain_text",
                        "text": "Granny Weatherwax"
                    },
                    "value": "grannyWeatherwax"
                },
                {
                    "text": {
                        "type": "plain_text",
                        "text": "Hermione"
                    },
                    "value": "hermione"
                }
            ]
        },
        {
            "type": "button",
            "text": {
                "type": "plain_text",
                "text": "Cancel"
            },
            "value": "cancel",
            "action_id": "button_1"
        }
    ]
});

let json = serde_json::to_value(actions).unwrap();

assert_eq!(json, expected);

And the following is the 2nd sample actions.

use slack_messaging::plain_text;
use slack_messaging::blocks::Actions;
use slack_messaging::blocks::elements::{Button, DatePicker, OverflowMenu};
use slack_messaging::composition_objects::Opt;

let actions = Actions::builder()
    .block_id("actionblock789")
    .element(
        DatePicker::builder()
            .action_id("datepicker123")
            .initial_date("1990-04-28")
            .placeholder(plain_text!("Select a date")?)
            .build()?
    )
    .element(
        OverflowMenu::builder()
            .action_id("overflow")
            .option(
                Opt::builder()
                    .text(plain_text!("*this is plain_text text*")?)
                    .value("value-0")
                    .build()?
            )
            .option(
                Opt::builder()
                    .text(plain_text!("*this is plain_text text*")?)
                    .value("value-1")
                    .build()?
            )
            .option(
                Opt::builder()
                    .text(plain_text!("*this is plain_text text*")?)
                    .value("value-2")
                    .build()?
            )
            .option(
                Opt::builder()
                    .text(plain_text!("*this is plain_text text*")?)
                    .value("value-3")
                    .build()?
            )
            .option(
                Opt::builder()
                    .text(plain_text!("*this is plain_text text*")?)
                    .value("value-4")
                    .build()?
            )
            .build()?
    )
    .element(
        Button::builder()
            .action_id("button")
            .value("click_me_123")
            .text(plain_text!("Click Me")?)
            .build()?
    )
    .build()?;

let expected = serde_json::json!({
    "type": "actions",
    "block_id": "actionblock789",
    "elements": [
        {
            "type": "datepicker",
            "action_id": "datepicker123",
            "initial_date": "1990-04-28",
            "placeholder": {
                "type": "plain_text",
                "text": "Select a date"
            }
        },
        {
            "type": "overflow",
            "action_id": "overflow",
            "options": [
                {
                    "text": {
                        "type": "plain_text",
                        "text": "*this is plain_text text*"
                    },
                    "value": "value-0"
                },
                {
                    "text": {
                        "type": "plain_text",
                        "text": "*this is plain_text text*"
                    },
                    "value": "value-1"
                },
                {
                    "text": {
                        "type": "plain_text",
                        "text": "*this is plain_text text*"
                    },
                    "value": "value-2"
                },
                {
                    "text": {
                        "type": "plain_text",
                        "text": "*this is plain_text text*"
                    },
                    "value": "value-3"
                },
                {
                    "text": {
                        "type": "plain_text",
                        "text": "*this is plain_text text*"
                    },
                    "value": "value-4"
                }
            ]
        },
        {
            "type": "button",
            "text": {
                "type": "plain_text",
                "text": "Click Me"
            },
            "value": "click_me_123",
            "action_id": "button"
        }
    ]
});

let json = serde_json::to_value(actions).unwrap();

assert_eq!(json, expected);

Implementations§

Trait Implementations§

Source§

impl Clone for Actions

Source§

fn clone(&self) -> Actions

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Actions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<Actions> for Block

Source§

fn from(value: Actions) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for Actions

Source§

fn eq(&self, other: &Actions) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Actions

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Actions

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.