Struct urbit_chatbot_framework::Chatbot

pub struct Chatbot { /* fields omitted */ }

This struct represents a chatbot that is connected to a given ship, is watching/posting to a specific chat_ship/chat_name and is using the function respond_to_message to process any messages which are posted in said chat.

Implementations

impl Chatbot

pub fn new(
    respond_to_message: fn(_: AuthoredMessage) -> Option<Message>,
    ship: ShipInterface,
    chat_ship: &str,
    chat_name: &str
) -> Self

Create a new Chatbot with a manually provided ShipInterface

pub fn new_with_local_config(
    respond_to_message: fn(_: AuthoredMessage) -> Option<Message>,
    chat_ship: &str,
    chat_name: &str
) -> Self

Create a new Chatbot with a ShipInterface derived automatically from a local config file. If the config file does not exist, the Chatbot will create the config file, exit, and prompt the user to fill it out.

pub fn run(&self) -> Option<()>

Run the Chatbot