Safe Haskell	Safe-Inferred
Language	Haskell2010

Web.Slack.Experimental.Blocks.Types

Synopsis

class Slack a where
- message :: a -> SlackText
newtype SlackText = SlackText {
- unSlackTexts :: [Text]
}
link :: Text -> Maybe Text -> SlackText
data SlackPlainTextOnly = SlackPlainTextOnly SlackText
plaintextonly :: Slack a => a -> SlackPlainTextOnly
data SlackTextObject
- = SlackPlainText SlackText
- | SlackMarkdownText SlackText
plaintext :: Slack a => a -> SlackTextObject
mrkdwn :: Slack a => a -> SlackTextObject
newtype OptionalSetting a = OptionalSetting {
- unOptionalSetting :: Maybe a
}
setting :: a -> OptionalSetting a
emptySetting :: OptionalSetting a
data SlackStyle
- = SlackStylePrimary
- | SlackStyleDanger
newtype SlackActionId = SlackActionId {
- unSlackActionId :: NonEmptyText 255
}
data SlackImage = SlackImage {
- slackImageTitle :: !(Maybe Text)
- slackImageAltText :: !Text
- slackImageUrl :: !Text
}
data SlackContent
- = SlackContentText SlackText
- | SlackContentImage SlackImage
newtype SlackContext = SlackContext [SlackContent]
type SlackActionListConstraints = SizeGreaterThan 0 && SizeLessThan 6
newtype SlackActionList = SlackActionList {
- unSlackActionList :: Refined SlackActionListConstraints [SlackAction]
}
class ToSlackActionList a where
- toSlackActionList :: a -> SlackActionList
data RichStyle = RichStyle {
- rsBold :: Bool
- rsItalic :: Bool
}
data RichLinkAttrs = RichLinkAttrs {
- style :: RichStyle
- url :: Text
- text :: Maybe Text
}
data RichItem
- = RichItemText Text RichStyle
- | RichItemChannel ConversationId
- | RichItemUser UserId RichStyle
- | RichItemLink RichLinkAttrs
- | RichItemEmoji Text
- | RichItemOther Text Value
data RichTextSectionItem
- = RichTextSectionItemRichText [RichItem]
- | RichTextSectionItemUnknown Text Value
data RichText = RichText {
- blockId :: Maybe SlackBlockId
- elements :: [RichTextSectionItem]
}
data SlackAccessory = SlackButtonAccessory SlackAction
sectionWithButtonAccessory :: SlackAction -> SlackText -> SlackBlock
data SlackBlock
- = SlackBlockSection SlackText (Maybe SlackAccessory)
- | SlackBlockImage SlackImage
- | SlackBlockContext SlackContext
- | SlackBlockDivider
- | SlackBlockRichText RichText
- | SlackBlockActions (Maybe SlackBlockId) SlackActionList
- | SlackBlockHeader SlackPlainTextOnly
newtype SlackMessage = SlackMessage [SlackBlock]
textToMessage :: Text -> SlackMessage
class Markdown a where
- markdown :: SlackText -> a
class Image a where
- image :: SlackImage -> a
context :: SlackContext -> SlackMessage
textToContext :: Text -> SlackMessage
actions :: ToSlackActionList as => as -> SlackMessage
actionsWithBlockId :: ToSlackActionList as => SlackBlockId -> as -> SlackMessage
data ButtonSettings = ButtonSettings {
- buttonUrl :: OptionalSetting (NonEmptyText 3000)
- buttonValue :: OptionalSetting (NonEmptyText 2000)
- buttonStyle :: OptionalSetting SlackStyle
- buttonConfirm :: OptionalSetting SlackConfirmObject
}
buttonSettings :: ButtonSettings
button :: SlackActionId -> SlackButtonText -> ButtonSettings -> SlackAction
data ConfirmSettings = ConfirmSettings {
- confirmTitle :: Text
- confirmText :: Text
- confirmConfirm :: Text
- confirmDeny :: Text
- confirmStyle :: OptionalSetting SlackStyle
}
confirmAreYouSure :: ConfirmSettings
confirm :: ConfirmSettings -> SlackConfirmObject
type SlackBlockId = NonEmptyText 255
data SlackAction = SlackAction SlackActionId SlackActionComponent
data SlackConfirmObject = SlackConfirmObject {
- slackConfirmTitle :: SlackPlainTextOnly
- slackConfirmText :: SlackTextObject
- slackConfirmConfirm :: SlackPlainTextOnly
- slackConfirmDeny :: SlackPlainTextOnly
- slackConfirmStyle :: Maybe SlackStyle
}
newtype SlackResponseUrl = SlackResponseUrl {
- unSlackResponseUrl :: Text
}
data SlackInteractivePayload = SlackInteractivePayload {
- sipUserId :: Text
- sipUsername :: Text
- sipName :: Text
- sipResponseUrl :: Maybe SlackResponseUrl
- sipTriggerId :: Maybe Text
- sipActions :: [SlackActionResponse]
}
data SlackActionResponse = SlackActionResponse {
- sarBlockId :: SlackBlockId
- sarActionId :: SlackActionId
- sarActionComponent :: SlackActionComponent
}
data SlackInteractiveResponseResponse = SlackInteractiveResponseResponse {
- unSlackInteractiveResponseResponse :: Bool
}
data SlackInteractiveResponse
- = SlackInteractiveResponse SlackMessage
- | Ephemeral SlackMessage
- | ReplaceOriginal SlackMessage
- | DeleteOriginal
newtype SlackButtonText = SlackButtonText (NonEmptyText 75)
data SlackActionComponent = SlackButton {
- slackButtonText :: SlackButtonText
- slackButtonUrl :: Maybe (NonEmptyText 3000)
- slackButtonValue :: Maybe (NonEmptyText 2000)
- slackButtonStyle :: Maybe SlackStyle
- slackButtonConfirm :: Maybe SlackConfirmObject
}

