Safe Haskell	Safe-Inferred
Language	Haskell2010

Discord.Internal.Types.Events

Description

Data structures pertaining to gateway dispatch Events

Synopsis

data Event
- = Ready Int User [GuildUnavailable] Text HostName (Maybe Shard) PartialApplication
- | Resumed [Text]
- | ChannelCreate Channel
- | ChannelUpdate Channel
- | ChannelDelete Channel
- | ThreadCreate Channel
- | ThreadUpdate Channel
- | ThreadMemberUpdate ThreadMemberUpdateFields
- | ThreadDelete Channel
- | ThreadListSync ThreadListSyncFields
- | ThreadMembersUpdate ThreadMembersUpdateFields
- | ChannelPinsUpdate ChannelId (Maybe UTCTime)
- | GuildCreate Guild GuildCreateData
- | GuildUpdate Guild
- | GuildDelete GuildUnavailable
- | GuildBanAdd GuildId User
- | GuildBanRemove GuildId User
- | GuildEmojiUpdate GuildId [Emoji]
- | GuildIntegrationsUpdate GuildId
- | GuildMemberAdd GuildId GuildMember
- | GuildMemberRemove GuildId User
- | GuildMemberUpdate GuildId [RoleId] User (Maybe Text)
- | GuildMemberChunk GuildId [GuildMember]
- | GuildRoleCreate GuildId Role
- | GuildRoleUpdate GuildId Role
- | GuildRoleDelete GuildId RoleId
- | MessageCreate Message
- | MessageUpdate ChannelId MessageId
- | MessageDelete ChannelId MessageId
- | MessageDeleteBulk ChannelId [MessageId]
- | MessageReactionAdd ReactionInfo
- | MessageReactionRemove ReactionInfo
- | MessageReactionRemoveAll ChannelId MessageId
- | MessageReactionRemoveEmoji ReactionRemoveInfo
- | PresenceUpdate PresenceInfo
- | TypingStart TypingInfo
- | UserUpdate User
- | InteractionCreate Interaction
- | UnknownEvent Text Object
data EventInternalParse
data PartialApplication = PartialApplication {
- partialApplicationID :: ApplicationId
- partialApplicationFlags :: Int
}
data GuildCreateData = GuildCreateData {
- guildCreateJoinedAt :: !UTCTime
- guildCreateLarge :: !Bool
- guildCreateUnavailable :: !(Maybe Bool)
- guildCreateMemberCount :: !Int
- guildCreateMembers :: ![GuildMember]
- guildCreateChannels :: ![Channel]
- guildCreateThreads :: ![Channel]
- guildCreatePresences :: ![PresenceInfo]
- guildCreateScheduledEvents :: ![ScheduledEvent]
}
parseGuildCreate :: Object -> Parser EventInternalParse
data ReactionInfo = ReactionInfo {
- reactionUserId :: UserId
- reactionGuildId :: Maybe GuildId
- reactionChannelId :: ChannelId
- reactionMessageId :: MessageId
- reactionEmoji :: Emoji
}
data ReactionRemoveInfo = ReactionRemoveInfo {
}
data TypingInfo = TypingInfo {
- typingUserId :: UserId
- typingChannelId :: ChannelId
- typingTimestamp :: UTCTime
}
reparse :: (ToJSON a, FromJSON b) => a -> Parser b
extractHostname :: String -> HostName
eventParse :: Text -> Object -> Parser EventInternalParse

Documentation

data Event Source #

Represents possible events sent by discord. Detailed information can be found at https://discord.com/developers/docs/topics/gateway.

Constructors

