sfr-types 0.1.2

The crate has shared types in `slack-framework-rs`.
Documentation 
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

//! The type that represents a composition object.
//!
//! <https://api.slack.com/reference/surfaces/formatting#rich-layouts>

use crate::Block;
use serde::Serialize;

/// The type that represents a composition object.
///
/// <https://api.slack.com/reference/surfaces/formatting#rich-layouts>
#[derive(Serialize, Debug, Clone)]
#[serde(untagged)]
pub enum Layouts {
    /// Defining a single block.
    ///
    /// <https://api.slack.com/reference/surfaces/formatting#define_block>
    SingleBlock(Box<Block>),

    /// Stacking multiple blocks.
    ///
    /// <https://api.slack.com/reference/surfaces/formatting#stack_of_blocks>
    MultipleBlocks(Vec<Block>),

    /// Adding your blocks array.
    ///
    /// <https://api.slack.com/reference/surfaces/formatting#add_blocks_array>
    BlocksArray(MessagePayloads),
}

/// Message payloads.
///
/// <https://api.slack.com/surfaces/messages#payloads>
#[derive(Serialize, Debug, Clone)]
#[serde(rename_all = "snake_case")]
pub struct MessagePayloads {
    /// The usage of this field changes depending on whether you're using `blocks` or not.
    pub text: String,

    /// An array of [layout blocks](https://api.slack.com/reference/block-kit/blocks) in the same format [as described in the building blocks guide](https://api.slack.com/block-kit/building).
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub blocks: Vec<Block>,

    /// An array of [legacy secondary attachments](https://api.slack.com/reference/messaging/attachments).
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub attachments: Vec<String>,

    /// The [ID of another un-threaded message](https://api.slack.com/surfaces/messages#threading) to reply to.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub thread_ts: Option<String>,

    /// Determines whether the text field is rendered according to [`mrkdwn` formatting or not](https://api.slack.com/reference/surfaces/formatting#basics).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub mrkdwn: Option<bool>,
}