1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
use serde::Serialize;
/// Type of conversation to set into [Filter object](https://api.slack.com/reference/block-kit/composition-objects#filter_conversations)
#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum Conversation {
Im,
Mpim,
Private,
Public,
}
/// [Filter object](https://api.slack.com/reference/block-kit/composition-objects#filter_conversations)
/// representation.
///
/// # Example
///
/// ```
/// use slack_messaging::blocks::elements::{Filter, Conversation};
/// use serde_json::json;
///
/// let filter = Filter::new()
/// .include(Conversation::Public)
/// .include(Conversation::Mpim)
/// .exclude_bot_users();
///
/// let expected = json!({
/// "include": [
/// "public",
/// "mpim"
/// ],
/// "exclude_bot_users": true
/// });
///
/// let filter_json = serde_json::to_value(filter).unwrap();
///
/// assert_eq!(filter_json, expected);
/// ```
#[derive(Debug, Default, Clone, Serialize)]
pub struct Filter {
#[serde(skip_serializing_if = "Vec::is_empty")]
include: Vec<Conversation>,
#[serde(skip_serializing_if = "Option::is_none")]
exclude_external_shared_channels: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
exclude_bot_users: Option<bool>,
}
impl Filter {
/// Constructs a Filter object.
///
/// ```
/// use slack_messaging::blocks::elements::Filter;
/// use serde_json::json;
///
/// let filter = Filter::new();
///
/// let expected = json!({});
///
/// let filter_json = serde_json::to_value(filter).unwrap();
///
/// assert_eq!(filter_json, expected);
/// ```
pub fn new() -> Self {
Self::default()
}
/// Sets include field directly.
///
/// ```
/// use slack_messaging::blocks::elements::{Filter, Conversation};
/// use serde_json::json;
///
/// let filter = Filter::new()
/// .set_include(
/// vec![
/// Conversation::Im,
/// Conversation::Private,
/// ]
/// );
///
/// let expected = json!({
/// "include": [
/// "im",
/// "private"
/// ]
/// });
///
/// let filter_json = serde_json::to_value(filter).unwrap();
///
/// assert_eq!(filter_json, expected);
/// ```
pub fn set_include(self, include: Vec<Conversation>) -> Self {
Self { include, ..self }
}
/// Adds conversation to include field.
///
/// ```
/// use slack_messaging::blocks::elements::{Filter, Conversation};
/// use serde_json::json;
///
/// let filter = Filter::new()
/// .push_include(Conversation::Mpim);
///
/// let expected = json!({
/// "include": [
/// "mpim"
/// ]
/// });
///
/// let filter_json = serde_json::to_value(filter).unwrap();
///
/// assert_eq!(filter_json, expected);
/// ```
pub fn push_include(self, conversation: Conversation) -> Self {
let Self { mut include, .. } = self;
include.push(conversation);
Self { include, ..self }
}
/// Alias for `push_include` method
pub fn include(self, conversation: Conversation) -> Self {
self.push_include(conversation)
}
/// Sets exclude_external_shared_channels field.
///
/// ```
/// use slack_messaging::blocks::elements::{Filter, Conversation};
/// use serde_json::json;
///
/// let filter = Filter::new()
/// .set_exclude_external_shared_channels(true);
///
/// let expected = json!({
/// "exclude_external_shared_channels": true
/// });
///
/// let filter_json = serde_json::to_value(filter).unwrap();
///
/// assert_eq!(filter_json, expected);
/// ```
pub fn set_exclude_external_shared_channels(self, value: bool) -> Self {
Self {
exclude_external_shared_channels: Some(value),
..self
}
}
/// Sets true to exclude_external_shared_channels field.
///
/// ```
/// use slack_messaging::blocks::elements::{Filter, Conversation};
/// use serde_json::json;
///
/// let filter = Filter::new()
/// .exclude_external_shared_channels();
///
/// let expected = json!({
/// "exclude_external_shared_channels": true
/// });
///
/// let filter_json = serde_json::to_value(filter).unwrap();
///
/// assert_eq!(filter_json, expected);
/// ```
pub fn exclude_external_shared_channels(self) -> Self {
self.set_exclude_external_shared_channels(true)
}
/// Sets exclude_bot_users field.
///
/// ```
/// use slack_messaging::blocks::elements::{Filter, Conversation};
/// use serde_json::json;
///
/// let filter = Filter::new()
/// .set_exclude_bot_users(true);
///
/// let expected = json!({
/// "exclude_bot_users": true
/// });
///
/// let filter_json = serde_json::to_value(filter).unwrap();
///
/// assert_eq!(filter_json, expected);
/// ```
pub fn set_exclude_bot_users(self, value: bool) -> Self {
Self {
exclude_bot_users: Some(value),
..self
}
}
/// Sets true to exclude_bot_users field.
///
/// ```
/// use slack_messaging::blocks::elements::{Filter, Conversation};
/// use serde_json::json;
///
/// let filter = Filter::new()
/// .exclude_bot_users();
///
/// let expected = json!({
/// "exclude_bot_users": true
/// });
///
/// let filter_json = serde_json::to_value(filter).unwrap();
///
/// assert_eq!(filter_json, expected);
/// ```
pub fn exclude_bot_users(self) -> Self {
self.set_exclude_bot_users(true)
}
}