Objects

Composition objects are the lowest-level primitives used inside of Block objects.

See: https://api.slack.com/reference/block-kit/composition-objects.

Confirm

Alias for ConfirmationDialogue to retain backwards compatibility.

See

ConfirmationDialogue.

Source code in slackblocks/objects.py

class Confirm(ConfirmationDialogue):
    """
    Alias for `ConfirmationDialogue` to retain backwards compatibility.

    See:
        [`ConfirmationDialogue`](/slackblocks/latest/reference/objects/#objects.ConfirmationDialogue).
    """

    def __init__(self, *args, **kwargs) -> None:
        super(*args, **kwargs)

ConfirmationDialogue

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 confirm and deny buttons.

Parameters:

Name	Type	Description	Default
title	TextLike	the text heading presented at the top of the dialogue box (max 100 chars).	required
text	TextLike	the text explaining the decision being made by the user through the dialogue box (max 300 chars).	required
confirm	TextLike	the text inside the confirmation button of the dialogue box (max 30 chars).	required
deny	TextLike	the text inside the deny button of the dialogue box (max 30 chars).	required

Throws

InvalidUsageError: if any of the arguments fail to pass validation checks.

Source code in slackblocks/objects.py

class ConfirmationDialogue(CompositionObject):
    """
    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 confirm and deny buttons.

    Args:
        title: the text heading presented at the top of the dialogue box (max 100 chars).
        text: the text explaining the decision being made by the user through
            the dialogue box (max 300 chars).
        confirm: the text inside the confirmation button of the dialogue box (max 30 chars).
        deny: the text inside the deny button of the dialogue box (max 30 chars).

    Throws:
        InvalidUsageError: if any of the arguments fail to pass validation checks.
    """

    def __init__(
        self,
        title: TextLike,
        text: TextLike,
        confirm: TextLike,
        deny: TextLike,
    ) -> None:
        super().__init__(type_=CompositionObjectType.CONFIRM)
        self.title = Text.to_text_nonnull(title, max_length=100, force_plaintext=True)
        self.text = Text.to_text_nonnull(text, max_length=300)
        self.confirm = Text.to_text_nonnull(
            confirm, max_length=30, force_plaintext=True
        )
        self.deny = Text.to_text_nonnull(deny, max_length=30, force_plaintext=True)

    def _resolve(self) -> Dict[str, Any]:

        return {
            "title": self.title._resolve(),
            "text": self.text._resolve(),
            "confirm": self.confirm._resolve(),
            "deny": self.deny._resolve(),
        }

ConversationFilter

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

See: https://api.slack.com/reference/block-kit/composition-objects#filter_conversations.

At least one of the available arguments must be provided.

Parameters:

Name	Type	Description	Default
include	Optional[Union[str, List[str]]]	Which types of conversations to include in the list. One of more of im, mpim, private, public.	None
exclude_external_shared_channels	Optional[bool]	whether to remove shared public channels from the list. See https://api.slack.com/enterprise/shared-channels.	None
exclude_bot_users	Optional[bool]	whether to remove bot users from the list of conversations.	None

Throws

InvalidUsageException: in the event that the user provides none of include, exclude_external_shared_channels, or exclude_bot_users arguments.

Source code in slackblocks/objects.py