Documentation

class Slack a where Source #

Class of types that can be turned into part of a Slack Message. message is the primary way of converting primitive and domain-level types into things that can be shown in a slack message.

Methods

message :: a -> SlackText Source #

Instances

Instances details

Slack SlackButtonText Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods message :: SlackButtonText -> SlackText Source #
Slack Text Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods message :: Text -> SlackText Source #
Slack String Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods message :: String -> SlackText Source #
Slack Int Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods message :: Int -> SlackText Source #

newtype SlackText Source #

Constructors

SlackText
Fields unSlackTexts :: [Text]

Instances

Instances details

ToJSON SlackText Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods toJSON :: SlackText -> Value # toEncoding :: SlackText -> Encoding # toJSONList :: [SlackText] -> Value # toEncodingList :: [SlackText] -> Encoding #
IsString SlackText Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods fromString :: String -> SlackText #
Monoid SlackText Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods mempty :: SlackText # mappend :: SlackText -> SlackText -> SlackText # mconcat :: [SlackText] -> SlackText #
Semigroup SlackText Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods (<>) :: SlackText -> SlackText -> SlackText # sconcat :: NonEmpty SlackText -> SlackText # stimes :: Integral b => b -> SlackText -> SlackText #
Show SlackText Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods showsPrec :: Int -> SlackText -> ShowS # show :: SlackText -> String # showList :: [SlackText] -> ShowS #
Eq SlackText Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods (==) :: SlackText -> SlackText -> Bool # (/=) :: SlackText -> SlackText -> Bool #

link :: Text -> Maybe Text -> SlackText Source #

Render a link with optional link text

data SlackPlainTextOnly Source #

Constructors

SlackPlainTextOnly SlackText

Instances

Instances details

FromJSON SlackPlainTextOnly Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods parseJSON :: Value -> Parser SlackPlainTextOnly # parseJSONList :: Value -> Parser [SlackPlainTextOnly] #
ToJSON SlackPlainTextOnly Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods toJSON :: SlackPlainTextOnly -> Value # toEncoding :: SlackPlainTextOnly -> Encoding # toJSONList :: [SlackPlainTextOnly] -> Value # toEncodingList :: [SlackPlainTextOnly] -> Encoding #
IsString SlackPlainTextOnly Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods fromString :: String -> SlackPlainTextOnly #
Show SlackPlainTextOnly Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods showsPrec :: Int -> SlackPlainTextOnly -> ShowS # show :: SlackPlainTextOnly -> String # showList :: [SlackPlainTextOnly] -> ShowS #
Eq SlackPlainTextOnly Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods (==) :: SlackPlainTextOnly -> SlackPlainTextOnly -> Bool # (/=) :: SlackPlainTextOnly -> SlackPlainTextOnly -> Bool #

