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

use crate::core::subtypes::InteractionType;

/// `UpdateBase` is the foundational struct for managing updates within the system.
///
/// This struct encapsulates essential components such as the chat ID, interaction time,
/// type of interaction, and the update ID.
#[derive(Debug)]
pub struct UpdateBase{
    /// The chat ID associated with the update.
    chat_id: String,
    /// The interaction time of the update.
    interaction_time: i64,
    /// The type of interaction.
    interaction_type: InteractionType,
    /// The update ID.
    update_id: String,
}
impl UpdateBase{
    /// Creates a new `UpdateBase`.
    ///
    /// # Parameters
    ///
    /// * `chat_id` - The chat ID associated with the update.
    /// * `interaction_time` - The interaction time of the update.
    /// * `interaction_type` - The type of interaction.
    /// * `update_id` - The update ID.
    ///
    /// # Returns
    ///
    /// A new instance of `UpdateBase`.
    ///
    /// # Example
    ///
    /// ```
    /// use voiceflousion::core::base_structs::UpdateBase;
    /// use voiceflousion::core::subtypes::InteractionType;
    ///
    /// let index = 0usize;
    /// let interaction_type = InteractionType::new("message".to_string(), Some(index), None);
    /// let update_base = UpdateBase::new("chat_id".to_string(), 1627554661, interaction_type, "update_id".to_string());
    /// ```
    pub fn new(chat_id: String, interaction_time: i64, interaction_type: InteractionType, update_id: String) -> Self {
        Self {
            chat_id,
            interaction_time,
            interaction_type,
            update_id,
        }
    }

    /// Returns the chat ID associated with the update.
    ///
    /// # Returns
    ///
    /// A reference to the chat ID string.
    ///
    /// # Example
    ///
    /// ```
    /// use voiceflousion::core::base_structs::UpdateBase;
    /// use voiceflousion::core::subtypes::InteractionType;
    ///
    /// let index = 0usize;
    /// let interaction_type = InteractionType::new("message".to_string(), Some(index), None);
    /// let update_base = UpdateBase::new("chat_id".to_string(), 1627554661, interaction_type, "update_id".to_string());
    /// let chat_id = update_base.chat_id();
    /// ```
    pub fn chat_id(&self) -> &String {
        &self.chat_id
    }

    /// Returns the update ID.
    ///
    /// # Returns
    ///
    /// A reference to the update ID string.
    ///
    /// # Example
    ///
    /// ```
    /// use voiceflousion::core::base_structs::UpdateBase;
    /// use voiceflousion::core::subtypes::InteractionType;
    ///
    /// let index = 0usize;
    /// let interaction_type = InteractionType::new("message".to_string(), Some(index), None);
    /// let update_base = UpdateBase::new("chat_id".to_string(), 1627554661, interaction_type, "update_id".to_string());
    /// let update_id = update_base.update_id();
    /// ```
    pub fn update_id(&self) -> &String {
        &self.update_id
    }

    /// Returns the interaction time.
    ///
    /// # Returns
    ///
    /// An `i64` representing the interaction time.
    ///
    /// # Example
    ///
    /// ```
    /// use voiceflousion::core::base_structs::UpdateBase;
    /// use voiceflousion::core::subtypes::InteractionType;
    ///
    /// let index = 0usize;
    /// let interaction_type = InteractionType::new("message".to_string(), Some(index), None);
    /// let update_base = UpdateBase::new("chat_id".to_string(), 1627554661, interaction_type, "update_id".to_string());
    /// let interaction_time = update_base.interaction_time();
    /// ```
    pub fn interaction_time(&self) -> i64 {
        self.interaction_time
    }

    /// Returns the type of interaction.
    ///
    /// # Returns
    ///
    /// A reference to the `InteractionType`.
    ///
    /// # Example
    ///
    /// ```
    /// use voiceflousion::core::base_structs::UpdateBase;
    /// use voiceflousion::core::subtypes::InteractionType;
    ///
    /// let index = 0usize;
    /// let interaction_type = InteractionType::new("message".to_string(), Some(index), None);
    /// let update_base = UpdateBase::new("chat_id".to_string(), 1627554661, interaction_type, "update_id".to_string());
    /// let interaction_type = update_base.interaction_type();
    /// ```
    pub fn interaction_type(&self) -> &InteractionType {
        &self.interaction_type
    }
}