SlackTextField

pydantic model safir.slack.blockkit.SlackTextField

One field in a Slack message with a heading and text body.

Intended for use in the fields portion of a Block Kit message. If the formatted output is longer than 2000 characters, it will be truncated to avoid the strict upper limit imposed by Slack.

Parameters:

data (Any)

Fields:

• heading (str)

• text (str)

field heading: str [Required]

Heading of the field (shown in bold).

field text: str [Required]

Text of the field as normal text.

This is always marked as vertabim, so channel mentions or @-mentions of users will not be treated as special.

to_slack()

Convert to a Slack Block Kit block.

Returns:

A Slack Block Kit block suitable for including in the fields or text section of a blocks element.

Return type:

dict

max_formatted_length: ClassVar[int] = 2000

Maximum length of formatted output, imposed by Slack.

Intended to be overridden by child classes that need to impose different maximum lengths.