plaintextonly :: Slack a => a -> SlackPlainTextOnly Source #

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.

data SlackTextObject Source #

Constructors

SlackPlainText SlackText
SlackMarkdownText SlackText

Instances

Instances details

FromJSON SlackTextObject Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods parseJSON :: Value -> Parser SlackTextObject # parseJSONList :: Value -> Parser [SlackTextObject] #
ToJSON SlackTextObject Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods toJSON :: SlackTextObject -> Value # toEncoding :: SlackTextObject -> Encoding # toJSONList :: [SlackTextObject] -> Value # toEncodingList :: [SlackTextObject] -> Encoding #
Show SlackTextObject Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods showsPrec :: Int -> SlackTextObject -> ShowS # show :: SlackTextObject -> String # showList :: [SlackTextObject] -> ShowS #
Eq SlackTextObject Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods (==) :: SlackTextObject -> SlackTextObject -> Bool # (/=) :: SlackTextObject -> SlackTextObject -> Bool #

plaintext :: Slack a => a -> SlackTextObject Source #

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

mrkdwn :: Slack a => a -> SlackTextObject Source #

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

newtype OptionalSetting a Source #

Represents an optional setting for some Slack Setting.

Constructors

OptionalSetting
Fields unOptionalSetting :: Maybe a

Instances

Instances details

IsString (OptionalSetting Text) Source #	Allows using bare Texts without having to use `setting`
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods fromString :: String -> OptionalSetting Text #
IsString (OptionalSetting String) Source #	Allows using bare Strings without having to use `setting`
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods fromString :: String -> OptionalSetting String #
Eq a => Eq (OptionalSetting a) Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods (==) :: OptionalSetting a -> OptionalSetting a -> Bool # (/=) :: OptionalSetting a -> OptionalSetting a -> Bool #

setting :: a -> OptionalSetting a Source #

Sets a setting.

emptySetting :: OptionalSetting a Source #

Sets the empty setting.

data SlackStyle Source #

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

Constructors

SlackStylePrimary	Green button
SlackStyleDanger	Red button

Instances

Instances details

FromJSON SlackStyle Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods parseJSON :: Value -> Parser SlackStyle # parseJSONList :: Value -> Parser [SlackStyle] #
ToJSON SlackStyle Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods toJSON :: SlackStyle -> Value # toEncoding :: SlackStyle -> Encoding # toJSONList :: [SlackStyle] -> Value # toEncodingList :: [SlackStyle] -> Encoding #
Show SlackStyle Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods showsPrec :: Int -> SlackStyle -> ShowS # show :: SlackStyle -> String # showList :: [SlackStyle] -> ShowS #
Eq SlackStyle Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods (==) :: SlackStyle -> SlackStyle -> Bool # (/=) :: SlackStyle -> SlackStyle -> Bool #

newtype SlackActionId Source #

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

Instances details

FromJSON SlackActionId Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods parseJSON :: Value -> Parser SlackActionId # parseJSONList :: Value -> Parser [SlackActionId] #
ToJSON SlackActionId Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods toJSON :: SlackActionId -> Value # toEncoding :: SlackActionId -> Encoding # toJSONList :: [SlackActionId] -> Value # toEncodingList :: [SlackActionId] -> Encoding #
Show SlackActionId Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods showsPrec :: Int -> SlackActionId -> ShowS # show :: SlackActionId -> String # showList :: [SlackActionId] -> ShowS #
Eq SlackActionId Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods (==) :: SlackActionId -> SlackActionId -> Bool # (/=) :: SlackActionId -> SlackActionId -> Bool #

data SlackImage Source #

Constructors

SlackImage
Fields slackImageTitle :: !(Maybe Text) slackImageAltText :: !Text Optional Title slackImageUrl :: !Text

Instances

Instances details

Show SlackImage Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods showsPrec :: Int -> SlackImage -> ShowS # show :: SlackImage -> String # showList :: [SlackImage] -> ShowS #
Eq SlackImage Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods (==) :: SlackImage -> SlackImage -> Bool # (/=) :: SlackImage -> SlackImage -> Bool #

data SlackContent Source #

Constructors

SlackContentText SlackText
SlackContentImage SlackImage

Instances

Instances details

