Safe Haskell	None
Language	Haskell2010

Calamity.Types.Model.Channel.Embed

Description

Message embeds

Synopsis

data Embed = Embed {
- title :: Maybe Text
- type_ :: Maybe Text
- description :: Maybe Text
- url :: Maybe Text
- timestamp :: Maybe UTCTime
- color :: Maybe (Colour Double)
- footer :: Maybe EmbedFooter
- image :: Maybe EmbedImage
- thumbnail :: Maybe EmbedThumbnail
- video :: Maybe EmbedVideo
- provider :: Maybe EmbedProvider
- author :: Maybe EmbedAuthor
- fields :: [EmbedField]
}
embedFooter :: Text -> EmbedFooter
embedImage :: Text -> EmbedImage
embedThumbnail :: Text -> EmbedThumbnail
embedAuthor :: Text -> EmbedAuthor
embedAuthor' :: Text -> Text -> Text -> EmbedAuthor
embedField :: Text -> Text -> EmbedField
data EmbedFooter = EmbedFooter {
- text :: Text
- iconUrl :: Maybe Text
- proxyIconUrl :: Maybe Text
}
data EmbedImage = EmbedImage {
- url :: Text
- proxyUrl :: Maybe Text
- width :: Maybe Word64
- height :: Maybe Word64
}
data EmbedThumbnail = EmbedThumbnail {
- url :: Text
- proxyUrl :: Maybe Text
- width :: Maybe Word64
- height :: Maybe Word64
}
data EmbedVideo = EmbedVideo {
- url :: Maybe Text
- proxyUrl :: Maybe Text
- width :: Maybe Word64
- height :: Maybe Word64
}
data EmbedProvider = EmbedProvider {
- name :: Maybe Text
- url :: Maybe Text
}
data EmbedAuthor = EmbedAuthor {
- name :: Maybe Text
- url :: Maybe Text
- iconUrl :: Maybe Text
- proxyIconURL :: Maybe Text
}
data EmbedField = EmbedField {
- name :: Text
- value :: Text
- inline :: Bool
}

Documentation

data Embed Source #

Constructors

Embed
Fields title :: Maybe Text type_ :: Maybe Text description :: Maybe Text url :: Maybe Text timestamp :: Maybe UTCTime color :: Maybe (Colour Double) footer :: Maybe EmbedFooter image :: Maybe EmbedImage thumbnail :: Maybe EmbedThumbnail video :: Maybe EmbedVideo provider :: Maybe EmbedProvider author :: Maybe EmbedAuthor fields :: [EmbedField]

Instances

Instances details

Eq Embed Source #
Instance details Defined in Calamity.Types.Model.Channel.Embed Methods (==) :: Embed -> Embed -> Bool # (/=) :: Embed -> Embed -> Bool #
Show Embed Source #
Instance details Defined in Calamity.Types.Model.Channel.Embed Methods showsPrec :: Int -> Embed -> ShowS # show :: Embed -> String # showList :: [Embed] -> ShowS #
Generic Embed Source #
Instance details Defined in Calamity.Types.Model.Channel.Embed Associated Types type Rep Embed :: Type -> Type # Methods from :: Embed -> Rep Embed x # to :: Rep Embed x -> Embed #
Semigroup Embed Source #
Instance details Defined in Calamity.Types.Model.Channel.Embed Methods (<>) :: Embed -> Embed -> Embed # sconcat :: NonEmpty Embed -> Embed # stimes :: Integral b => b -> Embed -> Embed #
Monoid Embed Source #
Instance details Defined in Calamity.Types.Model.Channel.Embed Methods mempty :: Embed # mappend :: Embed -> Embed -> Embed # mconcat :: [Embed] -> Embed #
ToJSON Embed Source #
Instance details Defined in Calamity.Types.Model.Channel.Embed Methods toJSON :: Embed -> Value # toEncoding :: Embed -> Encoding # toJSONList :: [Embed] -> Value # toEncodingList :: [Embed] -> Encoding #
FromJSON Embed Source #
Instance details Defined in Calamity.Types.Model.Channel.Embed Methods parseJSON :: Value -> Parser Embed # parseJSONList :: Value -> Parser [Embed] #
Default Embed Source #
Instance details Defined in Calamity.Types.Model.Channel.Embed Methods def :: Embed #
TextShow Embed Source #
Instance details Defined in Calamity.Types.Model.Channel.Embed Methods showbPrec :: Int -> Embed -> Builder # showb :: Embed -> Builder # showbList :: [Embed] -> Builder # showtPrec :: Int -> Embed -> Text # showt :: Embed -> Text # showtList :: [Embed] -> Text # showtlPrec :: Int -> Embed -> Text # showtl :: Embed -> Text # showtlList :: [Embed] -> Text #
ToMessage Embed Source #	Message embed, `(<>)` appends a new embed
Instance details Defined in Calamity.Types.Tellable Methods intoMsg :: Embed -> Endo CreateMessageOptions Source #
type Rep Embed Source #
Instance details Defined in Calamity.Types.Model.Channel.Embed type Rep Embed = D1 ('MetaData "Embed" "Calamity.Types.Model.Channel.Embed" "calamity-0.3.0.0-inplace" 'False) (C1 ('MetaCons "Embed" 'PrefixI 'True) (((S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "type_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "timestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UTCTime)) :: S1 ('MetaSel ('Just "color") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Colour Double)))))) :: ((S1 ('MetaSel ('Just "footer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EmbedFooter)) :: (S1 ('MetaSel ('Just "image") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EmbedImage)) :: S1 ('MetaSel ('Just "thumbnail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EmbedThumbnail)))) :: ((S1 ('MetaSel ('Just "video") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EmbedVideo)) :: S1 ('MetaSel ('Just "provider") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EmbedProvider))) :: (S1 ('MetaSel ('Just "author") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EmbedAuthor)) :: S1 ('MetaSel ('Just "fields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [EmbedField]))))))

embedFooter :: Text -> EmbedFooter Source #

Create an embed footer with a provided content