Safe Haskell	Safe-Inferred
Language	Haskell2010

Discord.Internal.Types.Embed

Description

Data structures pertaining to Discord Embed

Synopsis

createEmbed :: CreateEmbed -> Embed
data CreateEmbed = CreateEmbed {
- createEmbedAuthorName :: Text
- createEmbedAuthorUrl :: Text
- createEmbedAuthorIcon :: Maybe CreateEmbedImage
- createEmbedTitle :: Text
- createEmbedUrl :: Text
- createEmbedThumbnail :: Maybe CreateEmbedImage
- createEmbedDescription :: Text
- createEmbedFields :: [EmbedField]
- createEmbedImage :: Maybe CreateEmbedImage
- createEmbedFooterText :: Text
- createEmbedFooterIcon :: Maybe CreateEmbedImage
- createEmbedColor :: Maybe DiscordColor
- createEmbedTimestamp :: Maybe UTCTime
}
data CreateEmbedImage
- = CreateEmbedImageUrl Text
- | CreateEmbedImageUpload ByteString
data Embed = Embed {
- embedAuthor :: Maybe EmbedAuthor
- embedTitle :: Maybe Text
- embedUrl :: Maybe Text
- embedThumbnail :: Maybe EmbedThumbnail
- embedDescription :: Maybe Text
- embedFields :: [EmbedField]
- embedImage :: Maybe EmbedImage
- embedFooter :: Maybe EmbedFooter
- embedColor :: Maybe DiscordColor
- embedTimestamp :: Maybe UTCTime
- embedVideo :: Maybe EmbedVideo
- embedProvider :: Maybe EmbedProvider
}
data EmbedThumbnail = EmbedThumbnail {
- embedThumbnailUrl :: Text
- embedThumbnailProxyUrl :: Maybe Text
- embedThumbnailHeight :: Maybe Integer
- embedThumbnailWidth :: Maybe Integer
}
data EmbedVideo = EmbedVideo {
- embedVideoUrl :: Maybe Text
- embedProxyUrl :: Maybe Text
- embedVideoHeight :: Maybe Integer
- embedVideoWidth :: Maybe Integer
}
data EmbedImage = EmbedImage {
- embedImageUrl :: Text
- embedImageProxyUrl :: Maybe Text
- embedImageHeight :: Maybe Integer
- embedImageWidth :: Maybe Integer
}
data EmbedProvider = EmbedProvider {
- embedProviderName :: Maybe Text
- embedProviderUrl :: Maybe Text
}
data EmbedAuthor = EmbedAuthor {
- embedAuthorName :: Text
- embedAuthorUrl :: Maybe Text
- embedAuthorIconUrl :: Maybe Text
- embedAuthorProxyIconUrl :: Maybe Text
}
data EmbedFooter = EmbedFooter {
- embedFooterText :: Text
- embedFooterIconUrl :: Maybe Text
- embedFooterProxyIconUrl :: Maybe Text
}
data EmbedField = EmbedField {
- embedFieldName :: Text
- embedFieldValue :: Text
- embedFieldInline :: Maybe Bool
}
maybeEmbed :: Maybe CreateEmbed -> [PartM IO]

Documentation

createEmbed :: CreateEmbed -> Embed Source #

data CreateEmbed Source #

The Default instance of this type yields a def value whose fields are all empty. As such, the def value is not a valid embed and needs to be adjusted before being used.

Constructors

CreateEmbed

Instances

Instances details

