Skip to content

matrix_channel

matrix_channel

MatrixChannel — Matrix homeserver adapter.

Classes

MatrixChannel 

MatrixChannel(homeserver: str = '', *, access_token: str = '', bus: Optional[EventBus] = None)

Bases: BaseChannel

Matrix homeserver channel adapter.

PARAMETER DESCRIPTION
homeserver

Matrix homeserver URL. Falls back to MATRIX_HOMESERVER env var.

TYPE: str DEFAULT: ''

access_token

Matrix access token. Falls back to MATRIX_ACCESS_TOKEN env var.

TYPE: str DEFAULT: ''

bus

Optional event bus for publishing channel events.

TYPE: Optional[EventBus] DEFAULT: None

Source code in src/openjarvis/channels/matrix_channel.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
def __init__(
    self,
    homeserver: str = "",
    *,
    access_token: str = "",
    bus: Optional[EventBus] = None,
) -> None:
    self._homeserver = homeserver or os.environ.get("MATRIX_HOMESERVER", "")
    self._access_token = access_token or os.environ.get("MATRIX_ACCESS_TOKEN", "")
    self._bus = bus
    self._handlers: List[ChannelHandler] = []
    self._status = ChannelStatus.DISCONNECTED
    self._txn_id = 0
Functions
connect 
connect() -> None

Mark as connected (send-only — no persistent connection).

Source code in src/openjarvis/channels/matrix_channel.py 
52
53
54
55
56
57
58
def connect(self) -> None:
    """Mark as connected (send-only — no persistent connection)."""
    if not self._homeserver or not self._access_token:
        logger.warning("No Matrix homeserver or access_token configured")
        self._status = ChannelStatus.ERROR
        return
    self._status = ChannelStatus.CONNECTED
disconnect 
disconnect() -> None

Mark as disconnected.

Source code in src/openjarvis/channels/matrix_channel.py 
60
61
62
def disconnect(self) -> None:
    """Mark as disconnected."""
    self._status = ChannelStatus.DISCONNECTED
send 
send(channel: str, content: str, *, conversation_id: str = '', metadata: Dict[str, Any] | None = None) -> bool

Send a message to a Matrix room via the Client-Server API.

Source code in src/openjarvis/channels/matrix_channel.py 
 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
def send(
    self,
    channel: str,
    content: str,
    *,
    conversation_id: str = "",
    metadata: Dict[str, Any] | None = None,
) -> bool:
    """Send a message to a Matrix room via the Client-Server API."""
    if not self._homeserver or not self._access_token:
        logger.warning("Cannot send: no Matrix credentials configured")
        return False

    try:
        import httpx

        self._txn_id += 1
        txn_id = self._txn_id
        url = (
            f"{self._homeserver}/_matrix/client/v3/rooms/"
            f"{channel}/send/m.room.message/{txn_id}"
        )
        headers = {
            "Authorization": f"Bearer {self._access_token}",
        }
        payload: Dict[str, Any] = {
            "msgtype": "m.text",
            "body": content,
        }

        resp = httpx.put(
            url, json=payload, headers=headers, timeout=10.0,
        )
        if resp.status_code < 300:
            self._publish_sent(channel, content, conversation_id)
            return True
        logger.warning(
            "Matrix API returned status %d", resp.status_code,
        )
        return False
    except Exception:
        logger.debug("Matrix send failed", exc_info=True)
        return False
status 
status() -> ChannelStatus

Return the current connection status.

Source code in src/openjarvis/channels/matrix_channel.py 
110
111
112
def status(self) -> ChannelStatus:
    """Return the current connection status."""
    return self._status
list_channels 
list_channels() -> List[str]

Return available channel identifiers.

Source code in src/openjarvis/channels/matrix_channel.py 
114
115
116
def list_channels(self) -> List[str]:
    """Return available channel identifiers."""
    return ["matrix"]
on_message 
on_message(handler: ChannelHandler) -> None

Register a callback for incoming messages.

Source code in src/openjarvis/channels/matrix_channel.py 
118
119
120
def on_message(self, handler: ChannelHandler) -> None:
    """Register a callback for incoming messages."""
    self._handlers.append(handler)