Web.Slack.Types.Message

Documentation

data MessagePayload

Constructors

MessagePayload

Fields

• messageId :: Int
• messageType :: Text
• messageChannel :: ChannelId
• messageText :: Text

Instances

Show MessagePayload

Methods

showsPrec :: Int -> MessagePayload -> ShowS

show :: MessagePayload -> String

showList :: [MessagePayload] -> ShowS

ToJSON MessagePayload

Methods

toJSON :: MessagePayload -> Value

toEncoding :: MessagePayload -> Encoding

toJSONList :: [MessagePayload] -> Value

toEncodingList :: [MessagePayload] -> Encoding

data PingPayload

Constructors

PingPayload

Fields

• pingId :: Int
• pingType :: Text
• pingTimestamp :: Int

Instances

Show PingPayload

Methods

showsPrec :: Int -> PingPayload -> ShowS

show :: PingPayload -> String

showList :: [PingPayload] -> ShowS

ToJSON PingPayload

Methods

toJSON :: PingPayload -> Value

toEncoding :: PingPayload -> Encoding

toJSONList :: [PingPayload] -> Value

toEncodingList :: [PingPayload] -> Encoding

data Attachment

Constructors

Attachment

Fields

• attachmentFallback :: Text

  A plain-text summary of the attachment.

• attachmentColor :: AttachmentColor

  Used to color the border along the left side of the message attachment.

• attachmentPretext :: Maybe Text

  Optional text that appears above the message attachment block.

• attachmentAuthorName :: Maybe Text

  Small text used to display the author's name.

• attachmentAuthorLink :: Maybe URL

  A valid URL that will hyperlink the author_name text mentioned above.

• attachmentAuthorIcon :: Maybe URL

  A valid URL that displays a small 16x16px image to the left of the author_name text.

• attachmentTitle :: Maybe Text

  The title is displayed as larger, bold text near the top of a message attachment.

• attachmentTitleLink :: Maybe URL

  By passing a valid URL, the title text will be hyperlinked.

• attachmentText :: Maybe Text

  This is the main text in a message attachment, and can contain standard message markup.

• attachmentFields :: [Field]
• attachmentImageUrl :: Maybe URL

  An image file that will be displayed inside a message attachment. GIF, JPEG, PNG, or BMP; scaled down to 400x500px.

• attachmentThumbUrl :: Maybe URL

  Displayed as a thumbnail on the right side of a message attachment. GIF, JPEG, PNG, or BMP; scaled down to 75x75px.

• attachmentFooter :: Maybe Text

  Add some brief text to help contextualize and identify an attachment.

• attachmentFooterIcon :: Maybe URL

  Render a small icon beside your footer text. Scaled to 16x16px.

• attachmentTs :: Maybe POSIXTime

  Display an additional timestamp value as part of the attachment's footer.

Instances

ToJSON Attachment

Methods

toJSON :: Attachment -> Value

toEncoding :: Attachment -> Encoding

toJSONList :: [Attachment] -> Value

toEncodingList :: [Attachment] -> Encoding

data Field

Constructors

Field

Fields

• fieldTitle :: Maybe Text

  Shown as a bold heading above the value text. It cannot contain markup and will be escaped for you.

• fieldValue :: Text

  The text value of the field. It may contain standard message markup and must be escaped as normal. May be multi-line.

• fieldShort :: Bool

  Whether the value is short enough to be displayed side-by-side with other values.

Instances

ToJSON Field

Methods

toJSON :: Field -> Value

toEncoding :: Field -> Encoding

toJSONList :: [Field] -> Value

toEncodingList :: [Field] -> Encoding

data AttachmentColor

Constructors

DefaultColor

GoodColor

WarningColor

DangerColor

CustomColor Text

Instances

Generic AttachmentColor

Associated Types

type Rep AttachmentColor :: * -> *

Methods

from :: AttachmentColor -> Rep AttachmentColor x

to :: Rep AttachmentColor x -> AttachmentColor

ToJSON AttachmentColor

Methods

toJSON :: AttachmentColor -> Value

toEncoding :: AttachmentColor -> Encoding

toJSONList :: [AttachmentColor] -> Value

toEncodingList :: [AttachmentColor] -> Encoding

type Rep AttachmentColor

type Rep AttachmentColor = D1 (MetaData "AttachmentColor" "Web.Slack.Types.Message" "slack-api-0.12-5bXjjbyGgxpG4YrpslwyQ6" False) ((:+:) ((:+:) (C1 (MetaCons "DefaultColor" PrefixI False) U1) (C1 (MetaCons "GoodColor" PrefixI False) U1)) ((:+:) (C1 (MetaCons "WarningColor" PrefixI False) U1) ((:+:) (C1 (MetaCons "DangerColor" PrefixI False) U1) (C1 (MetaCons "CustomColor" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))))))

defaultAttachment :: Attachment