FromJSON SlackContent Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods parseJSON :: Value -> Parser SlackContent # parseJSONList :: Value -> Parser [SlackContent] #
ToJSON SlackContent Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods toJSON :: SlackContent -> Value # toEncoding :: SlackContent -> Encoding # toJSONList :: [SlackContent] -> Value # toEncodingList :: [SlackContent] -> Encoding #
Show SlackContent Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods showsPrec :: Int -> SlackContent -> ShowS # show :: SlackContent -> String # showList :: [SlackContent] -> ShowS #
Eq SlackContent Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods (==) :: SlackContent -> SlackContent -> Bool # (/=) :: SlackContent -> SlackContent -> Bool #

newtype SlackContext Source #

Constructors

SlackContext [SlackContent]

Instances

Instances details

FromJSON SlackContext Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods parseJSON :: Value -> Parser SlackContext # parseJSONList :: Value -> Parser [SlackContext] #
ToJSON SlackContext Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods toJSON :: SlackContext -> Value # toEncoding :: SlackContext -> Encoding # toJSONList :: [SlackContext] -> Value # toEncodingList :: [SlackContext] -> Encoding #
Monoid SlackContext Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods mempty :: SlackContext # mappend :: SlackContext -> SlackContext -> SlackContext # mconcat :: [SlackContext] -> SlackContext #
Semigroup SlackContext Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods (<>) :: SlackContext -> SlackContext -> SlackContext # sconcat :: NonEmpty SlackContext -> SlackContext # stimes :: Integral b => b -> SlackContext -> SlackContext #
Show SlackContext Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods showsPrec :: Int -> SlackContext -> ShowS # show :: SlackContext -> String # showList :: [SlackContext] -> ShowS #
Eq SlackContext Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods (==) :: SlackContext -> SlackContext -> Bool # (/=) :: SlackContext -> SlackContext -> Bool #
Image SlackContext Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods image :: SlackImage -> SlackContext Source #
Markdown SlackContext Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods markdown :: SlackText -> SlackContext Source #

type SlackActionListConstraints = SizeGreaterThan 0 && SizeLessThan 6 Source #

newtype SlackActionList Source #

List that enforces that Slack actions must have between 1 and 5 actions.

Constructors

SlackActionList
Fields unSlackActionList :: Refined SlackActionListConstraints [SlackAction]

Instances

Instances details

FromJSON SlackActionList Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods parseJSON :: Value -> Parser SlackActionList # parseJSONList :: Value -> Parser [SlackActionList] #
ToJSON SlackActionList Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods toJSON :: SlackActionList -> Value # toEncoding :: SlackActionList -> Encoding # toJSONList :: [SlackActionList] -> Value # toEncodingList :: [SlackActionList] -> Encoding #
Show SlackActionList Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods showsPrec :: Int -> SlackActionList -> ShowS # show :: SlackActionList -> String # showList :: [SlackActionList] -> ShowS #
Eq SlackActionList Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods (==) :: SlackActionList -> SlackActionList -> Bool # (/=) :: SlackActionList -> SlackActionList -> Bool #
ToSlackActionList SlackActionList Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods toSlackActionList :: SlackActionList -> SlackActionList Source #

class ToSlackActionList a where Source #

Helper to allow using up to a 5-tuple for a SlackActionList

Methods

toSlackActionList :: a -> SlackActionList Source #

Instances

Instances details

ToSlackActionList SlackAction Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods toSlackActionList :: SlackAction -> SlackActionList Source #
ToSlackActionList SlackActionList Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods toSlackActionList :: SlackActionList -> SlackActionList Source #
ToSlackActionList (SlackAction, SlackAction) Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods toSlackActionList :: (SlackAction, SlackAction) -> SlackActionList Source #
ToSlackActionList (SlackAction, SlackAction, SlackAction) Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods toSlackActionList :: (SlackAction, SlackAction, SlackAction) -> SlackActionList Source #
ToSlackActionList (SlackAction, SlackAction, SlackAction, SlackAction) Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods toSlackActionList :: (SlackAction, SlackAction, SlackAction, SlackAction) -> SlackActionList Source #
ToSlackActionList (SlackAction, SlackAction, SlackAction, SlackAction, SlackAction) Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods toSlackActionList :: (SlackAction, SlackAction, SlackAction, SlackAction, SlackAction) -> SlackActionList Source #

data RichStyle Source #

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

Constructors

RichStyle
Fields rsBold :: Bool rsItalic :: Bool

Instances

Instances details

