Safe Haskell	None
Language	Haskell2010

Discord.Types.Channel

Description

Data structures pertaining to Discord Channels

Synopsis

Documentation

data User Source #

Represents information about a user.

Constructors

User
Fields userId :: Snowflake The user's id. userName :: String The user's username, not unique across the platform. userDiscrim :: String The user's 4-digit discord-tag. userAvatar :: Maybe String The user's avatar hash. userIsBot :: Bool Whether the user belongs to an OAuth2 application. userMfa :: Maybe Bool Whether the user has two factor authentication enabled on the account. userVerified :: Maybe Bool Whether the email on this account has been verified. userEmail :: Maybe String The user's email.
Webhook

Instances

Eq User Source #
Methods (==) :: User -> User -> Bool # (/=) :: User -> User -> Bool #
Show User Source #
Methods showsPrec :: Int -> User -> ShowS # show :: User -> String # showList :: [User] -> ShowS #
FromJSON User Source #
Methods parseJSON :: Value -> Parser User # parseJSONList :: Value -> Parser [User] #

data Channel Source #

Guild channels represent an isolated set of users and messages in a Guild (Server)

Constructors

Text	A text channel in a guild.
Fields channelId :: Snowflake The id of the channel (Will be equal to the guild if it's the "general" channel). channelGuild :: Snowflake The id of the guild. channelName :: String The name of the guild (2 - 1000 characters). channelPosition :: Integer The storing position of the channel. channelPermissions :: [Overwrite] An array of permission `Overwrite`s channelTopic :: String The topic of the channel. (0 - 1024 chars). channelLastMessage :: Maybe Snowflake The id of the last message sent in the channel
Voice	A voice channel in a guild.
Fields channelId :: Snowflake The id of the channel (Will be equal to the guild if it's the "general" channel). channelGuild :: Snowflake The id of the guild. channelName :: String The name of the guild (2 - 1000 characters). channelPosition :: Integer The storing position of the channel. channelPermissions :: [Overwrite] An array of permission `Overwrite`s channelBitRate :: Integer The bitrate (in bits) of the channel. channelUserLimit :: Integer The user limit of the voice channel.
DirectMessage	DM Channels represent a one-to-one conversation between two users, outside the scope of guilds
Fields channelId :: Snowflake The id of the channel (Will be equal to the guild if it's the "general" channel). channelRecipients :: [User] The `User` object(s) of the DM recipient(s). channelLastMessage :: Maybe Snowflake The id of the last message sent in the channel
GroupDM
Fields channelId :: Snowflake The id of the channel (Will be equal to the guild if it's the "general" channel). channelRecipients :: [User] The `User` object(s) of the DM recipient(s). channelLastMessage :: Maybe Snowflake The id of the last message sent in the channel
GuildCategory
Fields channelId :: Snowflake The id of the channel (Will be equal to the guild if it's the "general" channel). channelGuild :: Snowflake The id of the guild.

Instances

Eq Channel Source #
Methods (==) :: Channel -> Channel -> Bool # (/=) :: Channel -> Channel -> Bool #
Show Channel Source #
Methods showsPrec :: Int -> Channel -> ShowS # show :: Channel -> String # showList :: [Channel] -> ShowS #
FromJSON Channel Source #
Methods parseJSON :: Value -> Parser Channel # parseJSONList :: Value -> Parser [Channel] #

isGuildChannel :: Channel -> Bool Source #

If the channel is part of a guild (has a guild id field)

data Overwrite Source #

Permission overwrites for a channel.

Constructors

Overwrite
Fields overwriteId :: Snowflake `Role` or `User` id overwriteType :: String Either "role" or "member overwriteAllow :: Integer Allowed permission bit set overwriteDeny :: Integer Denied permission bit set

Instances

Eq Overwrite Source #
Methods (==) :: Overwrite -> Overwrite -> Bool # (/=) :: Overwrite -> Overwrite -> Bool #
Show Overwrite Source #
Methods showsPrec :: Int -> Overwrite -> ShowS # show :: Overwrite -> String # showList :: [Overwrite] -> ShowS #
ToJSON Overwrite Source #
Methods toJSON :: Overwrite -> Value # toEncoding :: Overwrite -> Encoding # toJSONList :: [Overwrite] -> Value # toEncodingList :: [Overwrite] -> Encoding #
FromJSON Overwrite Source #
Methods parseJSON :: Value -> Parser Overwrite # parseJSONList :: Value -> Parser [Overwrite] #

data Message Source #

Represents information about a message in a Discord channel.

Constructors

Message

Fields

messageId :: Snowflake
The id of the message
messageChannel :: Snowflake
Id of the channel the message was sent in
messageAuthor :: User
The User the message was sent by
messageText :: Text
Contents of the message
messageTimestamp :: UTCTime
When the message was sent
messageEdited :: Maybe UTCTime
When/if the message was edited
messageTts :: Bool
Whether this message was a TTS message
messageEveryone :: Bool
Whether this message mentions everyone
messageMentions :: [User]
Users specifically mentioned in the message
messageMentionRoles :: [Snowflake]
Roles specifically mentioned in the message
messageAttachments :: [Attachment]
Any attached files
messageEmbeds :: [Embed]
Any embedded content
messageNonce :: Maybe Snowflake
Used for validating if a message was sent
messagePinned :: Bool
Whether this message is pinned
messageGuild :: Maybe Snowflake
The guild the message went to

Instances

Eq Message Source #
Methods (==) :: Message -> Message -> Bool # (/=) :: Message -> Message -> Bool #
Show Message Source #
Methods showsPrec :: Int -> Message -> ShowS # show :: Message -> String # showList :: [Message] -> ShowS #
FromJSON Message Source #
Methods parseJSON :: Value -> Parser Message # parseJSONList :: Value -> Parser [Message] #

data Attachment Source #

Represents an attached to a message file.

Constructors

Attachment
Fields attachmentId :: Snowflake Attachment id attachmentFilename :: String Name of attached file attachmentSize :: Integer Size of file (in bytes) attachmentUrl :: String Source of file attachmentProxy :: String Proxied url of file attachmentHeight :: Maybe Integer Height of file (if image) attachmentWidth :: Maybe Integer Width of file (if image)

Instances

Eq Attachment Source #
Methods (==) :: Attachment -> Attachment -> Bool # (/=) :: Attachment -> Attachment -> Bool #
Show Attachment Source #
Methods showsPrec :: Int -> Attachment -> ShowS # show :: Attachment -> String # showList :: [Attachment] -> ShowS #
FromJSON Attachment Source #
Methods parseJSON :: Value -> Parser Attachment # parseJSONList :: Value -> Parser [Attachment] #

data Embed Source #

An embed attached to a message.

Constructors

Embed
Fields embedTitle :: String Title of the embed embedType :: String Type of embed (Always "rich" for webhooks) embedDesc :: String Description of embed embedUrl :: String URL of embed embedTime :: UTCTime The time of the embed content embedColor :: Integer The embed color embedFields :: [SubEmbed] Fields of the embed

Instances

Eq Embed Source #
Methods (==) :: Embed -> Embed -> Bool # (/=) :: Embed -> Embed -> Bool #
Read Embed Source #
Methods readsPrec :: Int -> ReadS Embed # readList :: ReadS [Embed] # readPrec :: ReadPrec Embed # readListPrec :: ReadPrec [Embed] #
Show Embed Source #
Methods showsPrec :: Int -> Embed -> ShowS # show :: Embed -> String # showList :: [Embed] -> ShowS #
ToJSON Embed Source #
Methods toJSON :: Embed -> Value # toEncoding :: Embed -> Encoding # toJSONList :: [Embed] -> Value # toEncodingList :: [Embed] -> Encoding #
FromJSON Embed Source #
Methods parseJSON :: Value -> Parser Embed # parseJSONList :: Value -> Parser [Embed] #

data SubEmbed Source #

Represents a part of an embed.

Instances

Eq SubEmbed Source #
Methods (==) :: SubEmbed -> SubEmbed -> Bool # (/=) :: SubEmbed -> SubEmbed -> Bool #
Read SubEmbed Source #
Methods readsPrec :: Int -> ReadS SubEmbed # readList :: ReadS [SubEmbed] # readPrec :: ReadPrec SubEmbed # readListPrec :: ReadPrec [SubEmbed] #
Show SubEmbed Source #
Methods showsPrec :: Int -> SubEmbed -> ShowS # show :: SubEmbed -> String # showList :: [SubEmbed] -> ShowS #

Thumbnail String String Integer Integer
Video String Integer Integer
Image String String Integer Integer
Provider String String
Author String String String String
Footer String String String
Field String String Bool