Struct slack_messaging::blocks::elements::MultiSelectConversations

source ·

pub struct MultiSelectConversations { /* private fields */ }

Expand description

Multi-select menu Conversations list element representation.

Example

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

let menu = MultiSelectConversations::new()
    .set_action_id("text1234")
    .placeholder("Select conversations");

let expected = json!({
    "type": "multi_conversations_select",
    "action_id": "text1234",
    "placeholder": {
        "type": "plain_text",
        "text": "Select conversations",
        "emoji": true
    }
});

let menu_json = serde_json::to_value(menu).unwrap();

assert_eq!(menu_json, expected);

Implementations§

source §

impl MultiSelectConversations

source

pub fn new() -> Self

Constructs a Multi-select menu Conversations list element with empty values.

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

let menu = MultiSelectConversations::new();

let expected = json!({
    "type": "multi_conversations_select",
    "action_id": ""
});

let menu_json = serde_json::to_value(menu).unwrap();

assert_eq!(menu_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::MultiSelectConversations;
use serde_json::json;

let menu = MultiSelectConversations::new().set_action_id("text1234");

let expected = json!({
    "type": "multi_conversations_select",
    "action_id": "text1234"
});

let menu_json = serde_json::to_value(menu).unwrap();

assert_eq!(menu_json, expected);

source

pub fn set_initial_conversations( self, initial_conversations: Vec<String> ) -> Self

Sets initial_conversations field directly.

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

let menu = MultiSelectConversations::new()
    .set_initial_conversations(
        vec!["conversation_0".to_string(), "conversation_1".to_string()]
    );

let expected = json!({
    "type": "multi_conversations_select",
    "action_id": "",
    "initial_conversations": ["conversation_0", "conversation_1"]
});

let menu_json = serde_json::to_value(menu).unwrap();

assert_eq!(menu_json, expected);

source

pub fn push_initial_conversation<T: Into<String>>(self, conversation: T) -> Self

Adds string to initial_conversations field.

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

let menu = MultiSelectConversations::new()
    .push_initial_conversation("conversation_0");

let expected = json!({
    "type": "multi_conversations_select",
    "action_id": "",
    "initial_conversations": ["conversation_0"]
});

let menu_json = serde_json::to_value(menu).unwrap();

assert_eq!(menu_json, expected);

source

pub fn set_default_to_current_conversation( self, current_conversation: bool ) -> Self

Sets default_to_current_conversation field.

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

let menu = MultiSelectConversations::new()
    .set_default_to_current_conversation(true);

let expected = json!({
    "type": "multi_conversations_select",
    "action_id": "",
    "default_to_current_conversation": true
});

let menu_json = serde_json::to_value(menu).unwrap();

assert_eq!(menu_json, expected);

source

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

Sets confirm field with ConfirmationDialog object.

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

let menu = MultiSelectConversations::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": "multi_conversations_select",
    "action_id": "",
    "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 menu_json = serde_json::to_value(menu).unwrap();

assert_eq!(menu_json, expected);

source

pub fn set_max_selected_items<T: Into<i64>>(self, items: T) -> Self

Sets max_selected_items field.

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

let menu = MultiSelectConversations::new()
    .set_max_selected_items(3);

let expected = json!({
    "type": "multi_conversations_select",
    "action_id": "",
    "max_selected_items": 3
});

let menu_json = serde_json::to_value(menu).unwrap();

assert_eq!(menu_json, expected);

source

pub fn set_filter(self, filter: Filter) -> Self

Sets filter field with Filter object.

use slack_messaging::blocks::elements::{MultiSelectConversations, Filter, Conversation};
use serde_json::json;

let menu = MultiSelectConversations::new()
    .set_filter(
        Filter::new()
            .include(Conversation::Public)
            .include(Conversation::Mpim)
            .exclude_bot_users()
    );

let expected = json!({
    "type": "multi_conversations_select",
    "action_id": "",
    "filter": {
        "include": [
            "public",
            "mpim"
        ],
        "exclude_bot_users": true
    }
});

let menu_json = serde_json::to_value(menu).unwrap();

assert_eq!(menu_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::MultiSelectConversations;
use serde_json::json;

let menu = MultiSelectConversations::new().set_focus_on_load(true);

let expected = json!({
    "type": "multi_conversations_select",
    "action_id": "",
    "focus_on_load": true
});

let menu_json = serde_json::to_value(menu).unwrap();

assert_eq!(menu_json, expected);

source

pub fn set_placeholder(self, placeholder: Text) -> Self

Sets placeholder field.

use slack_messaging::blocks::elements::{MultiSelectConversations, Text};
use serde_json::json;

let menu = MultiSelectConversations::new()
    .set_placeholder(Text::plain("Select conversations"));

let expected = json!({
    "type": "multi_conversations_select",
    "action_id": "",
    "placeholder": {
        "type": "plain_text",
        "text": "Select conversations",
        "emoji": true
    }
});

let menu_json = serde_json::to_value(menu).unwrap();

assert_eq!(menu_json, expected);

source

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

Sets placeholder field from string. This is a shorthand for set_placeholder method.

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

let menu = MultiSelectConversations::new().placeholder("Select conversations");

let expected = json!({
    "type": "multi_conversations_select",
    "action_id": "",
    "placeholder": {
        "type": "plain_text",
        "text": "Select conversations",
        "emoji": true
    }
});

let menu_json = serde_json::to_value(menu).unwrap();

assert_eq!(menu_json, expected);