FromJSON RichStyle Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods parseJSON :: Value -> Parser RichStyle # parseJSONList :: Value -> Parser [RichStyle] #
Monoid RichStyle Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods mempty :: RichStyle # mappend :: RichStyle -> RichStyle -> RichStyle # mconcat :: [RichStyle] -> RichStyle #
Semigroup RichStyle Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods (<>) :: RichStyle -> RichStyle -> RichStyle # sconcat :: NonEmpty RichStyle -> RichStyle # stimes :: Integral b => b -> RichStyle -> RichStyle #
Show RichStyle Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods showsPrec :: Int -> RichStyle -> ShowS # show :: RichStyle -> String # showList :: [RichStyle] -> ShowS #
Eq RichStyle Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods (==) :: RichStyle -> RichStyle -> Bool # (/=) :: RichStyle -> RichStyle -> Bool #

data RichLinkAttrs Source #

Constructors

RichLinkAttrs
Fields style :: RichStyle url :: Text text :: Maybe Text Probably is empty in the case of links that are just the URL

Instances

Instances details

Show RichLinkAttrs Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods showsPrec :: Int -> RichLinkAttrs -> ShowS # show :: RichLinkAttrs -> String # showList :: [RichLinkAttrs] -> ShowS #
Eq RichLinkAttrs Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods (==) :: RichLinkAttrs -> RichLinkAttrs -> Bool # (/=) :: RichLinkAttrs -> RichLinkAttrs -> Bool #

data RichItem Source #

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

Instances details

FromJSON RichItem Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods parseJSON :: Value -> Parser RichItem # parseJSONList :: Value -> Parser [RichItem] #
Show RichItem Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods showsPrec :: Int -> RichItem -> ShowS # show :: RichItem -> String # showList :: [RichItem] -> ShowS #
Eq RichItem Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods (==) :: RichItem -> RichItem -> Bool # (/=) :: RichItem -> RichItem -> Bool #

data RichTextSectionItem Source #

Constructors

RichTextSectionItemRichText [RichItem]
RichTextSectionItemUnknown Text Value

Instances

Instances details

FromJSON RichTextSectionItem Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods parseJSON :: Value -> Parser RichTextSectionItem # parseJSONList :: Value -> Parser [RichTextSectionItem] #
Show RichTextSectionItem Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods showsPrec :: Int -> RichTextSectionItem -> ShowS # show :: RichTextSectionItem -> String # showList :: [RichTextSectionItem] -> ShowS #
Eq RichTextSectionItem Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods (==) :: RichTextSectionItem -> RichTextSectionItem -> Bool # (/=) :: RichTextSectionItem -> RichTextSectionItem -> Bool #

data RichText Source #

Constructors

RichText
Fields blockId :: Maybe SlackBlockId elements :: [RichTextSectionItem]

Instances

Instances details

FromJSON RichText Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods parseJSON :: Value -> Parser RichText # parseJSONList :: Value -> Parser [RichText] #
Show RichText Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods showsPrec :: Int -> RichText -> ShowS # show :: RichText -> String # showList :: [RichText] -> ShowS #
Eq RichText Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods (==) :: RichText -> RichText -> Bool # (/=) :: RichText -> RichText -> Bool #

data SlackAccessory Source #

Accessory is a type of optional block element that floats to the right of text in a BlockSection. https://api.slack.com/reference/block-kit/blocks#section_fields

Constructors

SlackButtonAccessory SlackAction

Instances

Instances details

FromJSON SlackAccessory Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods parseJSON :: Value -> Parser SlackAccessory # parseJSONList :: Value -> Parser [SlackAccessory] #
ToJSON SlackAccessory Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods toJSON :: SlackAccessory -> Value # toEncoding :: SlackAccessory -> Encoding # toJSONList :: [SlackAccessory] -> Value # toEncodingList :: [SlackAccessory] -> Encoding #
Show SlackAccessory Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods showsPrec :: Int -> SlackAccessory -> ShowS # show :: SlackAccessory -> String # showList :: [SlackAccessory] -> ShowS #
Eq SlackAccessory Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods (==) :: SlackAccessory -> SlackAccessory -> Bool # (/=) :: SlackAccessory -> SlackAccessory -> Bool #

sectionWithButtonAccessory :: SlackAction -> SlackText -> SlackBlock Source #

Small helper function for constructing a section with a button accessory out of a button and text components

