Skip to content

rocketchat_channel

diapason.channels.rocketchat_channel

RocketChatChannel — Rocket.Chat adapter via rocketchat_API.

RocketChatChannel

Bases: BaseChannel

Rocket.Chat messaging channel adapter.

Uses the Rocket.Chat REST API via rocketchat_API.

Parameters

url: Rocket.Chat server URL. Falls back to ROCKETCHAT_URL env var. user: Rocket.Chat username. Falls back to ROCKETCHAT_USER env var. password: Rocket.Chat password. Falls back to ROCKETCHAT_PASSWORD env var. auth_token: Rocket.Chat auth token (alternative to password). Falls back to ROCKETCHAT_AUTH_TOKEN env var. user_id: Rocket.Chat user ID (used with auth_token). Falls back to ROCKETCHAT_USER_ID env var. bus: Optional event bus for publishing channel events.

connect()

Validate credentials and mark as connected.

disconnect()

Mark as disconnected.

list_channels()

Return available channel identifiers.

on_message(handler)

Register a callback for incoming messages.

send(channel, content, *, conversation_id='', metadata=None)

Send a message to a Rocket.Chat channel or DM.

Parameters

channel: Rocket.Chat channel name or room ID. content: Text message content.

status()

Return the current connection status.