Struct slack_blocks::compose::ConversationFilter

pub struct ConversationFilter { /* fields omitted */ }

Filter for Conversations List

slack api docs 🔗

Provides a way to filter the list of options in a conversations select menu 🔗 or conversations multi-select menu 🔗.

Implementations

impl ConversationFilter

pub fn new() -> Self

Create a Conversation Filter object that allows bot users & all kinds of channels; including cross-org shared channels.

Example

use slack_blocks::compose::ConversationFilter;

let filter = ConversationFilter::new();
// TODO: once conversationselect is implemented
// let select = ConversationSelect::from_filter(filter);

pub fn include_conversation_kinds(
    self,
    kinds: impl IntoIterator<Item = ConversationKind>
) -> Self

Chainable setter method that allows you to restrict the kinds of channels that will appear in the conversation select menu.

For excluding cross-org shared channels, see exclude_external_shared_channels.

For excluding DMs with bots, see exclude_bot_users.

Arguments

• kinds - A non-empty unique collection of ConversationKinds, that the select options will be restricted to.

Example

use slack_blocks::compose::ConversationFilter;
use slack_blocks::compose::conversation_filter::ConversationKind;

let filter = ConversationFilter::new()
    .include_conversation_kinds(vec![
        ConversationKind::PublicChannel,
    ]);

// TODO: once conversationselect is implemented
// let select = ConversationSelect::from_filter(filter);

pub fn include_external_shared_channels(self) -> Self

Chainable setter method that allows cross-org shared channels to appear in the conversation select menu.

Note that this setting is the default, and that calling this method is a no-op. It exists purely as declarative sugar for filter construction.

For excluding cross-org shared channels, see exclude_external_shared_channels.

Example

use slack_blocks::compose::ConversationFilter;

let filter = ConversationFilter::new().include_external_shared_channels();

// TODO: once conversationselect is implemented
// let select = ConversationSelect::from_filter(filter);

pub fn exclude_external_shared_channels(self) -> Self

Chainable setter method that prevents cross-workspace shared channels from appearing in the conversation select menu.

Example

use slack_blocks::compose::ConversationFilter;

let filter = ConversationFilter::new().exclude_external_shared_channels();

// TODO: once conversationselect is implemented
// let select = ConversationSelect::from_filter(filter);

pub fn include_bot_users(self) -> Self

Chainable setter method that allows conversations with Bot Users to appear in the conversation select menu.

This is the default behavior.

For excluding bot user DMs, see exclude_bot_users.

Example

use slack_blocks::compose::ConversationFilter;

let filter = ConversationFilter::new().include_bot_users();

// TODO: once conversationselect is implemented
// let select = ConversationSelect::from_filter(filter);

pub fn exclude_bot_users(self) -> Self

Chainable setter method that prevents DMs with Bot users from appearing in the conversation select menu.

Example

use slack_blocks::compose::ConversationFilter;

let filter = ConversationFilter::new().exclude_bot_users();

// TODO: once conversationselect is implemented
// let select = ConversationSelect::from_filter(filter);

pub fn validate(&self) -> Result<(), ValidationErrors>

This is supported on crate feature validation only.

Validate that this Conversation Filter object agrees with Slack’s model requirements.

This type has runtime checks that prevent it from failing validation.

Errors

• Never

Example

use slack_blocks::compose::ConversationFilter;

let filter = ConversationFilter::new().include_conversation_kinds(vec![]);

assert_eq!(false, matches!(filter.validate(), Err(_)));

Trait Implementations

impl Clone for ConversationFilter

fn clone(&self) -> ConversationFilter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConversationFilter

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

Formats the value using the given formatter.

impl Default for ConversationFilter

fn default() -> ConversationFilter

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ConversationFilter

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Hash for ConversationFilter

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<ConversationFilter> for ConversationFilter

fn eq(&self, other: &ConversationFilter) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ConversationFilter) -> bool

This method tests for !=.

impl Serialize for ConversationFilter

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Validate for ConversationFilter

fn validate(&self) -> Result<(), ValidationErrors>

impl StructuralPartialEq for ConversationFilter