Web.Slack.Experimental.Blocks

General Slack Messages

data SlackText

Instances

ToJSON SlackText

Defined in Web.Slack.Experimental.Blocks.Types

Methods

toJSON :: SlackText -> Value

toEncoding :: SlackText -> Encoding

toJSONList :: [SlackText] -> Value

toEncodingList :: [SlackText] -> Encoding

IsString SlackText

Defined in Web.Slack.Experimental.Blocks.Types

Methods

fromString :: String -> SlackText

Monoid SlackText

Defined in Web.Slack.Experimental.Blocks.Types

Methods

mempty :: SlackText

mappend :: SlackText -> SlackText -> SlackText

mconcat :: [SlackText] -> SlackText

Semigroup SlackText

Defined in Web.Slack.Experimental.Blocks.Types

Methods

(<>) :: SlackText -> SlackText -> SlackText

sconcat :: NonEmpty SlackText -> SlackText

stimes :: Integral b => b -> SlackText -> SlackText

Show SlackText

Defined in Web.Slack.Experimental.Blocks.Types

Methods

showsPrec :: Int -> SlackText -> ShowS

show :: SlackText -> String

showList :: [SlackText] -> ShowS

Eq SlackText

Defined in Web.Slack.Experimental.Blocks.Types

Methods

(==) :: SlackText -> SlackText -> Bool

(/=) :: SlackText -> SlackText -> Bool

(<+>) :: SlackText -> SlackText -> SlackText

parens :: SlackText -> SlackText

brackets :: SlackText -> SlackText

angleBrackets :: SlackText -> SlackText

ticks :: SlackText -> SlackText

codeBlock :: SlackText -> SlackText

bold :: SlackText -> SlackText

italic :: SlackText -> SlackText

newline :: SlackText -> SlackText

unorderedList :: [SlackText] -> SlackText

Render an unordered (bulleted) list

link :: Text -> Maybe Text -> SlackText

Render a link with optional link text

monospaced :: Slack a => a -> SlackText

Render a Slack renderable value with ticks around it. Alias for ticks . message

mentionUser :: UserId -> SlackText

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

isSubStringOf :: Text -> SlackText -> Bool

data SlackImage

Constructors

SlackImage

Fields

• slackImageTitle :: !(Maybe Text)
• slackImageAltText :: !Text

  Optional Title

• slackImageUrl :: !Text

Instances

Show SlackImage

Defined in Web.Slack.Experimental.Blocks.Types

Methods

showsPrec :: Int -> SlackImage -> ShowS

show :: SlackImage -> String

showList :: [SlackImage] -> ShowS

Eq SlackImage

Defined in Web.Slack.Experimental.Blocks.Types

Methods

(==) :: SlackImage -> SlackImage -> Bool

(/=) :: SlackImage -> SlackImage -> Bool

data SlackMessage

Instances

FromJSON SlackMessage

Defined in Web.Slack.Experimental.Blocks.Types

Methods

parseJSON :: Value -> Parser SlackMessage

parseJSONList :: Value -> Parser [SlackMessage]

ToJSON SlackMessage

Defined in Web.Slack.Experimental.Blocks.Types

Methods

toJSON :: SlackMessage -> Value

toEncoding :: SlackMessage -> Encoding

toJSONList :: [SlackMessage] -> Value

toEncodingList :: [SlackMessage] -> Encoding

Monoid SlackMessage

Defined in Web.Slack.Experimental.Blocks.Types

Methods

mempty :: SlackMessage

mappend :: SlackMessage -> SlackMessage -> SlackMessage

mconcat :: [SlackMessage] -> SlackMessage

Semigroup SlackMessage

Defined in Web.Slack.Experimental.Blocks.Types

Methods

(<>) :: SlackMessage -> SlackMessage -> SlackMessage

sconcat :: NonEmpty SlackMessage -> SlackMessage

stimes :: Integral b => b -> SlackMessage -> SlackMessage

Show SlackMessage

Defined in Web.Slack.Experimental.Blocks.Types

Methods

showsPrec :: Int -> SlackMessage -> ShowS

show :: SlackMessage -> String

showList :: [SlackMessage] -> ShowS

Eq SlackMessage

Defined in Web.Slack.Experimental.Blocks.Types

Methods

(==) :: SlackMessage -> SlackMessage -> Bool

(/=) :: SlackMessage -> SlackMessage -> Bool

Image SlackMessage

Defined in Web.Slack.Experimental.Blocks.Types

Methods