Read CreateEmbed Source #
Instance details Defined in Discord.Internal.Types.Embed Methods readsPrec :: Int -> ReadS CreateEmbed # readList :: ReadS [CreateEmbed] # readPrec :: ReadPrec CreateEmbed # readListPrec :: ReadPrec [CreateEmbed] #
Show CreateEmbed Source #
Instance details Defined in Discord.Internal.Types.Embed Methods showsPrec :: Int -> CreateEmbed -> ShowS # show :: CreateEmbed -> String # showList :: [CreateEmbed] -> ShowS #
Default CreateEmbed Source #
Instance details Defined in Discord.Internal.Types.Embed Methods def :: CreateEmbed #
Eq CreateEmbed Source #
Instance details Defined in Discord.Internal.Types.Embed Methods (==) :: CreateEmbed -> CreateEmbed -> Bool # (/=) :: CreateEmbed -> CreateEmbed -> Bool #
Ord CreateEmbed Source #
Instance details Defined in Discord.Internal.Types.Embed Methods compare :: CreateEmbed -> CreateEmbed -> Ordering # (<) :: CreateEmbed -> CreateEmbed -> Bool # (<=) :: CreateEmbed -> CreateEmbed -> Bool # (>) :: CreateEmbed -> CreateEmbed -> Bool # (>=) :: CreateEmbed -> CreateEmbed -> Bool # max :: CreateEmbed -> CreateEmbed -> CreateEmbed # min :: CreateEmbed -> CreateEmbed -> CreateEmbed #

data CreateEmbedImage Source #

Constructors

CreateEmbedImageUrl Text
CreateEmbedImageUpload ByteString

Instances

Instances details

Read CreateEmbedImage Source #
Instance details Defined in Discord.Internal.Types.Embed Methods readsPrec :: Int -> ReadS CreateEmbedImage # readList :: ReadS [CreateEmbedImage] # readPrec :: ReadPrec CreateEmbedImage # readListPrec :: ReadPrec [CreateEmbedImage] #
Show CreateEmbedImage Source #
Instance details Defined in Discord.Internal.Types.Embed Methods showsPrec :: Int -> CreateEmbedImage -> ShowS # show :: CreateEmbedImage -> String # showList :: [CreateEmbedImage] -> ShowS #
Eq CreateEmbedImage Source #
Instance details Defined in Discord.Internal.Types.Embed Methods (==) :: CreateEmbedImage -> CreateEmbedImage -> Bool # (/=) :: CreateEmbedImage -> CreateEmbedImage -> Bool #
Ord CreateEmbedImage Source #
Instance details Defined in Discord.Internal.Types.Embed Methods compare :: CreateEmbedImage -> CreateEmbedImage -> Ordering # (<) :: CreateEmbedImage -> CreateEmbedImage -> Bool # (<=) :: CreateEmbedImage -> CreateEmbedImage -> Bool # (>) :: CreateEmbedImage -> CreateEmbedImage -> Bool # (>=) :: CreateEmbedImage -> CreateEmbedImage -> Bool # max :: CreateEmbedImage -> CreateEmbedImage -> CreateEmbedImage # min :: CreateEmbedImage -> CreateEmbedImage -> CreateEmbedImage #

data Embed Source #

An embed attached to a message.

Constructors

Embed

Fields

embedAuthor :: Maybe EmbedAuthor
embedTitle :: Maybe Text
Title of the embed
embedUrl :: Maybe Text
URL of embed
embedThumbnail :: Maybe EmbedThumbnail
Thumbnail in top-right
embedDescription :: Maybe Text
Description of embed
embedFields :: [EmbedField]
Fields of the embed
embedImage :: Maybe EmbedImage
embedFooter :: Maybe EmbedFooter
embedColor :: Maybe DiscordColor
The embed color
embedTimestamp :: Maybe UTCTime
The time of the embed content
embedVideo :: Maybe EmbedVideo
Only present for "video" types
embedProvider :: Maybe EmbedProvider
Only present for "video" types

Instances

Instances details

FromJSON Embed Source #
Instance details Defined in Discord.Internal.Types.Embed Methods parseJSON :: Value -> Parser Embed # parseJSONList :: Value -> Parser [Embed] # omittedField :: Maybe Embed #
ToJSON Embed Source #
Instance details Defined in Discord.Internal.Types.Embed Methods toJSON :: Embed -> Value # toEncoding :: Embed -> Encoding # toJSONList :: [Embed] -> Value # toEncodingList :: [Embed] -> Encoding # omitField :: Embed -> Bool #
Read Embed Source #
Instance details Defined in Discord.Internal.Types.Embed Methods readsPrec :: Int -> ReadS Embed # readList :: ReadS [Embed] # readPrec :: ReadPrec Embed # readListPrec :: ReadPrec [Embed] #
Show Embed Source #
Instance details Defined in Discord.Internal.Types.Embed Methods showsPrec :: Int -> Embed -> ShowS # show :: Embed -> String # showList :: [Embed] -> ShowS #
Eq Embed Source #
Instance details Defined in Discord.Internal.Types.Embed Methods (==) :: Embed -> Embed -> Bool # (/=) :: Embed -> Embed -> Bool #
Ord Embed Source #
Instance details Defined in Discord.Internal.Types.Embed Methods compare :: Embed -> Embed -> Ordering # (<) :: Embed -> Embed -> Bool # (<=) :: Embed -> Embed -> Bool # (>) :: Embed -> Embed -> Bool # (>=) :: Embed -> Embed -> Bool # max :: Embed -> Embed -> Embed # min :: Embed -> Embed -> Embed #

