Struct slack_blocks::elems::select::PublicChannel [−][src]
pub struct PublicChannel<'a> { /* fields omitted */ }
Expand description
Public Channel Select
This select menu will populate its options with a list of public channels visible to the current user in the active workspace.
Implementations
impl<'a> PublicChannel<'a>
[src]
impl<'a> PublicChannel<'a>
[src]pub fn builder() -> PublicChannelBuilderInit<'a>
[src]
pub fn builder() -> PublicChannelBuilderInit<'a>
[src]Build a new public channel select element
Examples
use std::convert::TryFrom; use slack_blocks::{blocks::{Actions, Block}, compose::Opt, elems::{select, BlockElement}, text}; let select: BlockElement = select::PublicChannel::builder().placeholder("Choose your favorite channel!") .action_id("fave_channel") .build() .into(); let block: Block = Actions::try_from(select).unwrap().into();
pub fn from_placeholder_and_action_id(
placeholder: impl Into<Plain>,
action_id: impl Into<Cow<'a, str>>
) -> Self
[src]
👎 Deprecated since 0.16.10: use elems::select::PublicChannel::builder instead.
pub fn from_placeholder_and_action_id(
placeholder: impl Into<Plain>,
action_id: impl Into<Cow<'a, str>>
) -> Self
[src]use elems::select::PublicChannel::builder instead.
Construct a Select element, with a data source of the Public Channels in the user’s 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 slack_blocks::elems::select; use slack_blocks::blocks; use slack_blocks::text; let select = select::PublicChannel::from_placeholder_and_action_id( "Pick a Channel...", "ABC123" ); let blocks: Vec<blocks::Block> = vec![ blocks::Section::from_text(text::Plain::from( "Pick a channel to send your poll to...") ).into(), blocks::Actions::from_action_elements(vec![select.into()]).into(), ]; // <send to slack's API>
pub fn with_confirm(self, confirm: Confirm) -> Self
[src]
👎 Deprecated since 0.16.10: use elems::select::PublicChannel::builder instead.
pub fn with_confirm(self, confirm: Confirm) -> Self
[src]use elems::select::PublicChannel::builder instead.
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 slack_blocks::elems::select; use slack_blocks::text; use slack_blocks::blocks; use slack_blocks::compose; let confirm = compose::Confirm::from_parts( "Confirm Poll Channel", text::Plain::from( "Are you sure this is the channel you want to send this to?" ), "Yep, I'm sure", "No way!" ); let select = select::PublicChannel::from_placeholder_and_action_id( "Pick a Channel...", "ABC123" ) .with_confirm(confirm); let blocks: Vec<blocks::Block> = vec![ blocks::Section::from_text(text::Plain::from( "Pick a channel to send your poll to..." )).into(), blocks::Actions::from_action_elements(vec![select.into()]).into(), ]; // <send to slack's API>
pub fn with_initial_channel(self, channel_id: impl Into<Cow<'a, str>>) -> Self
[src]
👎 Deprecated since 0.16.10: use elems::select::PublicChannel::builder instead.
pub fn with_initial_channel(self, channel_id: impl Into<Cow<'a, str>>) -> Self
[src]use elems::select::PublicChannel::builder instead.
Optional method that allows you to set a pre-selected channel in the select menu with the channel’s ID.
Arguments
channel
- The ID of any valid public channel to be pre-selected when the menu loads.
Example
use slack_blocks::elems::select; use slack_blocks::text; use slack_blocks::blocks; use slack_blocks::compose; let confirm = compose::Confirm::from_parts( "Confirm Poll Channel", text::Plain::from( "Are you sure this is the channel you want to send this to?" ), "Yep, I'm sure", "No way!" ); let channel_general = ("#general", "C12345"); let select = select::PublicChannel::from_placeholder_and_action_id( "Pick a Channel...", "ABC123" ) .with_confirm(confirm) .with_initial_channel(channel_general.1); let blocks: Vec<blocks::Block> = vec![ blocks::Section::from_text(text::Plain::from( "Pick a channel to send your poll to..." )).into(), blocks::Actions::from_action_elements(vec![select.into()]).into(), ]; // <send to slack's API>
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
Example
use slack_blocks::elems::select; let select = select::PublicChannel::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 PublicChannel<'a>
[src]
impl<'a> Clone for PublicChannel<'a>
[src]fn clone(&self) -> PublicChannel<'a>
[src]
fn clone(&self) -> PublicChannel<'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 PublicChannel<'a>
[src]
impl<'a> Debug for PublicChannel<'a>
[src]impl<'de, 'a> Deserialize<'de> for PublicChannel<'a>
[src]
impl<'de, 'a> Deserialize<'de> for PublicChannel<'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<PublicChannel<'a>> for SupportedElement<'a>
[src]
impl<'a> From<PublicChannel<'a>> for SupportedElement<'a>
[src]fn from(src: PublicChannel<'a>) -> Self
[src]
fn from(src: PublicChannel<'a>) -> Self
[src]Performs the conversion.
impl<'a> From<PublicChannel<'a>> for SupportedElement<'a>
[src]
impl<'a> From<PublicChannel<'a>> for SupportedElement<'a>
[src]fn from(src: PublicChannel<'a>) -> Self
[src]
fn from(src: PublicChannel<'a>) -> Self
[src]Performs the conversion.
impl<'a> From<PublicChannel<'a>> for Select<'a>
[src]
impl<'a> From<PublicChannel<'a>> for Select<'a>
[src]fn from(src: PublicChannel<'a>) -> Self
[src]
fn from(src: PublicChannel<'a>) -> Self
[src]Performs the conversion.
impl<'a> From<PublicChannel<'a>> for BlockElement<'a>
[src]
impl<'a> From<PublicChannel<'a>> for BlockElement<'a>
[src]fn from(src: PublicChannel<'a>) -> Self
[src]
fn from(src: PublicChannel<'a>) -> Self
[src]Performs the conversion.
impl<'a> Hash for PublicChannel<'a>
[src]
impl<'a> Hash for PublicChannel<'a>
[src]impl<'a> PartialEq<PublicChannel<'a>> for PublicChannel<'a>
[src]
impl<'a> PartialEq<PublicChannel<'a>> for PublicChannel<'a>
[src]fn eq(&self, other: &PublicChannel<'a>) -> bool
[src]
fn eq(&self, other: &PublicChannel<'a>) -> bool
[src]This method tests for self
and other
values to be equal, and is used
by ==
. Read more
fn ne(&self, other: &PublicChannel<'a>) -> bool
[src]
fn ne(&self, other: &PublicChannel<'a>) -> bool
[src]This method tests for !=
.
impl<'a> Serialize for PublicChannel<'a>
[src]
impl<'a> Serialize for PublicChannel<'a>
[src]impl<'a> Validate for PublicChannel<'a>
[src]
impl<'a> Validate for PublicChannel<'a>
[src]fn validate(&self) -> Result<(), ValidationErrors>
[src]
impl<'a> StructuralPartialEq for PublicChannel<'a>
[src]
Auto Trait Implementations
impl<'a> RefUnwindSafe for PublicChannel<'a>
impl<'a> Send for PublicChannel<'a>
impl<'a> Sync for PublicChannel<'a>
impl<'a> Unpin for PublicChannel<'a>
impl<'a> UnwindSafe for PublicChannel<'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>,