Struct Sender 

pub struct Sender { /* private fields */ }

Thread-safe API for sending messages asynchronously

Implementations

impl Sender

pub fn get_msg_uid(&self) -> usize

Get the next message id

A value returned from this method must be included in the JSON payload (the id field) when constructing your own message.

pub fn send(&self, raw: &str) -> Result<(), Error>

Send a raw message

Must set message.id using result of get_msg_id().

Success from this API does not guarantee the message is delivered successfully since that runs on a separate task.

pub fn send_message(&self, channel_id: &str, msg: &str) -> Result<usize, Error>

Send a message to the specified channel id

Success from this API does not guarantee the message is delivered successfully since that runs on a separate task.

channel_id is the slack channel id, e.g. UXYZ1234, not #general.

Only valid after RtmClient::run.

Examples found in repository

examples/slack_example.rs (line 51)

    fn on_event(&mut self, cli: &RtmClient, event: Event) {
        println!("on_event(event: {:?})", event);
        if let Event::Hello = event {
            // find the general channel id from the `StartResponse`
            let general_channel_id = cli
                .start_response()
                .channels
                .as_ref()
                .and_then(|channels| {
                    channels.iter().find(|chan| match chan.name {
                        None => false,
                        Some(ref name) => name == "general",
                    })
                })
                .and_then(|chan| chan.id.as_ref())
                .expect("general channel not found");
            let _ = cli
                .sender()
                .send_message(&general_channel_id, "Hello world! (rtm)");
            // Send a message over the real time api websocket
        }
    }

pub fn send_typing(&self, channel_id: &str) -> Result<usize, Error>

Marks connected client as being typing to a channel This is mostly used to signal to other peers that a message is being typed. Will have the server send a “user_typing” message to all the peers. Slack doc can be found at https://api.slack.com/rtm under “Typing Indicators”

channel_id is the slack channel id, e.g. UXYZ1234, not #general.

pub fn subscribe_presence(&self, user_list: &[&str]) -> Result<usize, Error>

Subscribes to presence updates for the given users This is due to the update in presence events detailed here: https://api.slack.com/changelog/2017-10-making-rtm-presence-subscription-only

user_list is a slice of the list of users to subscrib, e.g. W839208, not @xyz. The full list of users to subscribe to must be sent each time the subscription should change Slack doc can be found at https://api.slack.com/docs/presence-and-status under “Determining user presence”

pub fn shutdown(&self) -> Result<(), Error>

Shutdown RtmClient

Trait Implementations

impl Clone for Sender

fn clone(&self) -> Sender

Returns a duplicate of the value.

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

Performs copy-assignment from source.