Struct slack_blocks::block_elements::select::Conversation [−][src]
pub struct Conversation<'a> { /* fields omitted */ }
Expand description
Select menu with conversations list
This select menu will populate its options with a list of public and private channels, DMs, and MPIMs visible to the current user in the active workspace.
Implementations
impl<'a> Conversation<'a>
[src]
impl<'a> Conversation<'a>
[src]pub fn from_placeholder_and_action_id(
placeholder: impl Into<Plain>,
action_id: impl Into<Cow<'a, str>>
) -> Self
[src]
pub fn from_placeholder_and_action_id(
placeholder: impl Into<Plain>,
action_id: impl Into<Cow<'a, str>>
) -> Self
[src]Construct a Select element, letting users choose a DM / Group DM / Public channel from their workspace.
Arguments
-
placeholder
- Aplain_text
only text object 🔗 that defines the placeholder text shown on the menu. Maximum length for thetext
in this field is 150 characters. -
action_id
- An identifier for the action triggered when a menu option is selected. You can use this when you receive an interaction payload to identify the source of the action 🔗. Should be unique among all otheraction_id
s used elsewhere by your app. Maximum length for this field is 255 characters.
Example
use std::convert::TryFrom; use std::iter; use slack_blocks::block_elements::{BlockElement, select}; use slack_blocks::blocks; use slack_blocks::text; use text::ToSlackPlaintext; let select: BlockElement = select::Conversation ::from_placeholder_and_action_id("Channel", "ABC123") .into(); let title = "Pick a channel to send your poll to...".plaintext(); let blocks: Vec<blocks::Block> = vec![ blocks::Section::from_text(title).into(), blocks::Actions::try_from(vec![select]).unwrap().into(), ]; // <send `blocks` to slack's API>
pub fn with_confirm(self, confirm: Confirm) -> Self
[src]
pub fn with_confirm(self, confirm: Confirm) -> Self
[src]Optional method that allows you to add a confirmation dialog that appears after a menu item is selected.
Arguments
confirm
- A confirm object 🔗 that defines an optional confirmation dialog that appears after a menu item is selected.
Example
use std::iter; use std::convert::TryFrom; use slack_blocks::{ blocks::{Block, Actions}, block_elements::{BlockElement, select::Select}, compose::{text, Confirm, text::ToSlackPlaintext}, }; let confirm = Confirm::from_parts( "Are you sure?", "Think hard about this.".plaintext(), "Yes", "No", ); let select: BlockElement = Select::from_placeholder_and_action_id("Pick a channel to delete!", "delete_chan_select") .with_confirm(confirm) .choose_from_all_channels() .into(); let block: Block = Actions::try_from(select).unwrap().into(); // < send `block` to slack API >
pub fn with_filter(self, filter: ConversationFilter) -> Self
[src]
pub fn with_filter(self, filter: ConversationFilter) -> Self
[src]Optional method that allows you to filter the conversations
available in the menu using ConversationFilter
.
Arguments
filter
- A filter object 🔗 that defines an optional confirmation dialog that appears after a menu item is selected.
Example
use std::iter; use std::convert::TryFrom; use slack_blocks::{ blocks::{Block, Actions}, block_elements::{BlockElement, select::Select}, compose::{ text, Confirm, ConversationFilter, conversation_filter::ConversationKind::*, text::ToSlackPlaintext, }, }; let filter = ConversationFilter::new().include_conversation_kinds(vec![Dm, PrivateChannel]); let select: BlockElement = Select::from_placeholder_and_action_id("Pick a channel to delete!", "delete_chan_select") .choose_from_all_channels() .with_filter(filter) .into(); let block: Block = Actions::try_from(select).unwrap().into(); // < send `block` to slack API >
pub fn with_initial_channel(self, channel_id: impl Into<Cow<'a, str>>) -> Self
[src]
pub fn with_initial_channel(self, channel_id: impl Into<Cow<'a, str>>) -> Self
[src]Optional method that allows you to set a pre-selected channel in the select menu with the channel’s ID.
If default_to_current_conversation
is also supplied, initial_conversation
will take precedence.
Arguments
channel
- The ID of any valid public channel to be pre-selected when the menu loads.
Example
use std::convert::TryFrom; use slack_blocks::{ blocks::{Block, Actions, Section}, block_elements::{BlockElement, select::Select}, compose::{text, Confirm, text::ToSlackPlaintext}, }; let confirm = Confirm::from_parts( "Confirm Poll Channel", "Are you sure this is the channel you want to send this to?".plaintext(), "Yep, I'm sure", "No way!" ); let general = "C12345"; let select: BlockElement = Select::from_placeholder_and_action_id( "Pick a Channel...", "ABC123" ) .with_confirm(confirm) .choose_from_all_channels() .with_initial_channel(general) .into(); let blocks: Vec<Block> = vec![ Section::from_text("Pick a channel to send your poll to...".plaintext()).into(), Actions::try_from(select).unwrap().into(), ]; // <send to slack's API>
pub fn default_to_current_conversation(self) -> Self
[src]
pub fn default_to_current_conversation(self) -> Self
[src]Pre-populates the select menu with the conversation that the user was viewing when they opened the modal, if available.
Default is false.
pub fn no_default(self) -> Self
[src]
pub fn no_default(self) -> Self
[src]Undo default_to_current_conversation
pub fn validate(&self) -> Result<(), ValidationErrors>
[src]
pub fn validate(&self) -> Result<(), ValidationErrors>
[src]Validate that this Public Channel Select element agrees with Slack’s model requirements
Errors
- If
from_placeholder_and_action_id
was called withplaceholder
longer than 150 chars - If
from_placeholder_and_action_id
was called withaction_id
longer than 255 chars - If
with_confirm
was called with an invalidConfirm
structure
Example
use slack_blocks::block_elements::select; let select = select::Conversation::from_placeholder_and_action_id( r#"Hey I really would appreciate it if you chose a channel relatively soon, so that we can figure out where we need to send this poll, ok? it's kind of important that you specify where this poll should be sent, in case we haven't made that super clear. If you understand, could you pick a channel, already??"#, "ABC123" ); assert!(matches!(select.validate(), Err(_)))
Trait Implementations
impl<'a> Clone for Conversation<'a>
[src]
impl<'a> Clone for Conversation<'a>
[src]fn clone(&self) -> Conversation<'a>
[src]
fn clone(&self) -> Conversation<'a>
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl<'a> Debug for Conversation<'a>
[src]
impl<'a> Debug for Conversation<'a>
[src]impl<'de, 'a> Deserialize<'de> for Conversation<'a>
[src]
impl<'de, 'a> Deserialize<'de> for Conversation<'a>
[src]fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]Deserialize this value from the given Serde deserializer. Read more
impl<'a> From<Conversation<'a>> for Select<'a>
[src]
impl<'a> From<Conversation<'a>> for Select<'a>
[src]fn from(src: Conversation<'a>) -> Select<'a>
[src]
fn from(src: Conversation<'a>) -> Select<'a>
[src]Performs the conversion.
impl<'a> From<Conversation<'a>> for BlockElement<'a>
[src]
impl<'a> From<Conversation<'a>> for BlockElement<'a>
[src]fn from(src: SelectConversation<'a>) -> BlockElement<'a>
[src]
fn from(src: SelectConversation<'a>) -> BlockElement<'a>
[src]Performs the conversion.
impl<'a> From<Conversation<'a>> for BlockElement<'a>
[src]
impl<'a> From<Conversation<'a>> for BlockElement<'a>
[src]fn from(src: SelectConversation<'a>) -> BlockElement<'a>
[src]
fn from(src: SelectConversation<'a>) -> BlockElement<'a>
[src]Performs the conversion.
impl<'a> Hash for Conversation<'a>
[src]
impl<'a> Hash for Conversation<'a>
[src]impl<'a> PartialEq<Conversation<'a>> for Conversation<'a>
[src]
impl<'a> PartialEq<Conversation<'a>> for Conversation<'a>
[src]fn eq(&self, other: &Conversation<'a>) -> bool
[src]
fn eq(&self, other: &Conversation<'a>) -> bool
[src]This method tests for self
and other
values to be equal, and is used
by ==
. Read more
fn ne(&self, other: &Conversation<'a>) -> bool
[src]
fn ne(&self, other: &Conversation<'a>) -> bool
[src]This method tests for !=
.
impl<'a> Serialize for Conversation<'a>
[src]
impl<'a> Serialize for Conversation<'a>
[src]impl<'a> Validate for Conversation<'a>
[src]
impl<'a> Validate for Conversation<'a>
[src]fn validate(&self) -> Result<(), ValidationErrors>
[src]
impl<'a> StructuralPartialEq for Conversation<'a>
[src]
Auto Trait Implementations
impl<'a> RefUnwindSafe for Conversation<'a>
impl<'a> Send for Conversation<'a>
impl<'a> Sync for Conversation<'a>
impl<'a> Unpin for Conversation<'a>
impl<'a> UnwindSafe for Conversation<'a>
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,