Skip to content

Index

channels

Channel abstraction for multi-platform messaging.

Classes

BaseChannel

Bases: ABC

Base class for all channel implementations.

Subclasses must be registered via @ChannelRegistry.register("name") to become discoverable.

Functions
connect abstractmethod 
connect() -> None

Establish connection to the channel gateway.

Source code in src/openjarvis/channels/_stubs.py 
46
47
48
@abstractmethod
def connect(self) -> None:
    """Establish connection to the channel gateway."""
disconnect abstractmethod 
disconnect() -> None

Close connection to the channel gateway.

Source code in src/openjarvis/channels/_stubs.py 
50
51
52
@abstractmethod
def disconnect(self) -> None:
    """Close connection to the channel gateway."""
send abstractmethod 
send(channel: str, content: str, *, conversation_id: str = '', metadata: Dict[str, Any] | None = None) -> bool

Send a message to a specific channel. Returns True on success.

Canonical send contract shared by every channel adapter:

channel The DESTINATION identifier — the per-adapter native id of the place the message goes (Discord/Slack channel id, Telegram chat id, email recipient address, ...). This is not the channel TYPE label. An incoming :class:ChannelMessage carries that destination in its conversation_id field (channel there is only the type label such as "discord"), so dispatch code replying to a message must pass cm.conversation_id here. conversation_id An optional reply/thread reference — the native id of the message being replied to (Discord message_reference, Slack thread_ts, Telegram reply_to_message_id, email In-Reply-To, ...). When replying to an inbound message this should be cm.message_id, never the channel id. Passing a channel id here yields broken references (e.g. Discord MESSAGE_REFERENCE_UNKNOWN_MESSAGE).

Source code in src/openjarvis/channels/_stubs.py 
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
@abstractmethod
def send(
    self,
    channel: str,
    content: str,
    *,
    conversation_id: str = "",
    metadata: Dict[str, Any] | None = None,
) -> bool:
    """Send a message to a specific channel. Returns True on success.

    Canonical send contract shared by **every** channel adapter:

    ``channel``
        The DESTINATION identifier — the per-adapter native id of the
        place the message goes (Discord/Slack channel id, Telegram chat
        id, email recipient address, ...).  This is *not* the channel
        TYPE label.  An incoming :class:`ChannelMessage` carries that
        destination in its ``conversation_id`` field (``channel`` there
        is only the type label such as ``"discord"``), so dispatch code
        replying to a message must pass ``cm.conversation_id`` here.
    ``conversation_id``
        An optional reply/thread reference — the native id of the
        message being replied to (Discord ``message_reference``, Slack
        ``thread_ts``, Telegram ``reply_to_message_id``, email
        ``In-Reply-To``, ...).  When replying to an inbound message this
        should be ``cm.message_id``, never the channel id.  Passing a
        channel id here yields broken references (e.g. Discord
        ``MESSAGE_REFERENCE_UNKNOWN_MESSAGE``).
    """
status abstractmethod 
status() -> ChannelStatus

Return the current connection status.

Source code in src/openjarvis/channels/_stubs.py 
85
86
87
@abstractmethod
def status(self) -> ChannelStatus:
    """Return the current connection status."""
list_channels abstractmethod 
list_channels() -> List[str]

Return list of available channel names.

Source code in src/openjarvis/channels/_stubs.py 
89
90
91
@abstractmethod
def list_channels(self) -> List[str]:
    """Return list of available channel names."""
on_message abstractmethod 
on_message(handler: ChannelHandler) -> None

Register a callback for incoming messages.

Source code in src/openjarvis/channels/_stubs.py 
93
94
95
@abstractmethod
def on_message(self, handler: ChannelHandler) -> None:
    """Register a callback for incoming messages."""

ChannelMessage dataclass 

ChannelMessage(channel: str, sender: str, content: str, message_id: str = '', conversation_id: str = '', session_id: str = '', metadata: Dict[str, Any] = dict())

A message received from or sent to a channel.

ChannelStatus

Bases: str, Enum

Channel connection status.