brainwires-channels 0.7.0

Universal messaging channel contract for the Brainwires Agent Framework
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

//! The `Channel` trait that all messaging channel adapters must implement.

use anyhow::Result;
use async_trait::async_trait;

use crate::capabilities::ChannelCapabilities;
use crate::identity::ConversationId;
use crate::message::{ChannelMessage, MessageId};

/// The universal contract for a messaging channel adapter.
///
/// Every channel implementation (Discord, Telegram, Slack, etc.) must implement
/// this trait to integrate with the Brainwires gateway.
#[async_trait]
pub trait Channel: Send + Sync {
    /// Unique channel type identifier (e.g., "discord", "telegram").
    fn channel_type(&self) -> &str;

    /// What this channel supports.
    fn capabilities(&self) -> ChannelCapabilities;

    /// Send a message to a conversation.
    async fn send_message(
        &self,
        target: &ConversationId,
        message: &ChannelMessage,
    ) -> Result<MessageId>;

    /// Edit a previously sent message.
    async fn edit_message(&self, id: &MessageId, message: &ChannelMessage) -> Result<()>;

    /// Delete a message.
    async fn delete_message(&self, id: &MessageId) -> Result<()>;

    /// Send a typing indicator to a conversation.
    async fn send_typing(&self, target: &ConversationId) -> Result<()>;

    /// React to a message with an emoji.
    async fn add_reaction(&self, id: &MessageId, emoji: &str) -> Result<()>;

    /// Get conversation history, returning up to `limit` messages.
    async fn get_history(
        &self,
        target: &ConversationId,
        limit: usize,
    ) -> Result<Vec<ChannelMessage>>;
}