slack_messaging/composition_objects/
dispatch_action_configuration.rs

1use crate::composition_objects::types::TriggerAction;
2use crate::validators::*;
3
4use serde::Serialize;
5use slack_messaging_derive::Builder;
6
7/// [Dispatch action configuration](https://docs.slack.dev/reference/block-kit/composition-objects/dispatch-action-configuration-object)
8/// representation.
9///
10/// # Fields and Validations
11///
12/// For more details, see the [official
13/// documentation](https://docs.slack.dev/reference/block-kit/composition-objects/dispatch-action-configuration-object).
14///
15/// | Field | Type | Required | Validation |
16/// |-------|------|----------|------------|
17/// | trigger_actions_on | Vec<[TriggerAction]> | No | Must contain at least one item if provided |
18///
19/// # Example
20///
21/// ```
22/// use slack_messaging::composition_objects::{DispatchActionConfiguration, types::TriggerAction};
23/// # use std::error::Error;
24///
25/// # fn try_main() -> Result<(), Box<dyn Error>> {
26/// let config = DispatchActionConfiguration::builder()
27///     .trigger_action(TriggerAction::OnEnterPressed)
28///     .trigger_action(TriggerAction::OnCharacterEntered)
29///     .build()?;
30///
31/// let expected = serde_json::json!({
32///     "trigger_actions_on": [
33///         "on_enter_pressed",
34///         "on_character_entered"
35///     ]
36/// });
37///
38/// let json = serde_json::to_value(config).unwrap();
39///
40/// assert_eq!(json, expected);
41///
42/// // If your object has any validation errors, the build method returns Result::Err
43/// let config = DispatchActionConfiguration::builder()
44///     .trigger_actions_on(vec![])
45///     .build();
46/// assert!(config.is_err());
47/// #     Ok(())
48/// # }
49/// # fn main() {
50/// #     try_main().unwrap()
51/// # }
52/// ```
53#[derive(Debug, Clone, Serialize, PartialEq, Builder)]
54pub struct DispatchActionConfiguration {
55    #[serde(skip_serializing_if = "Option::is_none")]
56    #[builder(push_item = "trigger_action", validate("list::not_empty"))]
57    pub(crate) trigger_actions_on: Option<Vec<TriggerAction>>,
58}
59
60#[cfg(test)]
61mod tests {
62    use super::*;
63    use crate::errors::*;
64
65    #[test]
66    fn it_implements_builder() {
67        let expected = DispatchActionConfiguration {
68            trigger_actions_on: Some(vec![
69                TriggerAction::OnEnterPressed,
70                TriggerAction::OnCharacterEntered,
71            ]),
72        };
73
74        let config = DispatchActionConfiguration::builder()
75            .set_trigger_actions_on(Some(vec![
76                TriggerAction::OnEnterPressed,
77                TriggerAction::OnCharacterEntered,
78            ]))
79            .build()
80            .unwrap();
81
82        assert_eq!(config, expected);
83
84        let config = DispatchActionConfiguration::builder()
85            .trigger_actions_on(vec![
86                TriggerAction::OnEnterPressed,
87                TriggerAction::OnCharacterEntered,
88            ])
89            .build()
90            .unwrap();
91
92        assert_eq!(config, expected);
93    }
94
95    #[test]
96    fn it_implements_push_item_method() {
97        let expected = DispatchActionConfiguration {
98            trigger_actions_on: Some(vec![
99                TriggerAction::OnEnterPressed,
100                TriggerAction::OnCharacterEntered,
101            ]),
102        };
103
104        let config = DispatchActionConfiguration::builder()
105            .trigger_action(TriggerAction::OnEnterPressed)
106            .trigger_action(TriggerAction::OnCharacterEntered)
107            .build()
108            .unwrap();
109
110        assert_eq!(config, expected);
111    }
112
113    #[test]
114    fn it_requires_trigger_actions_on_field_not_empty() {
115        let err = DispatchActionConfiguration::builder()
116            .trigger_actions_on(vec![])
117            .build()
118            .unwrap_err();
119        assert_eq!(err.object(), "DispatchActionConfiguration");
120
121        let errors = err.field("trigger_actions_on");
122        assert!(errors.includes(ValidationErrorKind::EmptyArray));
123    }
124}
slack_messaging/composition_objects/dispatch_action_configuration.rs

slack_messaging/composition_objects/
dispatch_action_configuration.rs