class ConversationFilter(CompositionObject):
    """
    Provides a way to filter the list of options in a conversations select menu or
    conversations multi-select menu.

    See: <https://api.slack.com/reference/block-kit/composition-objects#filter_conversations>.

    At least one of the available arguments _must_ be provided.

    Args:
        include: Which types of conversations to include in the list.
            One of more of `im`, `mpim`, `private`, `public`.
        exclude_external_shared_channels: whether to remove shared public channels
            from the list. See <https://api.slack.com/enterprise/shared-channels>.
        exclude_bot_users: whether to remove bot users from the list of conversations.

    Throws:
        InvalidUsageException: in the event that the user provides none of `include`,
            `exclude_external_shared_channels`, or `exclude_bot_users` arguments.
    """

    def __init__(
        self,
        include: Optional[Union[str, List[str]]] = None,
        exclude_external_shared_channels: Optional[bool] = None,
        exclude_bot_users: Optional[bool] = None,
    ) -> None:
        super().__init__(type_=CompositionObjectType.FILTER)
        if not (
            include
            or exclude_external_shared_channels is not None
            or exclude_bot_users is not None
        ):
            raise InvalidUsageError(
                "One of `include`, `exclude_external_shared_channels`, or "
                "`exclude_bot_users` is required."
            )
        self.include = coerce_to_list(include, str, allow_none=True)
        self.exclude_external_shared_channels = exclude_external_shared_channels
        self.exclude_bot_users = exclude_bot_users

    def _resolve(self) -> Dict[str, Any]:
        filter: Dict[str, Any] = {}  # Does not include type in JSON
        if self.include:
            filter["include"] = self.include
        if self.exclude_external_shared_channels is not None:
            filter["exclude_external_shared_channels"] = (
                self.exclude_external_shared_channels
            )
        if self.exclude_bot_users is not None:
            filter["exclude_bot_users"] = self.exclude_bot_users
        return filter

DispatchActionConfiguration

Determines when a plain-text input element will return a block_actions interaction payload.

Parameters:

Name	Type	Description	Default
trigger_actions_on	Optional[Union[str, List[str]]]	a list of strings representing interaction types that should return a block_actions payload. One or both of on_enter_pressed, on_character_entered.	None

Throws

InvalidUsageError: if an invalid value is provided amongst the options for trigger_actions_on.

Source code in slackblocks/objects.py

class DispatchActionConfiguration(CompositionObject):
    """
    Determines when a plain-text input element will return a `block_action`s interaction payload.

    Args:
        trigger_actions_on: a list of strings representing interaction types that should return
            a `block_actions` payload. One or both of `on_enter_pressed`, `on_character_entered`.

    Throws:
        InvalidUsageError: if an invalid value is provided amongst the options for
            `trigger_actions_on`.
    """

    def __init__(
        self, trigger_actions_on: Optional[Union[str, List[str]]] = None
    ) -> None:
        trigger_actions_on = trigger_actions_on or []
        self.trigger_actions_on = list(
            set(coerce_to_list_nonnull(trigger_actions_on, str, min_size=1, max_size=2))
        )
        for trigger in self.trigger_actions_on:
            if trigger not in ALLOWABLE_TRIGGERS:
                raise InvalidUsageError(
                    f"Trigger {trigger} not in allowable values ({ALLOWABLE_TRIGGERS})"
                )

    def _resolve(self) -> Dict[str, Any]:
        dispatch_action_config = {}  # Does not include type in JSON
        dispatch_action_config["trigger_actions_on"] = self.trigger_actions_on
        return dispatch_action_config

InputParameter

Contains information about an input parameter.

See https://api.slack.com/automation/workflows#defining-input-parameters.

Parameters:

Name	Type	Description	Default
name	str	the name of the input parameter.	required
value	str	the value associated with the input parameter.	required

Source code in slackblocks/objects.py

class InputParameter(CompositionObject):
    """
    Contains information about an input parameter.

    See <https://api.slack.com/automation/workflows#defining-input-parameters>.

    Args:
        name: the name of the input parameter.
        value: the value associated with the input parameter.
    """

    def __init__(self, name: str, value: str) -> None:
        super().__init__(type_=CompositionObjectType.INPUT_PARAMETER)
        self.name = name
        self.value = value

    def _resolve(self) -> Dict[str, Any]:
        input_parameter = {}  # Does not include type in JSON
        input_parameter["name"] = self.name
        input_parameter["value"] = self.value
        return input_parameter

Option

An object that represents a single selectable item in a select menu, multi-select menu, checkbox group, radio button group, or overflow menu.

See https://api.slack.com/reference/block-kit/composition-objects#option.

Parameters:

Name	Type	Description	Default
text	TextLike	the text identifying the option (that the user will see).	required
value	str	the underlying value of that option (not seen by the user).	required
description	Optional[TextLike]	a more detailed explanation of what the option means (user-facing).	None
url	Optional[str]	a URL to load in the user's browser when the option is clicked. Only available in OverflowMenus.	None