data SlackBlock Source #

Constructors

SlackBlockSection SlackText (Maybe SlackAccessory)
SlackBlockImage SlackImage
SlackBlockContext SlackContext
SlackBlockDivider
SlackBlockRichText RichText
SlackBlockActions (Maybe SlackBlockId) SlackActionList
SlackBlockHeader SlackPlainTextOnly

Instances

Instances details

FromJSON SlackBlock Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods parseJSON :: Value -> Parser SlackBlock # parseJSONList :: Value -> Parser [SlackBlock] #
ToJSON SlackBlock Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods toJSON :: SlackBlock -> Value # toEncoding :: SlackBlock -> Encoding # toJSONList :: [SlackBlock] -> Value # toEncodingList :: [SlackBlock] -> Encoding #
Show SlackBlock Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods showsPrec :: Int -> SlackBlock -> ShowS # show :: SlackBlock -> String # showList :: [SlackBlock] -> ShowS #
Eq SlackBlock Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods (==) :: SlackBlock -> SlackBlock -> Bool # (/=) :: SlackBlock -> SlackBlock -> Bool #

newtype SlackMessage Source #

Constructors

SlackMessage [SlackBlock]

Instances

Instances details

FromJSON SlackMessage Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods parseJSON :: Value -> Parser SlackMessage # parseJSONList :: Value -> Parser [SlackMessage] #
ToJSON SlackMessage Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods toJSON :: SlackMessage -> Value # toEncoding :: SlackMessage -> Encoding # toJSONList :: [SlackMessage] -> Value # toEncodingList :: [SlackMessage] -> Encoding #
Monoid SlackMessage Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods mempty :: SlackMessage # mappend :: SlackMessage -> SlackMessage -> SlackMessage # mconcat :: [SlackMessage] -> SlackMessage #
Semigroup SlackMessage Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods (<>) :: SlackMessage -> SlackMessage -> SlackMessage # sconcat :: NonEmpty SlackMessage -> SlackMessage # stimes :: Integral b => b -> SlackMessage -> SlackMessage #
Show SlackMessage Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods showsPrec :: Int -> SlackMessage -> ShowS # show :: SlackMessage -> String # showList :: [SlackMessage] -> ShowS #
Eq SlackMessage Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods (==) :: SlackMessage -> SlackMessage -> Bool # (/=) :: SlackMessage -> SlackMessage -> Bool #
Image SlackMessage Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods image :: SlackImage -> SlackMessage Source #
Markdown SlackMessage Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods markdown :: SlackText -> SlackMessage Source #

textToMessage :: Text -> SlackMessage Source #

class Markdown a where Source #

Methods

markdown :: SlackText -> a Source #

Instances

Instances details

Markdown SlackContext Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods markdown :: SlackText -> SlackContext Source #
Markdown SlackMessage Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods markdown :: SlackText -> SlackMessage Source #

class Image a where Source #

Methods

image :: SlackImage -> a Source #

Instances

Instances details

Image SlackContext Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods image :: SlackImage -> SlackContext Source #
Image SlackMessage Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods image :: SlackImage -> SlackMessage Source #

context :: SlackContext -> SlackMessage Source #

textToContext :: Text -> SlackMessage Source #

actions :: ToSlackActionList as => as -> SlackMessage Source #

Generates interactive components such as buttons.

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

Generates interactive components such as buttons with a SlackBlockId.

data ButtonSettings Source #

Settings for button elements.

Constructors

ButtonSettings

Fields

buttonUrl :: OptionalSetting (NonEmptyText 3000)
Optional URL to load into the user's browser. However, Slack will still call the webhook and you must send an acknowledgement response.
buttonValue :: OptionalSetting (NonEmptyText 2000)
Optional value to send with the interaction payload. One commoon use is to send state via JSON encoding.
buttonStyle :: OptionalSetting SlackStyle
Optional SlackStyle. If not provided, uses the default style which is a black button.
buttonConfirm :: OptionalSetting SlackConfirmObject
An optional confirmation dialog to display.

buttonSettings :: ButtonSettings Source #

Default button settings.

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

Button builder.

data ConfirmSettings Source #

Settings for confirmation dialog objects.

Constructors

ConfirmSettings

Fields