data EmbedThumbnail Source #

Constructors

EmbedThumbnail
Fields embedThumbnailUrl :: Text embedThumbnailProxyUrl :: Maybe Text embedThumbnailHeight :: Maybe Integer embedThumbnailWidth :: Maybe Integer

Instances

Instances details

FromJSON EmbedThumbnail Source #
Instance details Defined in Discord.Internal.Types.Embed Methods parseJSON :: Value -> Parser EmbedThumbnail # parseJSONList :: Value -> Parser [EmbedThumbnail] # omittedField :: Maybe EmbedThumbnail #
ToJSON EmbedThumbnail Source #
Instance details Defined in Discord.Internal.Types.Embed Methods toJSON :: EmbedThumbnail -> Value # toEncoding :: EmbedThumbnail -> Encoding # toJSONList :: [EmbedThumbnail] -> Value # toEncodingList :: [EmbedThumbnail] -> Encoding # omitField :: EmbedThumbnail -> Bool #
Read EmbedThumbnail Source #
Instance details Defined in Discord.Internal.Types.Embed Methods readsPrec :: Int -> ReadS EmbedThumbnail # readList :: ReadS [EmbedThumbnail] # readPrec :: ReadPrec EmbedThumbnail # readListPrec :: ReadPrec [EmbedThumbnail] #
Show EmbedThumbnail Source #
Instance details Defined in Discord.Internal.Types.Embed Methods showsPrec :: Int -> EmbedThumbnail -> ShowS # show :: EmbedThumbnail -> String # showList :: [EmbedThumbnail] -> ShowS #
Eq EmbedThumbnail Source #
Instance details Defined in Discord.Internal.Types.Embed Methods (==) :: EmbedThumbnail -> EmbedThumbnail -> Bool # (/=) :: EmbedThumbnail -> EmbedThumbnail -> Bool #
Ord EmbedThumbnail Source #
Instance details Defined in Discord.Internal.Types.Embed Methods compare :: EmbedThumbnail -> EmbedThumbnail -> Ordering # (<) :: EmbedThumbnail -> EmbedThumbnail -> Bool # (<=) :: EmbedThumbnail -> EmbedThumbnail -> Bool # (>) :: EmbedThumbnail -> EmbedThumbnail -> Bool # (>=) :: EmbedThumbnail -> EmbedThumbnail -> Bool # max :: EmbedThumbnail -> EmbedThumbnail -> EmbedThumbnail # min :: EmbedThumbnail -> EmbedThumbnail -> EmbedThumbnail #

data EmbedVideo Source #

Constructors

EmbedVideo
Fields embedVideoUrl :: Maybe Text embedProxyUrl :: Maybe Text embedVideoHeight :: Maybe Integer embedVideoWidth :: Maybe Integer

Instances

Instances details

