Struct WorkflowButton 

pub struct WorkflowButton { /* private fields */ }

Workflow button element representation.

Fields and Validations

For more details, see the official documentation.

Field	Type	Required	Validation
text	Text<Plain>	Yes	Max length 75 characters
action_id	String	Yes	Max length 255 characters
workflow	Workflow	Yes	N/A
style	&’static str	No	Must be one of “primary”, “danger”
accessibility_label	String	No	Max length 75 characters

Example

use slack_messaging::plain_text;
use slack_messaging::blocks::elements::WorkflowButton;
use slack_messaging::composition_objects::{types::InputParameter, Trigger, Workflow};

let button = WorkflowButton::builder()
    .text(plain_text!("Run Workflow")?)
    .action_id("workflowbutton123")
    .workflow(
        Workflow::builder()
            .trigger(
                Trigger::builder()
                     .url("https://slack.com/shortcuts/Ft0123ABC456/123...xyz")
                     .customizable_input_parameter(
                         InputParameter::builder()
                             .name("input_parameter_a")
                             .value("Value for input param A")
                             .build()?
                     )
                     .customizable_input_parameter(
                         InputParameter::builder()
                             .name("input_parameter_b")
                             .value("Value for input param B")
                             .build()?
                     )
                     .build()?
            )
            .build()?
    )
    .build()?;

let expected = serde_json::json!({
    "type": "workflow_button",
    "text": {
        "type": "plain_text",
        "text": "Run Workflow"
    },
    "action_id": "workflowbutton123",
    "workflow": {
        "trigger": {
            "url": "https://slack.com/shortcuts/Ft0123ABC456/123...xyz",
            "customizable_input_parameters": [
                {
                    "name": "input_parameter_a",
                    "value": "Value for input param A"
                },
                {
                    "name": "input_parameter_b",
                    "value": "Value for input param B"
                }
            ]
        }
    }
});

let json = serde_json::to_value(button).unwrap();

assert_eq!(json, expected);

// If your object has any validation errors, the build method returns Result::Err
let button = WorkflowButton::builder()
    .text(plain_text!("Run Workflow")?)
    .action_id("workflowbutton123")
    .build();

assert!(button.is_err());

Implementations

impl WorkflowButton

pub fn builder() -> WorkflowButtonBuilder

constract WorkflowButtonBuilder object.

Trait Implementations

impl Clone for WorkflowButton

fn clone(&self) -> WorkflowButton

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkflowButton

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

Formats the value using the given formatter.

impl From<WorkflowButton> for Accessory

fn from(value: WorkflowButton) -> Self

Converts to this type from the input type.

impl From<WorkflowButton> for ActionsElement

fn from(value: WorkflowButton) -> Self

Converts to this type from the input type.

impl PartialEq for WorkflowButton

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for WorkflowButton

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for WorkflowButton