image :: SlackImage -> SlackMessage

Markdown SlackMessage

Defined in Web.Slack.Experimental.Blocks.Types

Methods

markdown :: SlackText -> SlackMessage

class Markdown a where

Methods

markdown :: SlackText -> a

Instances

Markdown SlackContext

Defined in Web.Slack.Experimental.Blocks.Types

Methods

markdown :: SlackText -> SlackContext

Markdown SlackMessage

Defined in Web.Slack.Experimental.Blocks.Types

Methods

markdown :: SlackText -> SlackMessage

class Image a where

Methods

image :: SlackImage -> a

Instances

Image SlackContext

Defined in Web.Slack.Experimental.Blocks.Types

Methods

image :: SlackImage -> SlackContext

Image SlackMessage

Defined in Web.Slack.Experimental.Blocks.Types

Methods

image :: SlackImage -> SlackMessage

context :: SlackContext -> SlackMessage

textToMessage :: Text -> SlackMessage

prefixFirstSlackMessage :: Text -> [SlackMessage] -> [SlackMessage]

mentionUserGroupById :: SlackText -> SlackText

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

textToContext :: Text -> SlackMessage

slackMessage :: [SlackText] -> SlackMessage

Concatenate a list of SlackText into a single block, and wrap it up as a full message

data SlackBlock

Constructors

SlackBlockSection SlackText (Maybe SlackAccessory)

SlackBlockImage SlackImage

SlackBlockContext SlackContext

SlackBlockDivider

SlackBlockRichText RichText

SlackBlockActions (Maybe SlackBlockId) SlackActionList

SlackBlockHeader SlackPlainTextOnly

Instances

FromJSON SlackBlock

Defined in Web.Slack.Experimental.Blocks.Types

Methods

parseJSON :: Value -> Parser SlackBlock

parseJSONList :: Value -> Parser [SlackBlock]

ToJSON SlackBlock

Defined in Web.Slack.Experimental.Blocks.Types

Methods

toJSON :: SlackBlock -> Value

toEncoding :: SlackBlock -> Encoding

toJSONList :: [SlackBlock] -> Value

toEncodingList :: [SlackBlock] -> Encoding

Show SlackBlock

Defined in Web.Slack.Experimental.Blocks.Types

Methods

showsPrec :: Int -> SlackBlock -> ShowS

show :: SlackBlock -> String

showList :: [SlackBlock] -> ShowS

Eq SlackBlock

Defined in Web.Slack.Experimental.Blocks.Types

Methods

(==) :: SlackBlock -> SlackBlock -> Bool

(/=) :: SlackBlock -> SlackBlock -> Bool

Blocks' rich text formatting (receive only!)

data RichItem

Seemingly only documented at https://api.slack.com/changelog/2019-09-what-they-see-is-what-you-get-and-more-and-less

They warn of undocumented element types. Joy.

Constructors

RichItemText Text RichStyle

RichItemChannel ConversationId

RichItemUser UserId RichStyle

RichItemLink RichLinkAttrs

RichItemEmoji Text

RichItemOther Text Value

Instances

FromJSON RichItem

Defined in Web.Slack.Experimental.Blocks.Types

Methods

parseJSON :: Value -> Parser RichItem

parseJSONList :: Value -> Parser [RichItem]

Show RichItem

Defined in Web.Slack.Experimental.Blocks.Types

Methods

showsPrec :: Int -> RichItem -> ShowS

show :: RichItem -> String

showList :: [RichItem] -> ShowS

Eq RichItem

Defined in Web.Slack.Experimental.Blocks.Types

Methods

(==) :: RichItem -> RichItem -> Bool

(/=) :: RichItem -> RichItem -> Bool

data RichStyle

A rich text style. You can't actually send these, for some reason.

Constructors

RichStyle

Fields

• rsBold :: Bool
• rsItalic :: Bool

Instances

FromJSON RichStyle

Defined in Web.Slack.Experimental.Blocks.Types

Methods

parseJSON :: Value -> Parser RichStyle

parseJSONList :: Value -> Parser [RichStyle]

Monoid RichStyle

Defined in Web.Slack.Experimental.Blocks.Types

Methods

mempty :: RichStyle

mappend :: RichStyle -> RichStyle -> RichStyle

mconcat :: [RichStyle] -> RichStyle

Semigroup RichStyle

Defined in Web.Slack.Experimental.Blocks.Types

Methods

(<>) :: RichStyle -> RichStyle -> RichStyle