confirmTitle :: Text
Plain text title for the dialog window. Max length 100 characters.
confirmText :: Text
Markdown explanatory text that appears in the confirm dialog. Max length is 300 characters.
confirmConfirm :: Text
Plain text to display in the "confirm" button. Max length is 30 characters.
confirmDeny :: Text
Plain text to display in the "deny" button. Max length is 30 characters.
confirmStyle :: OptionalSetting SlackStyle
Optional SlackStyle to use for the "confirm" button.

confirmAreYouSure :: ConfirmSettings Source #

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

confirm :: ConfirmSettings -> SlackConfirmObject Source #

Confirm dialog builder.

type SlackBlockId = NonEmptyText 255 Source #

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

data SlackAction Source #

All Slack Actions must have a SlackActionId and one SlackActionComponent (such as a button).

Constructors

SlackAction SlackActionId SlackActionComponent

Instances

Instances details

FromJSON SlackAction Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods parseJSON :: Value -> Parser SlackAction # parseJSONList :: Value -> Parser [SlackAction] #
ToJSON SlackAction Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods toJSON :: SlackAction -> Value # toEncoding :: SlackAction -> Encoding # toJSONList :: [SlackAction] -> Value # toEncodingList :: [SlackAction] -> Encoding #
Show SlackAction Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods showsPrec :: Int -> SlackAction -> ShowS # show :: SlackAction -> String # showList :: [SlackAction] -> ShowS #
Eq SlackAction Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods (==) :: SlackAction -> SlackAction -> Bool # (/=) :: SlackAction -> SlackAction -> Bool #
ToSlackActionList SlackAction Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods toSlackActionList :: SlackAction -> SlackActionList Source #
ToSlackActionList (SlackAction, SlackAction) Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods toSlackActionList :: (SlackAction, SlackAction) -> SlackActionList Source #
ToSlackActionList (SlackAction, SlackAction, SlackAction) Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods toSlackActionList :: (SlackAction, SlackAction, SlackAction) -> SlackActionList Source #
ToSlackActionList (SlackAction, SlackAction, SlackAction, SlackAction) Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods toSlackActionList :: (SlackAction, SlackAction, SlackAction, SlackAction) -> SlackActionList Source #
ToSlackActionList (SlackAction, SlackAction, SlackAction, SlackAction, SlackAction) Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods toSlackActionList :: (SlackAction, SlackAction, SlackAction, SlackAction, SlackAction) -> SlackActionList Source #

data SlackConfirmObject Source #

Confirm dialog object.

Constructors

SlackConfirmObject
Fields slackConfirmTitle :: SlackPlainTextOnly slackConfirmText :: SlackTextObject slackConfirmConfirm :: SlackPlainTextOnly slackConfirmDeny :: SlackPlainTextOnly slackConfirmStyle :: Maybe SlackStyle

Instances

Instances details

FromJSON SlackConfirmObject Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods parseJSON :: Value -> Parser SlackConfirmObject # parseJSONList :: Value -> Parser [SlackConfirmObject] #
ToJSON SlackConfirmObject Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods toJSON :: SlackConfirmObject -> Value # toEncoding :: SlackConfirmObject -> Encoding # toJSONList :: [SlackConfirmObject] -> Value # toEncodingList :: [SlackConfirmObject] -> Encoding #
Eq SlackConfirmObject Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods (==) :: SlackConfirmObject -> SlackConfirmObject -> Bool # (/=) :: SlackConfirmObject -> SlackConfirmObject -> Bool #

newtype SlackResponseUrl Source #

Constructors

SlackResponseUrl
Fields unSlackResponseUrl :: Text

Instances

Instances details

FromJSON SlackResponseUrl Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods parseJSON :: Value -> Parser SlackResponseUrl # parseJSONList :: Value -> Parser [SlackResponseUrl] #
ToJSON SlackResponseUrl Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods toJSON :: SlackResponseUrl -> Value # toEncoding :: SlackResponseUrl -> Encoding # toJSONList :: [SlackResponseUrl] -> Value # toEncodingList :: [SlackResponseUrl] -> Encoding #
Show SlackResponseUrl Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods showsPrec :: Int -> SlackResponseUrl -> ShowS # show :: SlackResponseUrl -> String # showList :: [SlackResponseUrl] -> ShowS #
Eq SlackResponseUrl Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods (==) :: SlackResponseUrl -> SlackResponseUrl -> Bool # (/=) :: SlackResponseUrl -> SlackResponseUrl -> Bool #