Throws

InvalidUsageError: when any of the provided arguments fail validation.

Source code in slackblocks/objects.py

class Option(CompositionObject):
    """
    An object that represents a single selectable item in a select menu, multi-select
    menu, checkbox group, radio button group, or overflow menu.

    See <https://api.slack.com/reference/block-kit/composition-objects#option>.

    Args:
        text: the text identifying the option (that the user will see).
        value: the underlying value of that option (not seen by the user).
        description: a more detailed explanation of what the option means (user-facing).
        url: a URL to load in the user's browser when the option is clicked.
            Only available in `OverflowMenus`.

    Throws:
        InvalidUsageError: when any of the provided arguments fail validation.
    """

    def __init__(
        self,
        text: TextLike,
        value: str,
        description: Optional[TextLike] = None,
        url: Optional[str] = None,
    ) -> None:
        super().__init__(type_=CompositionObjectType.OPTION)
        self.text = Text.to_text_nonnull(text, max_length=75)
        self.value = validate_string_nonnull(value, field_name="value", max_length=75)
        self.description = Text.to_text(
            description, max_length=75, force_plaintext=True, allow_none=True
        )
        if url and len(url) > 3000:
            raise InvalidUsageError("Option URLs must be less than 3000 characters")
        self.url = url

    def _resolve(self) -> Dict[str, Any]:
        option: Dict[str, Any] = {}  # Does not include type in JSON
        option["text"] = self.text._resolve()
        option["value"] = self.value
        if self.description is not None:
            option["description"] = self.description._resolve()
        if self.url is not None:
            option["url"] = self.url
        return option

    def __eq__(self, other) -> bool:
        return (
            self.type == other.type
            and self.text == other.text
            and self.value == other.value
            and self.description == other.description
            and self.url == other.url
        )

OptionGroup

Provides a way to group options in a select menu or multi-select menu.

See https://api.slack.com/reference/block-kit/composition-objects#option_group.

Parameters:

Name	Type	Description	Default
label	TextLike	a label shown above the group of options.	required
options	List[Option]	a list of Option objects that will form the contents of the group (max 100).	required

Throws

InvalidUsageError: if no options are provided or the label is not valid.

Source code in slackblocks/objects.py

class OptionGroup(CompositionObject):
    """
    Provides a way to group options in a select menu or multi-select menu.

    See <https://api.slack.com/reference/block-kit/composition-objects#option_group>.

    Args:
        label: a label shown above the group of options.
        options: a list of `Option` objects that will form the contents of the group (max 100).

    Throws:
        InvalidUsageError: if no options are provided or the label is not valid.
    """

    def __init__(self, label: TextLike, options: List[Option]) -> None:
        super().__init__(type_=CompositionObjectType.OPTION_GROUP)
        self.label = Text.to_text(label, max_length=75, force_plaintext=True)
        self.options: List[Option] = coerce_to_list_nonnull(
            options,
            class_=Option,
            min_size=1,
            max_size=100,
        )

    def _resolve(self) -> Dict[str, Any]:
        option_group: Dict[str, Any] = {}  # Does not include type in JSON
        if self.label is not None:
            option_group["label"] = self.label._resolve()
        if self.options is not None:
            option_group["options"] = [option._resolve() for option in self.options]
        return option_group

SlackFile

Defines an object containing Slack file information to be used in an image block or image element.

This file must be an image and you must provide either the URL or ID (not both).

See: https://api.slack.com/reference/block-kit/composition-objects#slack_file.

Parameters:

Name	Type	Description	Default
url	Optional[str]	the URL can be the url_private or the permalink of the Slack file (only one of url or id can be provided).	required
id	Optional[str]	the Slack ID of the file (only one of url or id can be provided).	required

Throws

InvalidUsageError: if both url and id are provided

Source code in slackblocks/objects.py

