voiceflousion 0.3.1

A crate that provides toolkit for Voiceflow AI bots integrations and pre-built functionality for quick integration with popular messengers
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
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

use crate::core::voiceflow::VoiceflowBlock;

/// `ResponderBase` is the foundational struct for managing responses within the system.
///
/// This struct encapsulates essential components such as the chat ID, message ID, date of the message,
/// and the content of the message.
#[derive(Debug)]
pub struct ResponderBase {
    /// The chat ID where the message was sent.
    chat_id: String,
    /// The ID of the message.
    message_id: String,
    /// The date when the message was sent, represented as a Unix timestamp.
    date: i64,
    /// The content of the message.
    message_content: VoiceflowBlock,
}

impl ResponderBase {
    /// Creates a new `ResponderBase`.
    ///
    /// # Parameters
    ///
    /// * `chat_id` - The chat ID where the message was sent.
    /// * `message_id` - The ID of the message.
    /// * `message_content` - The content of the message as a `VoiceflowBlock`.
    /// * `date` - The date when the message was sent, represented as a Unix timestamp.
    ///
    /// # Returns
    ///
    /// A new instance of `ResponderBase`.
    ///
    /// # Example
    ///
    /// ```
    /// use voiceflousion::core::base_structs::ResponderBase;
    /// use voiceflousion::core::voiceflow::dialog_blocks::VoiceflowText;
    /// use voiceflousion::core::voiceflow::VoiceflowBlock;
    ///
    /// let block = VoiceflowBlock::Text(VoiceflowText::new("text".to_string()));
    /// let responder_base = ResponderBase::new("chat_id".to_string(), "message_id".to_string(), block, 1627554661);
    /// ```
    pub fn new(chat_id: String, message_id: String, message_content: VoiceflowBlock, date: i64) -> Self {
        Self {
            chat_id,
            message_id,
            date,
            message_content,
        }
    }

    /// Returns a reference to the message ID.
    ///
    /// # Returns
    ///
    /// A reference to the message ID string.
    ///
    /// # Example
    ///
    /// ```
    /// use voiceflousion::core::base_structs::ResponderBase;
    /// use voiceflousion::core::voiceflow::dialog_blocks::VoiceflowText;
    /// use voiceflousion::core::voiceflow::VoiceflowBlock;
    ///
    /// let block = VoiceflowBlock::Text(VoiceflowText::new("text".to_string()));
    /// let responder_base = ResponderBase::new("chat_id".to_string(), "message_id".to_string(), block, 1627554661);
    /// let message_id = responder_base.message_id();
    /// ```
    pub fn message_id(&self) -> &String {
        &self.message_id
    }

    /// Returns a reference to the content of the message.
    ///
    /// # Returns
    ///
    /// A reference to the `VoiceflowBlock` representing the message content.
    ///
    /// # Example
    ///
    /// ```
    /// use voiceflousion::core::base_structs::ResponderBase;
    /// use voiceflousion::core::voiceflow::dialog_blocks::VoiceflowText;
    /// use voiceflousion::core::voiceflow::VoiceflowBlock;
    ///
    /// let block = VoiceflowBlock::Text(VoiceflowText::new("text".to_string()));
    /// let responder_base = ResponderBase::new("chat_id".to_string(), "message_id".to_string(), block, 1627554661);
    /// let content = responder_base.message_content();
    /// ```
    pub fn message_content(&self) -> &VoiceflowBlock {
        &self.message_content
    }

    /// Returns a reference to the chat ID.
    ///
    /// # Returns
    ///
    /// A reference to the chat ID string.
    ///
    /// # Example
    ///
    /// ```
    /// use voiceflousion::core::base_structs::ResponderBase;
    /// use voiceflousion::core::voiceflow::dialog_blocks::VoiceflowText;
    /// use voiceflousion::core::voiceflow::VoiceflowBlock;
    ///
    /// let block = VoiceflowBlock::Text(VoiceflowText::new("text".to_string()));
    /// let responder_base = ResponderBase::new("chat_id".to_string(), "message_id".to_string(), block, 1627554661);
    /// let chat_id = responder_base.chat_id();
    /// ```
    pub fn chat_id(&self) -> &String {
        &self.chat_id
    }

    /// Returns the date of the message.
    ///
    /// # Returns
    ///
    /// The date of the message as an `i64` Unix timestamp.
    ///
    /// # Example
    ///
    /// ```
    /// use voiceflousion::core::base_structs::ResponderBase;
    /// use voiceflousion::core::voiceflow::dialog_blocks::VoiceflowText;
    /// use voiceflousion::core::voiceflow::VoiceflowBlock;
    ///
    /// let block = VoiceflowBlock::Text(VoiceflowText::new("text".to_string()));
    /// let responder_base = ResponderBase::new("chat_id".to_string(), "message_id".to_string(), block, 1627554661);
    /// let date = responder_base.date();
    /// ```
    pub fn date(&self) -> i64 {
        self.date
    }
}