Struct slack_messaging::blocks::elements::RadioButtonGroup

source ·

pub struct RadioButtonGroup { /* private fields */ }

Expand description

Radio buton group element representation.

Example

use slack_messaging::blocks::elements::{RadioButtonGroup, Opt};
use serde_json::json;

let radio = RadioButtonGroup::new()
    .set_action_id("radio_button_group")
    .push_option(
        Opt::plain("Radio 1").set_value("A1")
    )
    .push_option(
        Opt::plain("Radio 2").set_value("A2")
    );

let expected = json!({
    "type": "radio_buttons",
    "action_id": "radio_button_group",
    "options": [
        {
            "value": "A1",
            "text": {
                "type": "plain_text",
                "text": "Radio 1",
                "emoji": true
            }
        },
        {
            "value": "A2",
            "text": {
                "type": "plain_text",
                "text": "Radio 2",
                "emoji": true
            }
        }
    ]
});

let radio_json = serde_json::to_value(radio).unwrap();

assert_eq!(radio_json, expected);

Implementations§

source §

impl RadioButtonGroup

source

pub fn new() -> Self

Constructs a Radio button group element with empty values.

use slack_messaging::blocks::elements::RadioButtonGroup;
use serde_json::json;

let radio = RadioButtonGroup::new();

let expected = json!({
    "type": "radio_buttons",
    "action_id": "",
    "options": []
});

let radio_json = serde_json::to_value(radio).unwrap();

assert_eq!(radio_json, expected);

source

pub fn set_action_id<T: Into<String>>(self, action_id: T) -> Self

Sets action_id field.

use slack_messaging::blocks::elements::RadioButtonGroup;
use serde_json::json;

let radio = RadioButtonGroup::new().set_action_id("radio_button_group");

let expected = json!({
    "type": "radio_buttons",
    "action_id": "radio_button_group",
    "options": []
});

let radio_json = serde_json::to_value(radio).unwrap();

assert_eq!(radio_json, expected);

source

pub fn set_options(self, options: Vec<Opt>) -> Self

Sets options field directly.

use slack_messaging::blocks::elements::{RadioButtonGroup, Opt};
use serde_json::json;

let radio = RadioButtonGroup::new()
    .set_options(
        vec![
            Opt::plain("Radio 1").set_value("A1"),
            Opt::plain("Radio 2").set_value("A2"),
        ]
    );

let expected = json!({
    "type": "radio_buttons",
    "action_id": "",
    "options": [
        {
            "value": "A1",
            "text": {
                "type": "plain_text",
                "text": "Radio 1",
                "emoji": true
            }
        },
        {
            "value": "A2",
            "text": {
                "type": "plain_text",
                "text": "Radio 2",
                "emoji": true
            }
        }
    ]
});

let radio_json = serde_json::to_value(radio).unwrap();

assert_eq!(radio_json, expected);

source

pub fn push_option(self, option: Opt) -> Self

Adds Opt object to options field.

use slack_messaging::blocks::elements::{RadioButtonGroup, Opt};
use serde_json::json;

let radio = RadioButtonGroup::new()
    .push_option(
        Opt::plain("Radio 1").set_value("A1")
    );

let expected = json!({
    "type": "radio_buttons",
    "action_id": "",
    "options": [
        {
            "value": "A1",
            "text": {
                "type": "plain_text",
                "text": "Radio 1",
                "emoji": true
            }
        }
    ]
});

let radio_json = serde_json::to_value(radio).unwrap();

assert_eq!(radio_json, expected);

source

pub fn set_initial_option(self, initial_option: Opt) -> Self

Sets initial_option field.

use slack_messaging::blocks::elements::{RadioButtonGroup, Opt};
use serde_json::json;

let radio = RadioButtonGroup::new()
    .set_initial_option(
        Opt::plain("Radio 1").set_value("A1")
    );

let expected = json!({
    "type": "radio_buttons",
    "action_id": "",
    "options": [],
    "initial_option": {
       "value": "A1",
       "text": {
           "type": "plain_text",
           "text": "Radio 1",
           "emoji": true
       }
    }
});

let radio_json = serde_json::to_value(radio).unwrap();

assert_eq!(radio_json, expected);

source

pub fn set_confirm(self, confirm: ConfirmationDialog) -> Self

Sets confirm field with ConfirmationDialog object.

use slack_messaging::blocks::elements::{RadioButtonGroup, ConfirmationDialog};
use serde_json::json;

let radio = RadioButtonGroup::new()
    .set_confirm(
        ConfirmationDialog::new()
            .set_title("Are you sure?")
            .set_text("Wouldn't you prefer a good game of _chess_?")
            .set_confirm("Do it")
            .set_deny("Stop, I've changed my mind!")
    );

let expected = json!({
    "type": "radio_buttons",
    "action_id": "",
    "options": [],
    "confirm": {
        "title": {
            "type": "plain_text",
            "text": "Are you sure?",
            "emoji": true
        },
        "text": {
            "type": "plain_text",
            "text": "Wouldn't you prefer a good game of _chess_?",
            "emoji": true
        },
        "confirm": {
            "type": "plain_text",
            "text": "Do it",
            "emoji": true
        },
        "deny": {
            "type": "plain_text",
            "text": "Stop, I've changed my mind!",
            "emoji": true
        }
    }
});

let radio_json = serde_json::to_value(radio).unwrap();

assert_eq!(radio_json, expected);

source

pub fn set_focus_on_load(self, focus_on_load: bool) -> Self

Sets focus_on_load field.

use slack_messaging::blocks::elements::RadioButtonGroup;
use serde_json::json;

let radio = RadioButtonGroup::new().set_focus_on_load(true);

let expected = json!({
    "type": "radio_buttons",
    "action_id": "",
    "options": [],
    "focus_on_load": true
});

let radio_json = serde_json::to_value(radio).unwrap();

assert_eq!(radio_json, expected);