class SlackFile(CompositionObject):
    """
    Defines an object containing Slack file information to be used in an image
        block or image element.

    This file must be an image and you must provide either the URL or ID (not both).

    See: <https://api.slack.com/reference/block-kit/composition-objects#slack_file>.

    Args:
        url: the URL can be the `url_private` or the `permalink` of the Slack file
            (only one of `url` or `id` can be provided).
        id: the Slack ID of the file
            (only one of `url` or `id` can be provided).

    Throws:
        InvalidUsageError: if both `url` and `id` are provided
    """

    def __init__(
        self,
        url: Optional[str],
        id: Optional[str],
    ) -> None:
        super().__init__(CompositionObjectType.SLACK_FILE)
        if url and id:
            raise InvalidUsageError("Cannot provide both `url` and `id`.")
        self.url = url
        self.id = id

    def _resolve(self) -> Dict[str, Any]:
        file = {}  # Does not include type in JSON
        if self.url:
            file["url"] = self.url
        if self.id:
            file["id"] = self.id
        return file

Text

An object containing some text, formatted either as plain_text or using Slack's mrkdwn.

Parameters:

Name	Type	Description	Default
text	str	the text to be rendered in a message (max 3000 characters).	required
type_	TextType	either TextType.MARKDOWN or TextType.PLAINTEXT.	MARKDOWN
emoji	bool	only usable with TextType.PLAINTEXT, if True: emoji will be escaped into text format (e.g. :smile:).	False
verbatim	bool	only usable with TextType.MARKDOWN, if True: links, channel names, user names will not automatically be rendered as links.	False

Throws

InvalidUsageException: if the provided text fails validation.

Source code in slackblocks/objects.py

class Text(CompositionObject):
    """
    An object containing some text, formatted either as `plain_text` or using
    Slack's `mrkdwn`.

    Args:
        text: the text to be rendered in a message (max 3000 characters).
        type_: either `TextType.MARKDOWN` or `TextType.PLAINTEXT`.
        emoji: only usable with `TextType.PLAINTEXT`, if True: emoji will be
            escaped into text format (e.g. `:smile:`).
        verbatim: only usable with `TextType.MARKDOWN`, if True: links, channel
            names, user names will not automatically be rendered as links.

    Throws:
        InvalidUsageException: if the provided `text` fails validation.
    """

    def __init__(
        self,
        text: str,
        type_: TextType = TextType.MARKDOWN,
        emoji: bool = False,
        verbatim: bool = False,
    ) -> None:
        super().__init__(type_=CompositionObjectType.TEXT)
        self.text_type = type_
        self.text = validate_string_nonnull(
            text, field_name="text", min_length=1, max_length=3000
        )
        if self.text_type == TextType.MARKDOWN:
            self.verbatim = verbatim
            self.emoji = False
        elif self.text_type == TextType.PLAINTEXT:
            self.verbatim = False
            self.emoji = emoji

    def _resolve(self) -> Dict[str, Any]:
        text = self._attributes()
        text["type"] = self.text_type.value
        text["text"] = self.text
        if self.text_type == TextType.MARKDOWN and self.verbatim:
            text["verbatim"] = self.verbatim
        elif self.text_type == TextType.PLAINTEXT and self.emoji:
            text["emoji"] = self.emoji
        return text

    @staticmethod
    def to_text(
        text: Optional[Union[str, "Text"]],
        force_plaintext: bool = False,
        max_length: Optional[int] = None,
        allow_none: bool = False,
    ) -> Optional["Text"]:
        """
        Coerces `str` or `Text` objects into `Text` objects.

        Args:
            text: the `str` or `Text` object to ensure is in `Text` format.
            force_plaintext: if `True`, forces the `str` or `Text` object
                into a `Text` object with the type `TextType.PLAINTEXT`.
            max_length: `text` will be checked against this length in addition
                to the standard `Text` limit of 3000 characters.
            allow_none: whether to accept `None` as a valid value for `text`.
        """
        if text is None:
            if allow_none:
                return None
            raise InvalidUsageError("This field cannot have the value None or ''")
        return Text.to_text_nonnull(
            text,
            force_plaintext,
            max_length,
        )

    @staticmethod
    def to_text_nonnull(
        text: Union[str, "Text"],
        force_plaintext: bool = False,
        max_length: Optional[int] = None,
    ) -> "Text":
        """
        Coerces `str` or `Text` objects into `Text` objects, but does not allow `None` values.

        Args:
            text: the `str` or `Text` object to ensure is in `Text` format.
            force_plaintext: if `True`, forces the `str` or `Text` object
                into a `Text` object with the type `TextType.PLAINTEXT`.
            max_length: `text` will be checked against this length in addition
                to the standard `Text` limit of 3000 characters.

        Returns:
            A `Text` object created from the input.

        Throws:
            InvalidUsageError: if the text length exceeds the specified max_length.
        """
        original_type = text.text_type if isinstance(text, Text) else None
        type_ = (
            TextType.PLAINTEXT
            if force_plaintext
            else original_type or TextType.MARKDOWN
        )
        if text and max_length and len(text) > max_length:
            raise InvalidUsageError(
                f"`text` length ({len(text)}) exceeds `max_length` ({max_length})"
            )
        if isinstance(text, str):
            return Text(text=text, type_=type_)
        elif isinstance(text, Text):
            return Text(
                text=text.text, type_=type_, emoji=text.emoji, verbatim=text.verbatim
            )
        else:
            raise InvalidUsageError("This field must be a string or Text object")

    def __str__(self) -> str:
        return dumps(self._resolve())

    def __len__(self) -> int:
        return len(self.text)

    def __eq__(self, other) -> bool:
        return (
            self.text_type == other.text_type
            and self.text == other.text
            and self.emoji == other.emoji
            and self.verbatim == other.verbatim
        )