sconcat :: NonEmpty RichStyle -> RichStyle

stimes :: Integral b => b -> RichStyle -> RichStyle

Show RichStyle

Defined in Web.Slack.Experimental.Blocks.Types

Methods

showsPrec :: Int -> RichStyle -> ShowS

show :: RichStyle -> String

showList :: [RichStyle] -> ShowS

Eq RichStyle

Defined in Web.Slack.Experimental.Blocks.Types

Methods

(==) :: RichStyle -> RichStyle -> Bool

(/=) :: RichStyle -> RichStyle -> Bool

data RichLinkAttrs

Constructors

RichLinkAttrs

Fields

• style :: RichStyle
• url :: Text
• text :: Maybe Text

  Probably is empty in the case of links that are just the URL

Instances

Show RichLinkAttrs

Defined in Web.Slack.Experimental.Blocks.Types

Methods

showsPrec :: Int -> RichLinkAttrs -> ShowS

show :: RichLinkAttrs -> String

showList :: [RichLinkAttrs] -> ShowS

Eq RichLinkAttrs

Defined in Web.Slack.Experimental.Blocks.Types

Methods

(==) :: RichLinkAttrs -> RichLinkAttrs -> Bool

(/=) :: RichLinkAttrs -> RichLinkAttrs -> Bool

data RichTextSectionItem

Constructors

RichTextSectionItemRichText [RichItem]

RichTextSectionItemUnknown Text Value

Instances

FromJSON RichTextSectionItem

Defined in Web.Slack.Experimental.Blocks.Types

Methods

parseJSON :: Value -> Parser RichTextSectionItem

parseJSONList :: Value -> Parser [RichTextSectionItem]

Show RichTextSectionItem

Defined in Web.Slack.Experimental.Blocks.Types

Methods

showsPrec :: Int -> RichTextSectionItem -> ShowS

show :: RichTextSectionItem -> String

showList :: [RichTextSectionItem] -> ShowS

Eq RichTextSectionItem

Defined in Web.Slack.Experimental.Blocks.Types

Methods

(==) :: RichTextSectionItem -> RichTextSectionItem -> Bool

(/=) :: RichTextSectionItem -> RichTextSectionItem -> Bool

data RichText

Constructors

RichText

Fields

• blockId :: Maybe SlackBlockId
• elements :: [RichTextSectionItem]

Instances

FromJSON RichText

Defined in Web.Slack.Experimental.Blocks.Types

Methods

parseJSON :: Value -> Parser RichText

parseJSONList :: Value -> Parser [RichText]

Show RichText

Defined in Web.Slack.Experimental.Blocks.Types

Methods

showsPrec :: Int -> RichText -> ShowS

show :: RichText -> String

showList :: [RichText] -> ShowS

Eq RichText

Defined in Web.Slack.Experimental.Blocks.Types

Methods

(==) :: RichText -> RichText -> Bool

(/=) :: RichText -> RichText -> Bool

Rendered messages

data RenderedSlackMessage

RenderedSlackMessage contains the original SlackMessage, the rendered version, and a boolean indicating whether truncation was done.

Usage:

     let
       msg =
       (mkPostMsgReq channel "")
         { postMsgReqBlocks = Just blocks
         , postMsgReqThreadTs = mThreadTs
         }
   chatPostMessage msg
  

Constructors

RenderedSlackMessage

Fields

• _originalMessage :: SlackMessage
• _renderedMessage :: Text
• _truncated :: Bool

render :: SlackMessage -> RenderedSlackMessage

Introduction to Slack Interactive Messages

Slack Interactive Messages

First, familiarize yourself with Slack's Interactivity documentation. Currently we only support Block Kit interactive components, i.e. components like buttons attached to messages.

To make an Slack message interactive, you need to include an "Actions" block that has one or more interactive components. These should generally only be created using the builder functions such as actions and button. Consumers of this module should avoid directly importing Web.Slack.Experimental.Blocks.Types.

Creating Slack Interactive Messages

actions :: ToSlackActionList as => as -> SlackMessage

Generates interactive components such as buttons.

actionsWithBlockId :: ToSlackActionList as => SlackBlockId -> as -> SlackMessage

Generates interactive components such as buttons with a SlackBlockId.

newtype SlackActionId

Used to identify an action. The ID used should be unique among all actions in the block.

This is limited to 255 characters, per the Slack documentation at https://api.slack.com/reference/block-kit/block-elements#button

Constructors

SlackActionId

Fields

