Safe Haskell	None
Language	Haskell2010

Discord.Internal.Types.Channel

Description

Data structures pertaining to Discord Channels

Synopsis

data Channel
- = ChannelText {
  - channelId :: ChannelId
  - channelGuild :: GuildId
  - channelName :: Text
  - channelPosition :: Integer
  - channelPermissions :: [Overwrite]
  - channelUserRateLimit :: Integer
  - channelNSFW :: Bool
  - channelTopic :: Text
  - channelLastMessage :: Maybe MessageId
  - parentId :: Maybe ParentId
  }
- | ChannelNews {
  - channelId :: ChannelId
  - channelGuild :: GuildId
  - channelName :: Text
  - channelPosition :: Integer
  - channelPermissions :: [Overwrite]
  - channelNSFW :: Bool
  - channelTopic :: Text
  - channelLastMessage :: Maybe MessageId
  }
- | ChannelStorePage {
  - channelId :: ChannelId
  - channelGuild :: GuildId
  - channelName :: Text
  - channelPosition :: Integer
  - channelNSFW :: Bool
  - channelPermissions :: [Overwrite]
  }
- | ChannelVoice {
  - channelId :: ChannelId
  - channelGuild :: GuildId
  - channelName :: Text
  - channelPosition :: Integer
  - channelPermissions :: [Overwrite]
  - channelNSFW :: Bool
  - channelBitRate :: Integer
  - channelUserLimit :: Integer
  - parentId :: Maybe ParentId
  }
- | ChannelDirectMessage {
  - channelId :: ChannelId
  - channelRecipients :: [User]
  - channelLastMessage :: Maybe MessageId
  }
- | ChannelGroupDM {
  - channelId :: ChannelId
  - channelRecipients :: [User]
  - channelLastMessage :: Maybe MessageId
  }
- | ChannelGuildCategory {
  - channelId :: ChannelId
  - channelGuild :: GuildId
  - channelName :: Text
  - channelPosition :: Integer
  - channelPermissions :: [Overwrite]
  }
channelIsInGuild :: Channel -> Bool
data Overwrite = Overwrite {
- overwriteId :: OverwriteId
- overwriteType :: Text
- overwriteAllow :: Integer
- overwriteDeny :: Integer
}
data Message = Message {
- messageId :: MessageId
- messageChannel :: ChannelId
- messageAuthor :: User
- messageText :: Text
- messageTimestamp :: UTCTime
- messageEdited :: Maybe UTCTime
- messageTts :: Bool
- messageEveryone :: Bool
- messageMentions :: [User]
- messageMentionRoles :: [RoleId]
- messageAttachments :: [Attachment]
- messageEmbeds :: [Embed]
- messageReactions :: [MessageReaction]
- messageNonce :: Maybe Nonce
- messagePinned :: Bool
- messageGuild :: Maybe GuildId
- messageReference :: Maybe MessageReference
- referencedMessage :: Maybe Message
}
data MessageReaction = MessageReaction {
- messageReactionCount :: Int
- messageReactionMeIncluded :: Bool
- messageReactionEmoji :: Emoji
}
data Emoji = Emoji {
- emojiId :: Maybe EmojiId
- emojiName :: Text
- emojiRoles :: Maybe [RoleId]
- emojiUser :: Maybe User
- emojiManaged :: Maybe Bool
}
data Attachment = Attachment {
- attachmentId :: Snowflake
- attachmentFilename :: Text
- attachmentSize :: Integer
- attachmentUrl :: Text
- attachmentProxy :: Text
- attachmentHeight :: Maybe Integer
- attachmentWidth :: Maybe Integer
}
newtype Nonce = Nonce Text
data MessageReference = MessageReference {
- referenceMessageId :: Maybe MessageId
- referenceChannelId :: Maybe ChannelId
- referenceGuildId :: Maybe GuildId
- failIfNotExists :: Bool
}

Documentation

data Channel Source #

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

Constructors