FromJSON EmbedVideo Source #
Instance details Defined in Discord.Internal.Types.Embed Methods parseJSON :: Value -> Parser EmbedVideo # parseJSONList :: Value -> Parser [EmbedVideo] # omittedField :: Maybe EmbedVideo #
ToJSON EmbedVideo Source #
Instance details Defined in Discord.Internal.Types.Embed Methods toJSON :: EmbedVideo -> Value # toEncoding :: EmbedVideo -> Encoding # toJSONList :: [EmbedVideo] -> Value # toEncodingList :: [EmbedVideo] -> Encoding # omitField :: EmbedVideo -> Bool #
Read EmbedVideo Source #
Instance details Defined in Discord.Internal.Types.Embed Methods readsPrec :: Int -> ReadS EmbedVideo # readList :: ReadS [EmbedVideo] # readPrec :: ReadPrec EmbedVideo # readListPrec :: ReadPrec [EmbedVideo] #
Show EmbedVideo Source #
Instance details Defined in Discord.Internal.Types.Embed Methods showsPrec :: Int -> EmbedVideo -> ShowS # show :: EmbedVideo -> String # showList :: [EmbedVideo] -> ShowS #
Eq EmbedVideo Source #
Instance details Defined in Discord.Internal.Types.Embed Methods (==) :: EmbedVideo -> EmbedVideo -> Bool # (/=) :: EmbedVideo -> EmbedVideo -> Bool #
Ord EmbedVideo Source #
Instance details Defined in Discord.Internal.Types.Embed Methods compare :: EmbedVideo -> EmbedVideo -> Ordering # (<) :: EmbedVideo -> EmbedVideo -> Bool # (<=) :: EmbedVideo -> EmbedVideo -> Bool # (>) :: EmbedVideo -> EmbedVideo -> Bool # (>=) :: EmbedVideo -> EmbedVideo -> Bool # max :: EmbedVideo -> EmbedVideo -> EmbedVideo # min :: EmbedVideo -> EmbedVideo -> EmbedVideo #

data EmbedImage Source #

Constructors

EmbedImage
Fields embedImageUrl :: Text embedImageProxyUrl :: Maybe Text embedImageHeight :: Maybe Integer embedImageWidth :: Maybe Integer

Instances

Instances details

FromJSON EmbedImage Source #
Instance details Defined in Discord.Internal.Types.Embed Methods parseJSON :: Value -> Parser EmbedImage # parseJSONList :: Value -> Parser [EmbedImage] # omittedField :: Maybe EmbedImage #
ToJSON EmbedImage Source #
Instance details Defined in Discord.Internal.Types.Embed Methods toJSON :: EmbedImage -> Value # toEncoding :: EmbedImage -> Encoding # toJSONList :: [EmbedImage] -> Value # toEncodingList :: [EmbedImage] -> Encoding # omitField :: EmbedImage -> Bool #
Read EmbedImage Source #
Instance details Defined in Discord.Internal.Types.Embed Methods readsPrec :: Int -> ReadS EmbedImage # readList :: ReadS [EmbedImage] # readPrec :: ReadPrec EmbedImage # readListPrec :: ReadPrec [EmbedImage] #
Show EmbedImage Source #
Instance details Defined in Discord.Internal.Types.Embed Methods showsPrec :: Int -> EmbedImage -> ShowS # show :: EmbedImage -> String # showList :: [EmbedImage] -> ShowS #
Eq EmbedImage Source #
Instance details Defined in Discord.Internal.Types.Embed Methods (==) :: EmbedImage -> EmbedImage -> Bool # (/=) :: EmbedImage -> EmbedImage -> Bool #
Ord EmbedImage Source #
Instance details Defined in Discord.Internal.Types.Embed Methods compare :: EmbedImage -> EmbedImage -> Ordering # (<) :: EmbedImage -> EmbedImage -> Bool # (<=) :: EmbedImage -> EmbedImage -> Bool # (>) :: EmbedImage -> EmbedImage -> Bool # (>=) :: EmbedImage -> EmbedImage -> Bool # max :: EmbedImage -> EmbedImage -> EmbedImage # min :: EmbedImage -> EmbedImage -> EmbedImage #

data EmbedProvider Source #

Constructors

EmbedProvider
Fields embedProviderName :: Maybe Text embedProviderUrl :: Maybe Text

Instances

Instances details