• unSlackActionId :: NonEmptyText 255

Instances

FromJSON SlackActionId

Defined in Web.Slack.Experimental.Blocks.Types

Methods

parseJSON :: Value -> Parser SlackActionId

parseJSONList :: Value -> Parser [SlackActionId]

ToJSON SlackActionId

Defined in Web.Slack.Experimental.Blocks.Types

Methods

toJSON :: SlackActionId -> Value

toEncoding :: SlackActionId -> Encoding

toJSONList :: [SlackActionId] -> Value

toEncodingList :: [SlackActionId] -> Encoding

Show SlackActionId

Defined in Web.Slack.Experimental.Blocks.Types

Methods

showsPrec :: Int -> SlackActionId -> ShowS

show :: SlackActionId -> String

showList :: [SlackActionId] -> ShowS

Eq SlackActionId

Defined in Web.Slack.Experimental.Blocks.Types

Methods

(==) :: SlackActionId -> SlackActionId -> Bool

(/=) :: SlackActionId -> SlackActionId -> Bool

type SlackBlockId = NonEmptyText 255

SlackBlockId should be unique for each message and each iteration of a message. If a message is updated, use a new block_id.

setting :: a -> OptionalSetting a

Sets a setting.

emptySetting :: OptionalSetting a

Sets the empty setting.

data SlackStyle

Styles for Slack buttons. If no style is given, the default style (black) is used.

Constructors

SlackStylePrimary

Green button

SlackStyleDanger

Red button

Instances

FromJSON SlackStyle

Defined in Web.Slack.Experimental.Blocks.Types

Methods

parseJSON :: Value -> Parser SlackStyle

parseJSONList :: Value -> Parser [SlackStyle]

ToJSON SlackStyle

Defined in Web.Slack.Experimental.Blocks.Types

Methods

toJSON :: SlackStyle -> Value

toEncoding :: SlackStyle -> Encoding

toJSONList :: [SlackStyle] -> Value

toEncodingList :: [SlackStyle] -> Encoding

Show SlackStyle

Defined in Web.Slack.Experimental.Blocks.Types

Methods

showsPrec :: Int -> SlackStyle -> ShowS

show :: SlackStyle -> String

showList :: [SlackStyle] -> ShowS

Eq SlackStyle

Defined in Web.Slack.Experimental.Blocks.Types

Methods

(==) :: SlackStyle -> SlackStyle -> Bool

(/=) :: SlackStyle -> SlackStyle -> Bool

plaintext :: Slack a => a -> SlackTextObject

Create a plain text SlackTextObject where the API allows either markdown or plain text.

plaintextonly :: Slack a => a -> SlackPlainTextOnly

Create a SlackPlainTextOnly. Some API points can can take either markdown or plain text, but some can take only plain text. This enforces the latter.

mrkdwn :: Slack a => a -> SlackTextObject

Create a markdown SlackTextObject where the API allows either markdown or plain text.

button :: SlackActionId -> SlackButtonText -> ButtonSettings -> SlackAction

Button builder.

buttonSettings :: ButtonSettings

Default button settings.

data ButtonSettings

Settings for button elements.

confirm :: ConfirmSettings -> SlackConfirmObject

Confirm dialog builder.

confirmAreYouSure :: ConfirmSettings

Default settings for a "Are you sure?" confirmation dialog.

data ConfirmSettings

Settings for confirmation dialog objects.

Responding to Slack Interactive Messages

data SlackInteractiveResponse

Type of message to send in response to an interactive webhook. See Slack's Handling user interaction in your Slack apps for a description of these fieldds.

Constructors

SlackInteractiveResponse SlackMessage

Respond with a new message.

Ephemeral SlackMessage

Respond with a message that only the interacting user can usee.

ReplaceOriginal SlackMessage

Replace the original message.

DeleteOriginal

Delete the original message.

Instances

ToJSON SlackInteractiveResponse

Defined in Web.Slack.Experimental.Blocks.Types

Methods

toJSON :: SlackInteractiveResponse -> Value

toEncoding :: SlackInteractiveResponse -> Encoding

toJSONList :: [SlackInteractiveResponse] -> Value

toEncodingList :: [SlackInteractiveResponse] -> Encoding

Show SlackInteractiveResponse

Defined in Web.Slack.Experimental.Blocks.Types

Methods

showsPrec :: Int -> SlackInteractiveResponse -> ShowS

show :: SlackInteractiveResponse -> String

showList :: [SlackInteractiveResponse] -> ShowS