Struct matrix_bot_api::ActiveBot

pub struct ActiveBot { /* fields omitted */ }

Handle for an active bot that allows sending message, leaving rooms and shutting down the bot

Methods

impl ActiveBot

pub fn shutdown(&self)

Will shutdown the bot. The bot will not leave any rooms.

pub fn leave_room(&self, room_id: &str)

Will leave the given room (give room-id, not room-name)

pub fn send_message(&self, msg: &str, room: &str, msgtype: MessageType)

Sends a message to a given room, with a given message-type.

• msg: The incoming message
• room: The room-id that the message should be sent to
• msgtype: Type of message (text or notice)

pub fn send_html_message(
    &self,
    msg: &str,
    html: &str,
    room: &str,
    msgtype: MessageType
)

Sends an HTML message to a given room, with a given message-type.

• msg: The incoming message
• html: The html-formatted message
• room: The room-id that the message should be sent to
• msgtype: Type of message (text or notice)

Trait Implementations

impl Clone for ActiveBot

fn clone(&self) -> ActiveBot

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.