ChannelText	A text channel in a guild.
Fields channelId :: ChannelId The id of the channel (Will be equal to the guild if it's the "general" channel). channelGuild :: GuildId The id of the guild. channelName :: Text The name of the guild (2 - 1000 characters). channelPosition :: Integer The storing position of the channel. channelPermissions :: [Overwrite] An array of permission `Overwrite`s channelUserRateLimit :: Integer Seconds before a user can speak again channelNSFW :: Bool Is not-safe-for-work channelTopic :: Text The topic of the channel. (0 - 1024 chars). channelLastMessage :: Maybe MessageId The id of the last message sent in the channel parentId :: Maybe ParentId The id of the parent channel (category)
ChannelNews
Fields channelId :: ChannelId The id of the channel (Will be equal to the guild if it's the "general" channel). channelGuild :: GuildId The id of the guild. channelName :: Text The name of the guild (2 - 1000 characters). channelPosition :: Integer The storing position of the channel. channelPermissions :: [Overwrite] An array of permission `Overwrite`s channelNSFW :: Bool Is not-safe-for-work channelTopic :: Text The topic of the channel. (0 - 1024 chars). channelLastMessage :: Maybe MessageId The id of the last message sent in the channel
ChannelStorePage
Fields channelId :: ChannelId The id of the channel (Will be equal to the guild if it's the "general" channel). channelGuild :: GuildId The id of the guild. channelName :: Text The name of the guild (2 - 1000 characters). channelPosition :: Integer The storing position of the channel. channelNSFW :: Bool Is not-safe-for-work channelPermissions :: [Overwrite] An array of permission `Overwrite`s
ChannelVoice	A voice channel in a guild.
Fields channelId :: ChannelId The id of the channel (Will be equal to the guild if it's the "general" channel). channelGuild :: GuildId The id of the guild. channelName :: Text The name of the guild (2 - 1000 characters). channelPosition :: Integer The storing position of the channel. channelPermissions :: [Overwrite] An array of permission `Overwrite`s channelNSFW :: Bool Is not-safe-for-work channelBitRate :: Integer The bitrate (in bits) of the channel. channelUserLimit :: Integer The user limit of the voice channel. parentId :: Maybe ParentId The id of the parent channel (category)
ChannelDirectMessage	DM Channels represent a one-to-one conversation between two users, outside the scope of guilds
Fields channelId :: ChannelId 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 MessageId The id of the last message sent in the channel
ChannelGroupDM
Fields channelId :: ChannelId 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 MessageId The id of the last message sent in the channel
ChannelGuildCategory
Fields channelId :: ChannelId The id of the channel (Will be equal to the guild if it's the "general" channel). channelGuild :: GuildId The id of the guild. channelName :: Text The name of the guild (2 - 1000 characters). channelPosition :: Integer The storing position of the channel. channelPermissions :: [Overwrite] An array of permission `Overwrite`s

Instances

Instances details

Eq Channel Source #
Instance details Defined in Discord.Internal.Types.Channel Methods (==) :: Channel -> Channel -> Bool # (/=) :: Channel -> Channel -> Bool #
Ord Channel Source #
Instance details Defined in Discord.Internal.Types.Channel Methods compare :: Channel -> Channel -> Ordering # (<) :: Channel -> Channel -> Bool # (<=) :: Channel -> Channel -> Bool # (>) :: Channel -> Channel -> Bool # (>=) :: Channel -> Channel -> Bool # max :: Channel -> Channel -> Channel # min :: Channel -> Channel -> Channel #
Show Channel Source #
Instance details Defined in Discord.Internal.Types.Channel Methods showsPrec :: Int -> Channel -> ShowS # show :: Channel -> String # showList :: [Channel] -> ShowS #
ToJSON Channel Source #
Instance details Defined in Discord.Internal.Types.Channel Methods toJSON :: Channel -> Value # toEncoding :: Channel -> Encoding # toJSONList :: [Channel] -> Value # toEncodingList :: [Channel] -> Encoding #
FromJSON Channel Source #
Instance details Defined in Discord.Internal.Types.Channel Methods parseJSON :: Value -> Parser Channel # parseJSONList :: Value -> Parser [Channel] #

channelIsInGuild :: 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 :: OverwriteId `Role` or `User` id overwriteType :: Text Either "role" or "member overwriteAllow :: Integer Allowed permission bit set overwriteDeny :: Integer Denied permission bit set

Instances

Instances details

Eq Overwrite Source #
Instance details Defined in Discord.Internal.Types.Channel Methods (==) :: Overwrite -> Overwrite -> Bool # (/=) :: Overwrite -> Overwrite -> Bool #
Ord Overwrite Source #
Instance details Defined in Discord.Internal.Types.Channel Methods compare :: Overwrite -> Overwrite -> Ordering # (<) :: Overwrite -> Overwrite -> Bool # (<=) :: Overwrite -> Overwrite -> Bool # (>) :: Overwrite -> Overwrite -> Bool # (>=) :: Overwrite -> Overwrite -> Bool # max :: Overwrite -> Overwrite -> Overwrite # min :: Overwrite -> Overwrite -> Overwrite #
Show Overwrite Source #
Instance details Defined in Discord.Internal.Types.Channel Methods showsPrec :: Int -> Overwrite -> ShowS # show :: Overwrite -> String # showList :: [Overwrite] -> ShowS #
ToJSON Overwrite Source #
Instance details Defined in Discord.Internal.Types.Channel Methods toJSON :: Overwrite -> Value # toEncoding :: Overwrite -> Encoding # toJSONList :: [Overwrite] -> Value # toEncodingList :: [Overwrite] -> Encoding #
FromJSON Overwrite Source #
Instance details Defined in Discord.Internal.Types.Channel 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 :: MessageId
The id of the message
messageChannel :: ChannelId
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 :: [RoleId]
Roles specifically mentioned in the message
messageAttachments :: [Attachment]
Any attached files
messageEmbeds :: [Embed]
Any embedded content
messageReactions :: [MessageReaction]
Any reactions to message
messageNonce :: Maybe Nonce
Used for validating if a message was sent
messagePinned :: Bool
Whether this message is pinned
messageGuild :: Maybe GuildId
The guild the message went to
messageReference :: Maybe MessageReference
Reference IDs of the original message
referencedMessage :: Maybe Message
The full original message

Instances

Instances details

Eq Message Source #
Instance details Defined in Discord.Internal.Types.Channel Methods (==) :: Message -> Message -> Bool # (/=) :: Message -> Message -> Bool #
Ord Message Source #
Instance details Defined in Discord.Internal.Types.Channel Methods compare :: Message -> Message -> Ordering # (<) :: Message -> Message -> Bool # (<=) :: Message -> Message -> Bool # (>) :: Message -> Message -> Bool # (>=) :: Message -> Message -> Bool # max :: Message -> Message -> Message # min :: Message -> Message -> Message #
Show Message Source #
Instance details Defined in Discord.Internal.Types.Channel Methods showsPrec :: Int -> Message -> ShowS # show :: Message -> String # showList :: [Message] -> ShowS #
FromJSON Message Source #
Instance details Defined in Discord.Internal.Types.Channel Methods parseJSON :: Value -> Parser Message # parseJSONList :: Value -> Parser [Message] #

data MessageReaction Source #

Constructors

MessageReaction
Fields messageReactionCount :: Int messageReactionMeIncluded :: Bool messageReactionEmoji :: Emoji

Instances

Instances details

Eq MessageReaction Source #
Instance details Defined in Discord.Internal.Types.Channel Methods (==) :: MessageReaction -> MessageReaction -> Bool # (/=) :: MessageReaction -> MessageReaction -> Bool #
Ord MessageReaction Source #
Instance details Defined in Discord.Internal.Types.Channel Methods compare :: MessageReaction -> MessageReaction -> Ordering # (<) :: MessageReaction -> MessageReaction -> Bool # (<=) :: MessageReaction -> MessageReaction -> Bool # (>) :: MessageReaction -> MessageReaction -> Bool # (>=) :: MessageReaction -> MessageReaction -> Bool # max :: MessageReaction -> MessageReaction -> MessageReaction # min :: MessageReaction -> MessageReaction -> MessageReaction #
Show MessageReaction Source #
Instance details Defined in Discord.Internal.Types.Channel Methods showsPrec :: Int -> MessageReaction -> ShowS # show :: MessageReaction -> String # showList :: [MessageReaction] -> ShowS #
FromJSON MessageReaction Source #
Instance details Defined in Discord.Internal.Types.Channel Methods parseJSON :: Value -> Parser MessageReaction # parseJSONList :: Value -> Parser [MessageReaction] #

data Emoji Source #

Represents an emoticon (emoji)

Constructors

Emoji
Fields emojiId :: Maybe EmojiId The emoji id emojiName :: Text The emoji name emojiRoles :: Maybe [RoleId] Roles the emoji is active for emojiUser :: Maybe User User that created this emoji emojiManaged :: Maybe Bool Whether this emoji is managed

Instances

Instances details

Eq Emoji Source #
Instance details Defined in Discord.Internal.Types.Channel Methods (==) :: Emoji -> Emoji -> Bool # (/=) :: Emoji -> Emoji -> Bool #
Ord Emoji Source #
Instance details Defined in Discord.Internal.Types.Channel Methods compare :: Emoji -> Emoji -> Ordering # (<) :: Emoji -> Emoji -> Bool # (<=) :: Emoji -> Emoji -> Bool # (>) :: Emoji -> Emoji -> Bool # (>=) :: Emoji -> Emoji -> Bool # max :: Emoji -> Emoji -> Emoji # min :: Emoji -> Emoji -> Emoji #
Show Emoji Source #
Instance details Defined in Discord.Internal.Types.Channel Methods showsPrec :: Int -> Emoji -> ShowS # show :: Emoji -> String # showList :: [Emoji] -> ShowS #
FromJSON Emoji Source #
Instance details Defined in Discord.Internal.Types.Channel Methods parseJSON :: Value -> Parser Emoji # parseJSONList :: Value -> Parser [Emoji] #

data Attachment Source #

Represents an attached to a message file.

Constructors

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

Instances

Instances details

Eq Attachment Source #
Instance details Defined in Discord.Internal.Types.Channel Methods (==) :: Attachment -> Attachment -> Bool # (/=) :: Attachment -> Attachment -> Bool #
Ord Attachment Source #
Instance details Defined in Discord.Internal.Types.Channel Methods compare :: Attachment -> Attachment -> Ordering # (<) :: Attachment -> Attachment -> Bool # (<=) :: Attachment -> Attachment -> Bool # (>) :: Attachment -> Attachment -> Bool # (>=) :: Attachment -> Attachment -> Bool # max :: Attachment -> Attachment -> Attachment # min :: Attachment -> Attachment -> Attachment #
Show Attachment Source #
Instance details Defined in Discord.Internal.Types.Channel Methods showsPrec :: Int -> Attachment -> ShowS # show :: Attachment -> String # showList :: [Attachment] -> ShowS #
FromJSON Attachment Source #
Instance details Defined in Discord.Internal.Types.Channel Methods parseJSON :: Value -> Parser Attachment # parseJSONList :: Value -> Parser [Attachment] #

newtype Nonce Source #

Constructors

Nonce Text

Instances

Instances details

Eq Nonce Source #
Instance details Defined in Discord.Internal.Types.Channel Methods (==) :: Nonce -> Nonce -> Bool # (/=) :: Nonce -> Nonce -> Bool #
Ord Nonce Source #
Instance details Defined in Discord.Internal.Types.Channel Methods compare :: Nonce -> Nonce -> Ordering # (<) :: Nonce -> Nonce -> Bool # (<=) :: Nonce -> Nonce -> Bool # (>) :: Nonce -> Nonce -> Bool # (>=) :: Nonce -> Nonce -> Bool # max :: Nonce -> Nonce -> Nonce # min :: Nonce -> Nonce -> Nonce #
Show Nonce Source #
Instance details Defined in Discord.Internal.Types.Channel Methods showsPrec :: Int -> Nonce -> ShowS # show :: Nonce -> String # showList :: [Nonce] -> ShowS #
FromJSON Nonce Source #
Instance details Defined in Discord.Internal.Types.Channel Methods parseJSON :: Value -> Parser Nonce # parseJSONList :: Value -> Parser [Nonce] #

data MessageReference Source #

Represents a Message Reference

Constructors

MessageReference
Fields referenceMessageId :: Maybe MessageId id of the originating message referenceChannelId :: Maybe ChannelId id of the originating message's channel referenceGuildId :: Maybe GuildId id of the originating message's guild failIfNotExists :: Bool Whether to not send if reference not exist

Instances

Instances details

Eq MessageReference Source #
Instance details Defined in Discord.Internal.Types.Channel Methods (==) :: MessageReference -> MessageReference -> Bool # (/=) :: MessageReference -> MessageReference -> Bool #
Ord MessageReference Source #
Instance details Defined in Discord.Internal.Types.Channel Methods compare :: MessageReference -> MessageReference -> Ordering # (<) :: MessageReference -> MessageReference -> Bool # (<=) :: MessageReference -> MessageReference -> Bool # (>) :: MessageReference -> MessageReference -> Bool # (>=) :: MessageReference -> MessageReference -> Bool # max :: MessageReference -> MessageReference -> MessageReference # min :: MessageReference -> MessageReference -> MessageReference #
Show MessageReference Source #
Instance details Defined in Discord.Internal.Types.Channel Methods showsPrec :: Int -> MessageReference -> ShowS # show :: MessageReference -> String # showList :: [MessageReference] -> ShowS #
ToJSON MessageReference Source #
Instance details Defined in Discord.Internal.Types.Channel Methods toJSON :: MessageReference -> Value # toEncoding :: MessageReference -> Encoding # toJSONList :: [MessageReference] -> Value # toEncodingList :: [MessageReference] -> Encoding #
FromJSON MessageReference Source #
Instance details Defined in Discord.Internal.Types.Channel Methods parseJSON :: Value -> Parser MessageReference # parseJSONList :: Value -> Parser [MessageReference] #
Default MessageReference Source #
Instance details Defined in Discord.Internal.Types.Channel Methods def :: MessageReference #