Ready Int User [GuildUnavailable] Text HostName (Maybe Shard) PartialApplication	Contains the initial state information
Resumed [Text]	Response to a `Resume` gateway command
ChannelCreate Channel	new guild channel created
ChannelUpdate Channel	channel was updated
ChannelDelete Channel	channel was deleted
ThreadCreate Channel	thread created, also sent when being added to a private thread
ThreadUpdate Channel	thread was updated
ThreadMemberUpdate ThreadMemberUpdateFields	thread member for the current user was updated
ThreadDelete Channel	thread was deleted
ThreadListSync ThreadListSyncFields	sent when gaining access to a channel, contains all active threads in that channel
ThreadMembersUpdate ThreadMembersUpdateFields	member or the current user was added or removed from a thread
ChannelPinsUpdate ChannelId (Maybe UTCTime)	message was pinned or unpinned
GuildCreate Guild GuildCreateData	lazy-load for unavailable guild, guild became available, or user joined a new guild
GuildUpdate Guild	guild was updated
GuildDelete GuildUnavailable	guild became unavailable, or user left/was removed from a guild
GuildBanAdd GuildId User	user was banned from a guild
GuildBanRemove GuildId User	user was unbanned from a guild
GuildEmojiUpdate GuildId [Emoji]	guild emojis were updated
GuildIntegrationsUpdate GuildId	guild integration was updated
GuildMemberAdd GuildId GuildMember	new user joined a guild
GuildMemberRemove GuildId User	user was removed from a guild
GuildMemberUpdate GuildId [RoleId] User (Maybe Text)	guild member was updated
GuildMemberChunk GuildId [GuildMember]	response to `Request Guild Members` gateway command
GuildRoleCreate GuildId Role	guild role was created
GuildRoleUpdate GuildId Role	guild role was updated
GuildRoleDelete GuildId RoleId	guild role was deleted
MessageCreate Message	message was created
MessageUpdate ChannelId MessageId	message was updated
MessageDelete ChannelId MessageId	message was deleted
MessageDeleteBulk ChannelId [MessageId]	multiple messages were deleted at once
MessageReactionAdd ReactionInfo	user reacted to a message
MessageReactionRemove ReactionInfo	user removed a reaction from a message
MessageReactionRemoveAll ChannelId MessageId	all reactions were explicitly removed from a message
MessageReactionRemoveEmoji ReactionRemoveInfo	all reactions for a given emoji were explicitly removed from a message
PresenceUpdate PresenceInfo	user was updated
TypingStart TypingInfo	user started typing in a channel
UserUpdate User	properties about the user changed
InteractionCreate Interaction	someone joined, left, or moved a voice channel
UnknownEvent Text Object	An Unknown Event, none of the others

Instances

Instances details

Show Event Source #
Instance details Defined in Discord.Internal.Types.Events Methods showsPrec :: Int -> Event -> ShowS # show :: Event -> String # showList :: [Event] -> ShowS #
Eq Event Source #
Instance details Defined in Discord.Internal.Types.Events Methods (==) :: Event -> Event -> Bool # (/=) :: Event -> Event -> Bool #

data EventInternalParse Source #

Internal Event representation. Each matches to the corresponding constructor of Event.

An application should never have to use those directly

Constructors

InternalReady Int User [GuildUnavailable] Text HostName (Maybe Shard) PartialApplication
InternalResumed [Text]
InternalChannelCreate Channel
InternalChannelUpdate Channel
InternalChannelDelete Channel
InternalThreadCreate Channel
InternalThreadUpdate Channel
InternalThreadMemberUpdate ThreadMemberUpdateFields
InternalThreadDelete Channel
InternalThreadListSync ThreadListSyncFields
InternalThreadMembersUpdate ThreadMembersUpdateFields
InternalChannelPinsUpdate ChannelId (Maybe UTCTime)
InternalGuildCreate Guild GuildCreateData
InternalGuildUpdate Guild
InternalGuildDelete GuildUnavailable
InternalGuildBanAdd GuildId User
InternalGuildBanRemove GuildId User
InternalGuildEmojiUpdate GuildId [Emoji]
InternalGuildIntegrationsUpdate GuildId
InternalGuildMemberAdd GuildId GuildMember
InternalGuildMemberRemove GuildId User
InternalGuildMemberUpdate GuildId [RoleId] User (Maybe Text)
InternalGuildMemberChunk GuildId [GuildMember]
InternalGuildRoleCreate GuildId Role
InternalGuildRoleUpdate GuildId Role
InternalGuildRoleDelete GuildId RoleId
InternalMessageCreate Message
InternalMessageUpdate ChannelId MessageId
InternalMessageDelete ChannelId MessageId
InternalMessageDeleteBulk ChannelId [MessageId]
InternalMessageReactionAdd ReactionInfo
InternalMessageReactionRemove ReactionInfo
InternalMessageReactionRemoveAll ChannelId MessageId
InternalMessageReactionRemoveEmoji ReactionRemoveInfo
InternalPresenceUpdate PresenceInfo
InternalTypingStart TypingInfo
InternalUserUpdate User
InternalInteractionCreate Interaction
InternalUnknownEvent Text Object

Instances

Instances details