to_text staticmethod

to_text(
    text,
    force_plaintext=False,
    max_length=None,
    allow_none=False,
)

Coerces str or Text objects into Text objects.

Parameters:

Name	Type	Description	Default
text	Optional[Union[str, Text]]	the str or Text object to ensure is in Text format.	required
force_plaintext	bool	if True, forces the str or Text object into a Text object with the type TextType.PLAINTEXT.	False
max_length	Optional[int]	text will be checked against this length in addition to the standard Text limit of 3000 characters.	None
allow_none	bool	whether to accept None as a valid value for text.	False

Source code in slackblocks/objects.py

@staticmethod
def to_text(
    text: Optional[Union[str, "Text"]],
    force_plaintext: bool = False,
    max_length: Optional[int] = None,
    allow_none: bool = False,
) -> Optional["Text"]:
    """
    Coerces `str` or `Text` objects into `Text` objects.

    Args:
        text: the `str` or `Text` object to ensure is in `Text` format.
        force_plaintext: if `True`, forces the `str` or `Text` object
            into a `Text` object with the type `TextType.PLAINTEXT`.
        max_length: `text` will be checked against this length in addition
            to the standard `Text` limit of 3000 characters.
        allow_none: whether to accept `None` as a valid value for `text`.
    """
    if text is None:
        if allow_none:
            return None
        raise InvalidUsageError("This field cannot have the value None or ''")
    return Text.to_text_nonnull(
        text,
        force_plaintext,
        max_length,
    )

to_text_nonnull staticmethod

to_text_nonnull(
    text, force_plaintext=False, max_length=None
)

Coerces str or Text objects into Text objects, but does not allow None values.

Parameters:

Name	Type	Description	Default
text	Union[str, Text]	the str or Text object to ensure is in Text format.	required
force_plaintext	bool	if True, forces the str or Text object into a Text object with the type TextType.PLAINTEXT.	False
max_length	Optional[int]	text will be checked against this length in addition to the standard Text limit of 3000 characters.	None

Returns:

Type	Description
Text	A Text object created from the input.

Throws

InvalidUsageError: if the text length exceeds the specified max_length.

Source code in slackblocks/objects.py