FromJSON EmbedProvider Source #
Instance details Defined in Discord.Internal.Types.Embed Methods parseJSON :: Value -> Parser EmbedProvider # parseJSONList :: Value -> Parser [EmbedProvider] # omittedField :: Maybe EmbedProvider #
ToJSON EmbedProvider Source #
Instance details Defined in Discord.Internal.Types.Embed Methods toJSON :: EmbedProvider -> Value # toEncoding :: EmbedProvider -> Encoding # toJSONList :: [EmbedProvider] -> Value # toEncodingList :: [EmbedProvider] -> Encoding # omitField :: EmbedProvider -> Bool #
Read EmbedProvider Source #
Instance details Defined in Discord.Internal.Types.Embed Methods readsPrec :: Int -> ReadS EmbedProvider # readList :: ReadS [EmbedProvider] # readPrec :: ReadPrec EmbedProvider # readListPrec :: ReadPrec [EmbedProvider] #
Show EmbedProvider Source #
Instance details Defined in Discord.Internal.Types.Embed Methods showsPrec :: Int -> EmbedProvider -> ShowS # show :: EmbedProvider -> String # showList :: [EmbedProvider] -> ShowS #
Eq EmbedProvider Source #
Instance details Defined in Discord.Internal.Types.Embed Methods (==) :: EmbedProvider -> EmbedProvider -> Bool # (/=) :: EmbedProvider -> EmbedProvider -> Bool #
Ord EmbedProvider Source #
Instance details Defined in Discord.Internal.Types.Embed Methods compare :: EmbedProvider -> EmbedProvider -> Ordering # (<) :: EmbedProvider -> EmbedProvider -> Bool # (<=) :: EmbedProvider -> EmbedProvider -> Bool # (>) :: EmbedProvider -> EmbedProvider -> Bool # (>=) :: EmbedProvider -> EmbedProvider -> Bool # max :: EmbedProvider -> EmbedProvider -> EmbedProvider # min :: EmbedProvider -> EmbedProvider -> EmbedProvider #

data EmbedAuthor Source #

Constructors

EmbedAuthor
Fields embedAuthorName :: Text embedAuthorUrl :: Maybe Text embedAuthorIconUrl :: Maybe Text embedAuthorProxyIconUrl :: Maybe Text

Instances

Instances details

FromJSON EmbedAuthor Source #
Instance details Defined in Discord.Internal.Types.Embed Methods parseJSON :: Value -> Parser EmbedAuthor # parseJSONList :: Value -> Parser [EmbedAuthor] # omittedField :: Maybe EmbedAuthor #
ToJSON EmbedAuthor Source #
Instance details Defined in Discord.Internal.Types.Embed Methods toJSON :: EmbedAuthor -> Value # toEncoding :: EmbedAuthor -> Encoding # toJSONList :: [EmbedAuthor] -> Value # toEncodingList :: [EmbedAuthor] -> Encoding # omitField :: EmbedAuthor -> Bool #
Read EmbedAuthor Source #
Instance details Defined in Discord.Internal.Types.Embed Methods readsPrec :: Int -> ReadS EmbedAuthor # readList :: ReadS [EmbedAuthor] # readPrec :: ReadPrec EmbedAuthor # readListPrec :: ReadPrec [EmbedAuthor] #
Show EmbedAuthor Source #
Instance details Defined in Discord.Internal.Types.Embed Methods showsPrec :: Int -> EmbedAuthor -> ShowS # show :: EmbedAuthor -> String # showList :: [EmbedAuthor] -> ShowS #
Eq EmbedAuthor Source #
Instance details Defined in Discord.Internal.Types.Embed Methods (==) :: EmbedAuthor -> EmbedAuthor -> Bool # (/=) :: EmbedAuthor -> EmbedAuthor -> Bool #
Ord EmbedAuthor Source #
Instance details Defined in Discord.Internal.Types.Embed Methods compare :: EmbedAuthor -> EmbedAuthor -> Ordering # (<) :: EmbedAuthor -> EmbedAuthor -> Bool # (<=) :: EmbedAuthor -> EmbedAuthor -> Bool # (>) :: EmbedAuthor -> EmbedAuthor -> Bool # (>=) :: EmbedAuthor -> EmbedAuthor -> Bool # max :: EmbedAuthor -> EmbedAuthor -> EmbedAuthor # min :: EmbedAuthor -> EmbedAuthor -> EmbedAuthor #

data EmbedFooter Source #

Constructors

EmbedFooter
Fields embedFooterText :: Text embedFooterIconUrl :: Maybe Text embedFooterProxyIconUrl :: Maybe Text

