Struct BotBuilder 

pub struct BotBuilder { /* private fields */ }

Available on crate feature websocket only.

Implementations

impl BotBuilder

pub fn new(name: impl Into<String>, port: u16) -> Self

pub fn db_prefix(self, prefix: impl Into<String>) -> Self

Available on crate feature cli only.

Path prefix for the SimpleX database

“{dir}/{prefix}” creates a {dir} with {prefix}_agent.db and {prefix}_chat.db; “{prefix}” creates {prefix}_agent.db and {prefix}_chat.db at the current dir

pub fn db_key(self, key: impl Into<String>) -> Self

Available on crate feature cli only.

Database encryption key.

pub fn connect_retry_delay(self, delay: Duration) -> Self

Delay between connection retry attempt. Default: 1s

pub fn retries(self, n: usize) -> Self

Number of connection retry attempts. Default: 5

pub fn auto_accept(self) -> Self

Create public address and auto accept users

pub fn auto_accept_with(self, welcome_message: impl Into<String>) -> Self

Set a welcome message. This automatically creates a public address with enabled auto_accept

pub fn with_avatar(self, avatar: ImagePreview) -> Self

Set the bot avatar during initialisation

pub fn with_profile(self, profile: Profile) -> Self

Update/create the whole bot profile on launch

pub fn with_preferences(self, prefs: Preferences) -> Self

Apply these preferences to the bot’s profile during initialisation.

pub fn cli_args<I, S>(self, args: I) -> Self

where I: IntoIterator<Item = S>, S: Into<OsString>,

Available on crate feature cli only.

Pass extra arguments to the simplex-chat process.

pub async fn connect(self) -> Result<(Bot, EventStream), BotInitError>

Connect to an already-running simplex-chat instance.

pub async fn launch( self, ) -> Result<(Bot, EventStream, SimplexCli), BotInitError>

Available on crate feature cli only.

Spawn simplex-chat, then connect and initialise.

Returns (bot, events, cli). The caller is responsible for calling cli::SimplexCli::kill after the bot finishes.