@staticmethod
def to_text_nonnull(
    text: Union[str, "Text"],
    force_plaintext: bool = False,
    max_length: Optional[int] = None,
) -> "Text":
    """
    Coerces `str` or `Text` objects into `Text` objects, but does not allow `None` values.

    Args:
        text: the `str` or `Text` object to ensure is in `Text` format.
        force_plaintext: if `True`, forces the `str` or `Text` object
            into a `Text` object with the type `TextType.PLAINTEXT`.
        max_length: `text` will be checked against this length in addition
            to the standard `Text` limit of 3000 characters.

    Returns:
        A `Text` object created from the input.

    Throws:
        InvalidUsageError: if the text length exceeds the specified max_length.
    """
    original_type = text.text_type if isinstance(text, Text) else None
    type_ = (
        TextType.PLAINTEXT
        if force_plaintext
        else original_type or TextType.MARKDOWN
    )
    if text and max_length and len(text) > max_length:
        raise InvalidUsageError(
            f"`text` length ({len(text)}) exceeds `max_length` ({max_length})"
        )
    if isinstance(text, str):
        return Text(text=text, type_=type_)
    elif isinstance(text, Text):
        return Text(
            text=text.text, type_=type_, emoji=text.emoji, verbatim=text.verbatim
        )
    else:
        raise InvalidUsageError("This field must be a string or Text object")

TextType

Allowable types for Slack Text objects.

tradional markdown formatting, see

https://api.slack.com/reference/surfaces/formatting#basic-formatting

PLAINTEXT: simple Unicode text with no formatting (e.g. bold) features.

N.B: some usages of Text objects only allow the PLAINTEXT variety.

Source code in slackblocks/objects.py

class TextType(Enum):
    """
    Allowable types for Slack Text objects.

    MARKDOWN: tradional markdown formatting, see
        <https://api.slack.com/reference/surfaces/formatting#basic-formatting>
    PLAINTEXT: simple Unicode text with no formatting (e.g. bold) features.

    N.B: some usages of Text objects only allow the `PLAINTEXT` variety.
    """

    MARKDOWN = "mrkdwn"
    PLAINTEXT = "plain_text"

Trigger

Contains information about a trigger.

See: https://api.slack.com/automation/triggers.

Parameters:

Name	Type	Description	Default
url	str	a link trigger URL, see https://api.slack.com/automation/triggers/link	required
customizable_input_parameters	Optional[Union[InputParameter, List[InputParameter]]]	a list of InputParameter objects which map to those parameters defined on the Workflow in which they are provided.	required

Throws

InvalidUsageError: when any of the items in customizable_input_parameters is not a valid InputParameter.

Source code in slackblocks/objects.py

class Trigger(CompositionObject):
    """
    Contains information about a trigger.

    See: <https://api.slack.com/automation/triggers>.

    Args:
        url: a link trigger URL, see
            <https://api.slack.com/automation/triggers/link>
        customizable_input_parameters: a list of `InputParameter` objects
            which map to those parameters defined on the Workflow in
            which they are provided.

    Throws:
        InvalidUsageError: when any of the items in
            `customizable_input_parameters` is not a valid `InputParameter`.
    """

    def __init__(
        self,
        url: str,
        customizable_input_parameters: Optional[
            Union[InputParameter, List[InputParameter]]
        ],
    ) -> None:
        super().__init__(type_=CompositionObjectType.TRIGGER)
        self.url = url
        self.customizable_input_parameters = coerce_to_list(
            customizable_input_parameters, InputParameter, allow_none=True
        )

    def _resolve(self) -> Dict[str, Any]:
        trigger: Dict[str, Any] = {}  # Does not include type in JSON
        trigger["url"] = self.url
        if self.customizable_input_parameters:
            trigger["customizable_input_parameters"] = [
                parameter._resolve() for parameter in self.customizable_input_parameters
            ]
        return trigger

Workflow

Contains information about a workflow.

See https://api.slack.com/automation/workflows.

Parameters:

Name	Type	Description	Default
trigger	Trigger	a Trigger object that will initiate the workflow.	required

Source code in slackblocks/objects.py

class Workflow(CompositionObject):
    """
    Contains information about a workflow.

    See <https://api.slack.com/automation/workflows>.

    Args:
        trigger: a `Trigger` object that will initiate the workflow.
    """

    def __init__(self, trigger: Trigger) -> None:
        super().__init__(type_=CompositionObjectType.WORKFLOW)
        self.trigger = trigger

    def _resolve(self) -> Dict[str, Any]:
        workflow = {}  # Does not include type in JSON
        workflow["trigger"] = self.trigger._resolve()
        return workflow