Struct urbit_http_api::apps::chat::Chat

pub struct Chat<'a> {
    pub channel: &'a mut Channel,
}

A struct that provides an interface for interacting with Urbit chats

Fields

channel: &'a mut Channel

Implementations

impl<'a> Chat<'a>

pub fn send_chat_message(
    &mut self,
    chat_ship: &str,
    chat_name: &str,
    message: &Message
) -> Result<String>

Send a message to an Urbit chat. Returns the index of the node that was added to Graph Store.

pub fn export_chat_log(
    &mut self,
    chat_ship: &str,
    chat_name: &str
) -> Result<Vec<String>>

Extracts chat log automatically into a list of formatted Strings

pub fn export_chat_authored_messages(
    &mut self,
    chat_ship: &str,
    chat_name: &str
) -> Result<Vec<AuthoredMessage>>

Extracts a chat’s messages as AuthoredMessages

pub fn subscribe_to_chat(
    &mut self,
    chat_ship: &str,
    chat_name: &str
) -> Result<Receiver<AuthoredMessage>>

Subscribe to and watch for messages. This method returns a Receiver with the AuthoredMessages that are posted after subscribing. Simply call receiver.try_recv() to read the next AuthoredMessage if one has been posted.

Technical Note: This method actually creates a new Channel with your Urbit Ship, and spawns a new unix thread locally that processes all messages on said channel. This is required due to borrowing mechanisms in Rust, however on the plus side this makes it potentially more performant by each subscription having it’s own unix thread.

Trait Implementations

impl<'a> Messaging for Chat<'a>

fn channel(&mut self) -> &mut Channel

Returns the reference to the Channel being used

fn send_message(
    &mut self,
    resource_ship: &str,
    resource_name: &str,
    message: &Message
) -> Result<String>

Send a message to an Urbit chat/DM. Returns the index of the node that was added to Graph Store.

fn export_message_log(
    &mut self,
    resource_ship: &str,
    resource_name: &str
) -> Result<Vec<String>>

Extracts messages automatically into a list of formatted Strings

fn export_authored_messages(
    &mut self,
    resource_ship: &str,
    resource_name: &str
) -> Result<Vec<AuthoredMessage>>

Extracts messages as AuthoredMessages

fn export_message_nodes(
    &mut self,
    resource_ship: &str,
    resource_name: &str
) -> Result<Vec<Node>>

Extracts a message nodes

fn subscribe_to_messages(
    &mut self,
    resource_ship: &str,
    resource_name: &str
) -> Result<Receiver<AuthoredMessage>>

Subscribe to and watch for messages. This method returns a Receiver with the AuthoredMessages that are posted after subscribing. Simply call receiver.try_recv() to read the next AuthoredMessage if one has been posted.