Instances

Instances details

FromJSON EmbedFooter Source #
Instance details Defined in Discord.Internal.Types.Embed Methods parseJSON :: Value -> Parser EmbedFooter # parseJSONList :: Value -> Parser [EmbedFooter] # omittedField :: Maybe EmbedFooter #
ToJSON EmbedFooter Source #
Instance details Defined in Discord.Internal.Types.Embed Methods toJSON :: EmbedFooter -> Value # toEncoding :: EmbedFooter -> Encoding # toJSONList :: [EmbedFooter] -> Value # toEncodingList :: [EmbedFooter] -> Encoding # omitField :: EmbedFooter -> Bool #
Read EmbedFooter Source #
Instance details Defined in Discord.Internal.Types.Embed Methods readsPrec :: Int -> ReadS EmbedFooter # readList :: ReadS [EmbedFooter] # readPrec :: ReadPrec EmbedFooter # readListPrec :: ReadPrec [EmbedFooter] #
Show EmbedFooter Source #
Instance details Defined in Discord.Internal.Types.Embed Methods showsPrec :: Int -> EmbedFooter -> ShowS # show :: EmbedFooter -> String # showList :: [EmbedFooter] -> ShowS #
Eq EmbedFooter Source #
Instance details Defined in Discord.Internal.Types.Embed Methods (==) :: EmbedFooter -> EmbedFooter -> Bool # (/=) :: EmbedFooter -> EmbedFooter -> Bool #
Ord EmbedFooter Source #
Instance details Defined in Discord.Internal.Types.Embed Methods compare :: EmbedFooter -> EmbedFooter -> Ordering # (<) :: EmbedFooter -> EmbedFooter -> Bool # (<=) :: EmbedFooter -> EmbedFooter -> Bool # (>) :: EmbedFooter -> EmbedFooter -> Bool # (>=) :: EmbedFooter -> EmbedFooter -> Bool # max :: EmbedFooter -> EmbedFooter -> EmbedFooter # min :: EmbedFooter -> EmbedFooter -> EmbedFooter #

data EmbedField Source #

Constructors

EmbedField
Fields embedFieldName :: Text embedFieldValue :: Text embedFieldInline :: Maybe Bool

Instances

Instances details

FromJSON EmbedField Source #
Instance details Defined in Discord.Internal.Types.Embed Methods parseJSON :: Value -> Parser EmbedField # parseJSONList :: Value -> Parser [EmbedField] # omittedField :: Maybe EmbedField #
ToJSON EmbedField Source #
Instance details Defined in Discord.Internal.Types.Embed Methods toJSON :: EmbedField -> Value # toEncoding :: EmbedField -> Encoding # toJSONList :: [EmbedField] -> Value # toEncodingList :: [EmbedField] -> Encoding # omitField :: EmbedField -> Bool #
Read EmbedField Source #
Instance details Defined in Discord.Internal.Types.Embed Methods readsPrec :: Int -> ReadS EmbedField # readList :: ReadS [EmbedField] # readPrec :: ReadPrec EmbedField # readListPrec :: ReadPrec [EmbedField] #
Show EmbedField Source #
Instance details Defined in Discord.Internal.Types.Embed Methods showsPrec :: Int -> EmbedField -> ShowS # show :: EmbedField -> String # showList :: [EmbedField] -> ShowS #
Eq EmbedField Source #
Instance details Defined in Discord.Internal.Types.Embed Methods (==) :: EmbedField -> EmbedField -> Bool # (/=) :: EmbedField -> EmbedField -> Bool #
Ord EmbedField Source #
Instance details Defined in Discord.Internal.Types.Embed Methods compare :: EmbedField -> EmbedField -> Ordering # (<) :: EmbedField -> EmbedField -> Bool # (<=) :: EmbedField -> EmbedField -> Bool # (>) :: EmbedField -> EmbedField -> Bool # (>=) :: EmbedField -> EmbedField -> Bool # max :: EmbedField -> EmbedField -> EmbedField # min :: EmbedField -> EmbedField -> EmbedField #

maybeEmbed :: Maybe CreateEmbed -> [PartM IO] Source #