slack_messaging/blocks/elements/
time_picker.rs

1use crate::composition_objects::{ConfirmationDialog, Plain, Text};
2use crate::validators::*;
3
4use serde::Serialize;
5use slack_messaging_derive::Builder;
6
7/// [Time picker element](https://docs.slack.dev/reference/block-kit/block-elements/time-picker-element)
8/// representation.
9///
10/// # Fields and Validations
11///
12/// For more details, see the [official
13/// documentation](https://docs.slack.dev/reference/block-kit/block-elements/time-picker-element).
14///
15/// | Field | Type | Required | Validation |
16/// |-------|------|----------|------------|
17/// | action_id | String | No | Max length 255 characters |
18/// | initial_time | String | No | Must match the format "HH:mm" (24-hour format) |
19/// | confirm | [ConfirmationDialog] | No | N/A |
20/// | focus_on_load | bool | No | N/A |
21/// | placeholder | [Text]<[Plain]> | No | Max length 150 characters |
22/// | timezone | String | No | N/A |
23///
24/// # Example
25///
26/// ```
27/// use slack_messaging::plain_text;
28/// use slack_messaging::blocks::elements::TimePicker;
29/// # use std::error::Error;
30///
31/// # fn try_main() -> Result<(), Box<dyn Error>> {
32/// let timepicker = TimePicker::builder()
33///     .action_id("timepicker123")
34///     .initial_time("11:30")
35///     .timezone("Asia/Tokyo")
36///     .placeholder(plain_text!("Select a time")?)
37///     .build()?;
38///
39/// let expected = serde_json::json!({
40///     "type": "timepicker",
41///     "action_id": "timepicker123",
42///     "initial_time": "11:30",
43///     "timezone": "Asia/Tokyo",
44///     "placeholder": {
45///         "type": "plain_text",
46///         "text": "Select a time"
47///     }
48/// });
49///
50/// let json = serde_json::to_value(timepicker).unwrap();
51///
52/// assert_eq!(json, expected);
53///
54/// // If your object has any validation errors, the build method returns Result::Err
55/// let timepicker = TimePicker::builder()
56///     .action_id("timepicker123")
57///     .initial_time("25:30")
58///     .build();
59///
60/// assert!(timepicker.is_err());
61/// #     Ok(())
62/// # }
63/// # fn main() {
64/// #     try_main().unwrap()
65/// # }
66/// ```
67#[derive(Debug, Clone, Serialize, PartialEq, Builder)]
68#[serde(tag = "type", rename = "timepicker")]
69pub struct TimePicker {
70    #[serde(skip_serializing_if = "Option::is_none")]
71    #[builder(validate("text::max_255"))]
72    pub(crate) action_id: Option<String>,
73
74    #[serde(skip_serializing_if = "Option::is_none")]
75    #[builder(validate("text::time_format"))]
76    pub(crate) initial_time: Option<String>,
77
78    #[serde(skip_serializing_if = "Option::is_none")]
79    pub(crate) confirm: Option<ConfirmationDialog>,
80
81    #[serde(skip_serializing_if = "Option::is_none")]
82    pub(crate) focus_on_load: Option<bool>,
83
84    #[serde(skip_serializing_if = "Option::is_none")]
85    #[builder(validate("text_object::max_150"))]
86    pub(crate) placeholder: Option<Text<Plain>>,
87
88    #[serde(skip_serializing_if = "Option::is_none")]
89    pub(crate) timezone: Option<String>,
90}
91
92#[cfg(test)]
93mod tests {
94    use super::*;
95    use crate::composition_objects::test_helpers::*;
96    use crate::errors::*;
97
98    #[test]
99    fn it_implements_builder() {
100        let expected = TimePicker {
101            action_id: Some("time_picker_0".into()),
102            initial_time: Some("10:30".into()),
103            confirm: Some(confirm()),
104            focus_on_load: Some(true),
105            placeholder: Some(plain_text("Select a time")),
106            timezone: Some("Asia/Tokyo".into()),
107        };
108
109        let val = TimePicker::builder()
110            .set_action_id(Some("time_picker_0"))
111            .set_initial_time(Some("10:30"))
112            .set_confirm(Some(confirm()))
113            .set_focus_on_load(Some(true))
114            .set_placeholder(Some(plain_text("Select a time")))
115            .set_timezone(Some("Asia/Tokyo"))
116            .build()
117            .unwrap();
118
119        assert_eq!(val, expected);
120
121        let val = TimePicker::builder()
122            .action_id("time_picker_0")
123            .initial_time("10:30")
124            .confirm(confirm())
125            .focus_on_load(true)
126            .placeholder(plain_text("Select a time"))
127            .timezone("Asia/Tokyo")
128            .build()
129            .unwrap();
130
131        assert_eq!(val, expected);
132    }
133
134    #[test]
135    fn it_requires_action_id_less_than_255_characters_long() {
136        let err = TimePicker::builder()
137            .action_id("a".repeat(256))
138            .build()
139            .unwrap_err();
140        assert_eq!(err.object(), "TimePicker");
141
142        let errors = err.field("action_id");
143        assert!(errors.includes(ValidationErrorKind::MaxTextLength(255)));
144    }
145
146    #[test]
147    fn it_requires_initial_time_matches_time_format() {
148        let err = TimePicker::builder()
149            .initial_time("foobar")
150            .build()
151            .unwrap_err();
152        assert_eq!(err.object(), "TimePicker");
153
154        let errors = err.field("initial_time");
155        assert!(errors.includes(ValidationErrorKind::InvalidFormat("24-hour format HH:mm")));
156    }
157
158    #[test]
159    fn it_requires_placeholder_less_than_150_characters_long() {
160        let err = TimePicker::builder()
161            .placeholder(plain_text("a".repeat(151)))
162            .build()
163            .unwrap_err();
164        assert_eq!(err.object(), "TimePicker");
165
166        let errors = err.field("placeholder");
167        assert!(errors.includes(ValidationErrorKind::MaxTextLength(150)));
168    }
169}
slack_messaging/blocks/elements/time_picker.rs

slack_messaging/blocks/elements/
time_picker.rs