data SlackInteractivePayload Source #

Represents the data we get from a callback from Slack for interactive operations. See https://api.slack.com/interactivity/handling#payloads

Constructors

SlackInteractivePayload
Fields sipUserId :: Text sipUsername :: Text sipName :: Text sipResponseUrl :: Maybe SlackResponseUrl sipTriggerId :: Maybe Text sipActions :: [SlackActionResponse]

Instances

Instances details

FromJSON SlackInteractivePayload Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods parseJSON :: Value -> Parser SlackInteractivePayload # parseJSONList :: Value -> Parser [SlackInteractivePayload] #
Show SlackInteractivePayload Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods showsPrec :: Int -> SlackInteractivePayload -> ShowS # show :: SlackInteractivePayload -> String # showList :: [SlackInteractivePayload] -> ShowS #

data SlackActionResponse Source #

Which component and it's IDs that triggered an interactive webhook call.

Constructors

SlackActionResponse
Fields sarBlockId :: SlackBlockId sarActionId :: SlackActionId sarActionComponent :: SlackActionComponent

Instances

Instances details

FromJSON SlackActionResponse Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods parseJSON :: Value -> Parser SlackActionResponse # parseJSONList :: Value -> Parser [SlackActionResponse] #
Show SlackActionResponse Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods showsPrec :: Int -> SlackActionResponse -> ShowS # show :: SlackActionResponse -> String # showList :: [SlackActionResponse] -> ShowS #

data SlackInteractiveResponseResponse Source #

Constructors

SlackInteractiveResponseResponse
Fields unSlackInteractiveResponseResponse :: Bool

Instances

Instances details

FromJSON SlackInteractiveResponseResponse Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods parseJSON :: Value -> Parser SlackInteractiveResponseResponse # parseJSONList :: Value -> Parser [SlackInteractiveResponseResponse] #

data SlackInteractiveResponse Source #

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

Instances details

ToJSON SlackInteractiveResponse Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods toJSON :: SlackInteractiveResponse -> Value # toEncoding :: SlackInteractiveResponse -> Encoding # toJSONList :: [SlackInteractiveResponse] -> Value # toEncodingList :: [SlackInteractiveResponse] -> Encoding #
Show SlackInteractiveResponse Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods showsPrec :: Int -> SlackInteractiveResponse -> ShowS # show :: SlackInteractiveResponse -> String # showList :: [SlackInteractiveResponse] -> ShowS #

newtype SlackButtonText Source #

Text to be displayed in a SlackButton. Up to 75 characters, but may be truncated to 30 characters.

Constructors

SlackButtonText (NonEmptyText 75)

Instances

Instances details

FromJSON SlackButtonText Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods parseJSON :: Value -> Parser SlackButtonText # parseJSONList :: Value -> Parser [SlackButtonText] #
IsString SlackButtonText Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods fromString :: String -> SlackButtonText #
Show SlackButtonText Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods showsPrec :: Int -> SlackButtonText -> ShowS # show :: SlackButtonText -> String # showList :: [SlackButtonText] -> ShowS #
Eq SlackButtonText Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods (==) :: SlackButtonText -> SlackButtonText -> Bool # (/=) :: SlackButtonText -> SlackButtonText -> Bool #
Slack SlackButtonText Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods message :: SlackButtonText -> SlackText Source #

data SlackActionComponent Source #

The component in a SlackAction. Do not use directly. Use the builder functions such as button instead.

Constructors

SlackButton
Fields slackButtonText :: SlackButtonText slackButtonUrl :: Maybe (NonEmptyText 3000) slackButtonValue :: Maybe (NonEmptyText 2000) slackButtonStyle :: Maybe SlackStyle slackButtonConfirm :: Maybe SlackConfirmObject

Instances

Instances details

FromJSON SlackActionComponent Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods parseJSON :: Value -> Parser SlackActionComponent # parseJSONList :: Value -> Parser [SlackActionComponent] #
Show SlackActionComponent Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods showsPrec :: Int -> SlackActionComponent -> ShowS # show :: SlackActionComponent -> String # showList :: [SlackActionComponent] -> ShowS #
Eq SlackActionComponent Source #
Instance details Defined in Web.Slack.Experimental.Blocks.Types Methods (==) :: SlackActionComponent -> SlackActionComponent -> Bool # (/=) :: SlackActionComponent -> SlackActionComponent -> Bool #