Read EventInternalParse Source #
Instance details Defined in Discord.Internal.Types.Events Methods readsPrec :: Int -> ReadS EventInternalParse # readList :: ReadS [EventInternalParse] # readPrec :: ReadPrec EventInternalParse # readListPrec :: ReadPrec [EventInternalParse] #
Show EventInternalParse Source #
Instance details Defined in Discord.Internal.Types.Events Methods showsPrec :: Int -> EventInternalParse -> ShowS # show :: EventInternalParse -> String # showList :: [EventInternalParse] -> ShowS #
Eq EventInternalParse Source #
Instance details Defined in Discord.Internal.Types.Events Methods (==) :: EventInternalParse -> EventInternalParse -> Bool # (/=) :: EventInternalParse -> EventInternalParse -> Bool #

data PartialApplication Source #

Structure containing partial information about an Application

Constructors

PartialApplication
Fields partialApplicationID :: ApplicationId partialApplicationFlags :: Int

Instances

Instances details

FromJSON PartialApplication Source #
Instance details Defined in Discord.Internal.Types.Events Methods parseJSON :: Value -> Parser PartialApplication # parseJSONList :: Value -> Parser [PartialApplication] # omittedField :: Maybe PartialApplication #
Read PartialApplication Source #
Instance details Defined in Discord.Internal.Types.Events Methods readsPrec :: Int -> ReadS PartialApplication # readList :: ReadS [PartialApplication] # readPrec :: ReadPrec PartialApplication # readListPrec :: ReadPrec [PartialApplication] #
Show PartialApplication Source #
Instance details Defined in Discord.Internal.Types.Events Methods showsPrec :: Int -> PartialApplication -> ShowS # show :: PartialApplication -> String # showList :: [PartialApplication] -> ShowS #
Eq PartialApplication Source #
Instance details Defined in Discord.Internal.Types.Events Methods (==) :: PartialApplication -> PartialApplication -> Bool # (/=) :: PartialApplication -> PartialApplication -> Bool #

data GuildCreateData Source #

Constructors

GuildCreateData
Fields guildCreateJoinedAt :: !UTCTime guildCreateLarge :: !Bool guildCreateUnavailable :: !(Maybe Bool) guildCreateMemberCount :: !Int guildCreateMembers :: ![GuildMember] guildCreateChannels :: ![Channel] guildCreateThreads :: ![Channel] guildCreatePresences :: ![PresenceInfo] guildCreateScheduledEvents :: ![ScheduledEvent]

Instances

Instances details

Read GuildCreateData Source #
Instance details Defined in Discord.Internal.Types.Events Methods readsPrec :: Int -> ReadS GuildCreateData # readList :: ReadS [GuildCreateData] # readPrec :: ReadPrec GuildCreateData # readListPrec :: ReadPrec [GuildCreateData] #
Show GuildCreateData Source #
Instance details Defined in Discord.Internal.Types.Events Methods showsPrec :: Int -> GuildCreateData -> ShowS # show :: GuildCreateData -> String # showList :: [GuildCreateData] -> ShowS #
Eq GuildCreateData Source #
Instance details Defined in Discord.Internal.Types.Events Methods (==) :: GuildCreateData -> GuildCreateData -> Bool # (/=) :: GuildCreateData -> GuildCreateData -> Bool #

parseGuildCreate :: Object -> Parser EventInternalParse Source #

data ReactionInfo Source #

Structure containing information about a reaction

Constructors

ReactionInfo
Fields reactionUserId :: UserId User who reacted reactionGuildId :: Maybe GuildId Guild in which the reacted message is (if any) reactionChannelId :: ChannelId Channel in which the reacted message is reactionMessageId :: MessageId The reacted message reactionEmoji :: Emoji The Emoji used for the reaction

Instances

Instances details

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

data ReactionRemoveInfo Source #

Structure containing information about a reaction that has been removed

Constructors

ReactionRemoveInfo
Fields reactionRemoveChannelId :: ChannelId reactionRemoveGuildId :: GuildId reactionRemoveMessageId :: MessageId reactionRemoveEmoji :: Emoji

Instances

Instances details

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

data TypingInfo Source #

Structre containing typing status information

Constructors

TypingInfo
Fields typingUserId :: UserId typingChannelId :: ChannelId typingTimestamp :: UTCTime

Instances

Instances details

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

reparse :: (ToJSON a, FromJSON b) => a -> Parser b Source #

Convert ToJSON value to FromJSON value

extractHostname :: String -> HostName Source #

Remove the "wss://" and the trailing slash in a gateway URL, thereby returning the hostname portion of the URL that we can connect to.

eventParse :: Text -> Object -> Parser EventInternalParse Source #

Parse an event from name and JSON data