Struct slack_blocks::compose::Confirm

pub struct Confirm { /* fields omitted */ }

Confirm Dialog

slack api docs 🔗

An object that defines a dialog that provides a confirmation step to any interactive element. This dialog will ask the user to confirm their action by offering a confirm and deny buttons.

Implementations

impl Confirm

pub fn from_parts(
    title: impl Into<Plain>,
    text: impl Into<Text>,
    confirm: impl Into<Plain>,
    deny: impl Into<Plain>
) -> Self

Creates a Confirmation Dialog from the required parts.

Arguments

• title - A plain_text-only text object 🔗 that defines the dialog’s title. Maximum length for this field is 100 characters.

• text - A text object 🔗 that defines the explanatory text that appears in the confirm dialog. Maximum length for the text in this field is 300 characters.

• confirm - A plain_text-only text object 🔗 to define the text of the button that confirms the action. Maximum length for the text in this field is 30 characters.

• deny - A plain_text-only text object 🔗 to define the text of the button that cancels the action. Maximum length for the text in this field is 30 characters.

Example

use slack_blocks::compose::Confirm;
use slack_blocks::text;

let dialog = Confirm::from_parts(
    "Are you sure?",
    text::Mrkdwn::from("Are you _sure_ you're sure?\nThis action is permanent."),
    "I'm sure.",
    "I'm not sure!",
);

// Results in a modal that looks like:
//  _______________________________
// |                               |
// | Are you sure?                 |
// |_______________________________|
// |                               |
// | Are you _sure_ you're sure?   |
// | This action is permanent.     |
// |_______________________________|
// |                               |
// |   |I'm not sure!| |I'm sure.| |
// |_______________________________|

pub fn with_style(self, style: ConfirmStyle) -> Self

Chainable setter method, used to set the style of the confirm button of your modal.

Arguments

• style - Defines the color scheme applied to the confirm button. A value of danger will display the button with a red background on desktop, or red text on mobile. A value of primary will display the button with a green background on desktop, or blue text on mobile. If this field is not provided, the default value will be primary.

Example

use slack_blocks::compose::{Confirm, ConfirmStyle};
use slack_blocks::text;

let dialog = Confirm::from_parts(
        "Are you sure?",
        text::Mrkdwn::from("Are you _sure_ you're sure?\nThis action is permanent."),
        "I'm sure.",
        "I'm not sure!",
    )
    .with_style(ConfirmStyle::Danger);

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

Validate that this Confirm composition object agrees with Slack’s model requirements

Errors

• If from_parts was called with title longer than 100 chars
• If from_parts was called with text longer than 300 chars
• If from_parts was called with confirm longer than 30 chars
• If from_parts was called with deny longer than 30 chars

Example

use slack_blocks::compose::{Confirm, ConfirmStyle};
use slack_blocks::text;

let dialog = Confirm::from_parts(
        "Are you sure?",
        text::Mrkdwn::from("Are you _sure_ you're sure?\nThis action is permanent."),
        "I'm sure.",
        "I'm not sure! Oh, geez, I just don't know! Help me decide, please??? Gosh, this is scary...",
    )
    .with_style(ConfirmStyle::Danger);

assert_eq!(true, matches!(dialog.validate(), Err(_)));

Trait Implementations

impl Clone for Confirm

fn clone(&self) -> Confirm

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Confirm

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Confirm

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

Deserialize this value from the given Serde deserializer.

impl Hash for Confirm

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<Confirm> for Confirm

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

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

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

This method tests for !=.

impl Serialize for Confirm

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 Confirm

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

impl StructuralPartialEq for Confirm