Struct SlackClient 

pub struct SlackClient { /* private fields */ }

Slack Web API client. A clone shares one connection pool.

Get it from a handler with crate::SlackContext::client, or from the app state with SlackClient::from_state.

Implementations

impl SlackClient

pub fn from_state(state: &AppState) -> Option<Self>

Returns the client that the plugin put in the app state at startup.

pub fn has_token(&self) -> bool

Returns true when a bot token is set.

pub async fn call( &self, method: &str, params: &Value, ) -> Result<Value, SlackError>

Calls a write method. It retries only on 429.

params is a JSON object. The client sends strings unchanged and other values as JSON text. It does not send null values.

Errors

Returns SlackError::Api for ok: false, or a transport, HTTP, rate-limit, decode, or config error.

pub async fn call_read( &self, method: &str, params: &Value, ) -> Result<Value, SlackError>

Calls a read method. It also retries on 5xx and network errors.

Errors

Same as Self::call.

pub async fn chat_post_message( &self, channel: &str, msg: &Message, ) -> Result<MessageRef, SlackError>

chat.postMessage.

Errors

Same as Self::call.

pub async fn chat_post_ephemeral( &self, channel: &str, user: &str, msg: &Message, ) -> Result<String, SlackError>

chat.postEphemeral. Returns the message_ts.

Errors

Same as Self::call.

pub async fn chat_update( &self, channel: &str, ts: &str, msg: &Message, ) -> Result<MessageRef, SlackError>

chat.update.

Errors

Same as Self::call.

pub async fn chat_delete( &self, channel: &str, ts: &str, ) -> Result<(), SlackError>

chat.delete.

Errors

Same as Self::call.

pub async fn reactions_add( &self, channel: &str, ts: &str, name: &str, ) -> Result<(), SlackError>

reactions.add. name has no colons, for example thumbsup.

Errors

Same as Self::call.

pub async fn views_open( &self, trigger_id: &str, view: &Value, ) -> Result<Value, SlackError>

views.open. Returns the view.

Errors

Same as Self::call.

pub async fn views_update( &self, view_id: &str, view: &Value, hash: Option<&str>, ) -> Result<Value, SlackError>

views.update. hash stops an update that would overwrite a newer view. Returns the view.

Errors

Same as Self::call.

pub async fn views_push( &self, trigger_id: &str, view: &Value, ) -> Result<Value, SlackError>

views.push. Returns the view.

Errors

Same as Self::call.

pub async fn views_publish( &self, user_id: &str, view: &Value, ) -> Result<Value, SlackError>

views.publish for the Home tab. Returns the view.

Errors

Same as Self::call.

pub async fn users_info(&self, user: &str) -> Result<Value, SlackError>

users.info. Returns the user.

Errors

Same as Self::call.

pub async fn auth_test(&self) -> Result<AuthTest, SlackError>

auth.test.

Errors

Same as Self::call.

pub async fn paginate( &self, method: &str, params: &Value, key: &str, max_pages: usize, ) -> Result<Vec<Value>, SlackError>

Calls a read method once per page and joins the key arrays. It follows response_metadata.next_cursor for at most max_pages.

Errors

Same as Self::call.

pub async fn respond( &self, response_url: &str, msg: &Message, ) -> Result<(), SlackError>

Posts msg as JSON to a response_url. It sends no token.

Errors

Returns SlackError::BadResponseUrl for a URL that is not HTTPS on an allowed host. Returns an HTTP or transport error.

Trait Implementations

impl Clone for SlackClient

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SlackClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.