pub struct SlackChannel { /* private fields */ }Expand description
Slack channel.
Implementations§
Source§impl SlackChannel
impl SlackChannel
pub fn new(config: SlackConfig, http_client: Box<dyn SlackHttpClient>) -> Self
pub fn with_name(self, name: impl Into<String>) -> Self
Sourcepub async fn list_channels(&self) -> Result<Vec<SlackChannelInfo>, RustantError>
pub async fn list_channels(&self) -> Result<Vec<SlackChannelInfo>, RustantError>
List public and private channels visible to the bot.
Sourcepub async fn channel_info(
&self,
channel_id: &str,
) -> Result<SlackChannelInfo, RustantError>
pub async fn channel_info( &self, channel_id: &str, ) -> Result<SlackChannelInfo, RustantError>
Get info about a specific channel by ID.
Sourcepub async fn join_channel(&self, channel_id: &str) -> Result<(), RustantError>
pub async fn join_channel(&self, channel_id: &str) -> Result<(), RustantError>
Join a channel by ID.
Sourcepub async fn list_users(&self) -> Result<Vec<SlackUserInfo>, RustantError>
pub async fn list_users(&self) -> Result<Vec<SlackUserInfo>, RustantError>
List workspace users.
Sourcepub async fn get_user_info(
&self,
user_id: &str,
) -> Result<SlackUserInfo, RustantError>
pub async fn get_user_info( &self, user_id: &str, ) -> Result<SlackUserInfo, RustantError>
Look up a user by ID.
Sourcepub async fn add_reaction(
&self,
channel: &str,
timestamp: &str,
emoji: &str,
) -> Result<(), RustantError>
pub async fn add_reaction( &self, channel: &str, timestamp: &str, emoji: &str, ) -> Result<(), RustantError>
Add a reaction to a message.
Sourcepub async fn get_reactions(
&self,
channel: &str,
timestamp: &str,
) -> Result<Vec<SlackReaction>, RustantError>
pub async fn get_reactions( &self, channel: &str, timestamp: &str, ) -> Result<Vec<SlackReaction>, RustantError>
Get reactions on a message.
Sourcepub async fn list_files(
&self,
channel: Option<&str>,
) -> Result<Vec<SlackFile>, RustantError>
pub async fn list_files( &self, channel: Option<&str>, ) -> Result<Vec<SlackFile>, RustantError>
List files, optionally filtered by channel.
Sourcepub async fn get_team_info(&self) -> Result<SlackTeamInfo, RustantError>
pub async fn get_team_info(&self) -> Result<SlackTeamInfo, RustantError>
Get workspace/team info.
Sourcepub async fn list_usergroups(&self) -> Result<Vec<SlackUserGroup>, RustantError>
pub async fn list_usergroups(&self) -> Result<Vec<SlackUserGroup>, RustantError>
List user groups.
Sourcepub async fn open_dm(&self, user_ids: &[&str]) -> Result<String, RustantError>
pub async fn open_dm(&self, user_ids: &[&str]) -> Result<String, RustantError>
Open a DM conversation with one or more users. Returns the channel ID.
Sourcepub async fn reply_in_thread(
&self,
channel: &str,
thread_ts: &str,
text: &str,
) -> Result<MessageId, RustantError>
pub async fn reply_in_thread( &self, channel: &str, thread_ts: &str, text: &str, ) -> Result<MessageId, RustantError>
Send a threaded reply to a message.
Sourcepub async fn read_history(
&self,
channel: &str,
limit: usize,
) -> Result<Vec<SlackMessage>, RustantError>
pub async fn read_history( &self, channel: &str, limit: usize, ) -> Result<Vec<SlackMessage>, RustantError>
Read recent messages from a channel. Wraps conversations_history.
Trait Implementations§
Source§impl Channel for SlackChannel
impl Channel for SlackChannel
Source§fn channel_type(&self) -> ChannelType
fn channel_type(&self) -> ChannelType
Source§fn connect<'life0, 'async_trait>(
&'life0 mut self,
) -> Pin<Box<dyn Future<Output = Result<(), RustantError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn connect<'life0, 'async_trait>(
&'life0 mut self,
) -> Pin<Box<dyn Future<Output = Result<(), RustantError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Source§fn disconnect<'life0, 'async_trait>(
&'life0 mut self,
) -> Pin<Box<dyn Future<Output = Result<(), RustantError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn disconnect<'life0, 'async_trait>(
&'life0 mut self,
) -> Pin<Box<dyn Future<Output = Result<(), RustantError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Source§fn send_message<'life0, 'async_trait>(
&'life0 self,
msg: ChannelMessage,
) -> Pin<Box<dyn Future<Output = Result<MessageId, RustantError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn send_message<'life0, 'async_trait>(
&'life0 self,
msg: ChannelMessage,
) -> Pin<Box<dyn Future<Output = Result<MessageId, RustantError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Source§fn receive_messages<'life0, 'async_trait>(
&'life0 self,
) -> Pin<Box<dyn Future<Output = Result<Vec<ChannelMessage>, RustantError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn receive_messages<'life0, 'async_trait>(
&'life0 self,
) -> Pin<Box<dyn Future<Output = Result<Vec<ChannelMessage>, RustantError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Source§fn status(&self) -> ChannelStatus
fn status(&self) -> ChannelStatus
Source§fn capabilities(&self) -> ChannelCapabilities
fn capabilities(&self) -> ChannelCapabilities
Source§fn streaming_mode(&self) -> StreamingMode
fn streaming_mode(&self) -> StreamingMode
Source§fn is_connected(&self) -> bool
fn is_connected(&self) -> bool
Source§fn receive_messages_since<'life0, 'life1, 'async_trait>(
&'life0 self,
_cursor: Option<&'life1 str>,
) -> Pin<Box<dyn Future<Output = Result<(Vec<ChannelMessage>, Option<String>), RustantError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn receive_messages_since<'life0, 'life1, 'async_trait>(
&'life0 self,
_cursor: Option<&'life1 str>,
) -> Pin<Box<dyn Future<Output = Result<(Vec<ChannelMessage>, Option<String>), RustantError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Auto Trait Implementations§
impl Freeze for SlackChannel
impl !RefUnwindSafe for SlackChannel
impl Send for SlackChannel
impl Sync for SlackChannel
impl Unpin for SlackChannel
impl UnsafeUnpin for SlackChannel
impl !UnwindSafe for SlackChannel
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);