Discord.Internal.Types.Gateway

Data structures needed for interfacing with the Websocket Gateway

Documentation

data GatewayReceivable

Messages that can be sent by gateway to the library

Constructors

Dispatch EventInternalParse Integer

HeartbeatRequest Integer

Reconnect

InvalidSession Bool

Hello Integer

HeartbeatAck

ParseError Text

Instances

FromJSON GatewayReceivable

Defined in Discord.Internal.Types.Gateway

Methods

parseJSON :: Value -> Parser GatewayReceivable

parseJSONList :: Value -> Parser [GatewayReceivable]

omittedField :: Maybe GatewayReceivable

Read GatewayReceivable

Defined in Discord.Internal.Types.Gateway

Methods

readsPrec :: Int -> ReadS GatewayReceivable

readList :: ReadS [GatewayReceivable]

readPrec :: ReadPrec GatewayReceivable

readListPrec :: ReadPrec [GatewayReceivable]

Show GatewayReceivable

Defined in Discord.Internal.Types.Gateway

Methods

showsPrec :: Int -> GatewayReceivable -> ShowS

show :: GatewayReceivable -> String

showList :: [GatewayReceivable] -> ShowS

Eq GatewayReceivable

Defined in Discord.Internal.Types.Gateway

Methods

(==) :: GatewayReceivable -> GatewayReceivable -> Bool

(/=) :: GatewayReceivable -> GatewayReceivable -> Bool

data GatewaySendableInternal

Sent to gateway by our library

Constructors

Heartbeat Integer

Identify Auth GatewayIntent (Int, Int)

Resume Auth Text Integer

Instances

ToJSON GatewaySendableInternal

Defined in Discord.Internal.Types.Gateway

Methods

toJSON :: GatewaySendableInternal -> Value

toEncoding :: GatewaySendableInternal -> Encoding

toJSONList :: [GatewaySendableInternal] -> Value

toEncodingList :: [GatewaySendableInternal] -> Encoding

omitField :: GatewaySendableInternal -> Bool

Read GatewaySendableInternal

Defined in Discord.Internal.Types.Gateway

Methods

readsPrec :: Int -> ReadS GatewaySendableInternal

readList :: ReadS [GatewaySendableInternal]

readPrec :: ReadPrec GatewaySendableInternal

readListPrec :: ReadPrec [GatewaySendableInternal]

Show GatewaySendableInternal

Defined in Discord.Internal.Types.Gateway

Methods

showsPrec :: Int -> GatewaySendableInternal -> ShowS

show :: GatewaySendableInternal -> String

showList :: [GatewaySendableInternal] -> ShowS

Eq GatewaySendableInternal

Defined in Discord.Internal.Types.Gateway

Methods

(==) :: GatewaySendableInternal -> GatewaySendableInternal -> Bool

(/=) :: GatewaySendableInternal -> GatewaySendableInternal -> Bool

Ord GatewaySendableInternal

Defined in Discord.Internal.Types.Gateway

Methods

compare :: GatewaySendableInternal -> GatewaySendableInternal -> Ordering

(<) :: GatewaySendableInternal -> GatewaySendableInternal -> Bool

(<=) :: GatewaySendableInternal -> GatewaySendableInternal -> Bool

(>) :: GatewaySendableInternal -> GatewaySendableInternal -> Bool

(>=) :: GatewaySendableInternal -> GatewaySendableInternal -> Bool

max :: GatewaySendableInternal -> GatewaySendableInternal -> GatewaySendableInternal

min :: GatewaySendableInternal -> GatewaySendableInternal -> GatewaySendableInternal

data GatewayIntent

Gateway intents to subrscribe to

Details of which intent englobs what data is avalilable at the official Discord documentation

Constructors

GatewayIntent

Fields

• gatewayIntentGuilds :: Bool
• gatewayIntentMembers :: Bool
• gatewayIntentBans :: Bool
• gatewayIntentEmojis :: Bool
• gatewayIntentIntegrations :: Bool
• gatewayIntentWebhooks :: Bool
• gatewayIntentInvites :: Bool
• gatewayIntentVoiceStates :: Bool
• gatewayIntentPresences :: Bool
• gatewayIntentMessageChanges :: Bool
• gatewayIntentMessageReactions :: Bool
• gatewayIntentMessageTyping :: Bool
• gatewayIntentDirectMessageChanges :: Bool
• gatewayIntentDirectMessageReactions :: Bool
• gatewayIntentDirectMessageTyping :: Bool
• gatewayIntentMessageContent :: Bool
• gatewayIntentAutoModerationConfiguration :: Bool
• gatewayIntentAutoModerationExecution :: Bool

Instances

Read GatewayIntent

Defined in Discord.Internal.Types.Gateway

Methods

readsPrec :: Int -> ReadS GatewayIntent

readList :: ReadS [GatewayIntent]

readPrec :: ReadPrec GatewayIntent

readListPrec :: ReadPrec [GatewayIntent]

Show GatewayIntent

Defined in Discord.Internal.Types.Gateway

Methods

showsPrec :: Int -> GatewayIntent -> ShowS

show :: GatewayIntent -> String

showList :: [GatewayIntent] -> ShowS

Default GatewayIntent

Defined in Discord.Internal.Types.Gateway

Methods

def :: GatewayIntent

Eq GatewayIntent

Defined in Discord.Internal.Types.Gateway

Methods

(==) :: GatewayIntent -> GatewayIntent -> Bool

(/=) :: GatewayIntent -> GatewayIntent -> Bool

Ord GatewayIntent

Defined in Discord.Internal.Types.Gateway

Methods

compare :: GatewayIntent -> GatewayIntent -> Ordering

(<) :: GatewayIntent -> GatewayIntent -> Bool

(<=) :: GatewayIntent -> GatewayIntent -> Bool

(>) :: GatewayIntent -> GatewayIntent -> Bool

(>=) :: GatewayIntent -> GatewayIntent -> Bool

max :: GatewayIntent -> GatewayIntent -> GatewayIntent

min :: GatewayIntent -> GatewayIntent -> GatewayIntent

compileGatewayIntent :: GatewayIntent -> Int

data GatewaySendable

Sent to gateway by a user

Constructors

RequestGuildMembers RequestGuildMembersOpts

UpdateStatus UpdateStatusOpts

UpdateStatusVoice UpdateStatusVoiceOpts

Instances

ToJSON GatewaySendable

Defined in Discord.Internal.Types.Gateway

Methods

toJSON :: GatewaySendable -> Value

toEncoding :: GatewaySendable -> Encoding

toJSONList :: [GatewaySendable] -> Value

toEncodingList :: [GatewaySendable] -> Encoding

omitField :: GatewaySendable -> Bool

Read GatewaySendable

Defined in Discord.Internal.Types.Gateway

Methods

readsPrec :: Int -> ReadS GatewaySendable

readList :: ReadS [GatewaySendable]

readPrec :: ReadPrec GatewaySendable

readListPrec :: ReadPrec [GatewaySendable]

Show GatewaySendable

Defined in Discord.Internal.Types.Gateway

Methods

showsPrec :: Int -> GatewaySendable -> ShowS

show :: GatewaySendable -> String

showList :: [GatewaySendable] -> ShowS

Eq GatewaySendable

Defined in Discord.Internal.Types.Gateway

Methods

(==) :: GatewaySendable -> GatewaySendable -> Bool

(/=) :: GatewaySendable -> GatewaySendable -> Bool

Ord GatewaySendable

Defined in Discord.Internal.Types.Gateway

Methods

compare :: GatewaySendable -> GatewaySendable -> Ordering

(<) :: GatewaySendable -> GatewaySendable -> Bool

(<=) :: GatewaySendable -> GatewaySendable -> Bool

(>) :: GatewaySendable -> GatewaySendable -> Bool

(>=) :: GatewaySendable -> GatewaySendable -> Bool

max :: GatewaySendable -> GatewaySendable -> GatewaySendable

min :: GatewaySendable -> GatewaySendable -> GatewaySendable

data RequestGuildMembersOpts

Options for RequestGuildMembers

Constructors

RequestGuildMembersOpts

Fields

• requestGuildMembersOptsGuildId :: GuildId
• requestGuildMembersOptsNamesStartingWith :: Text
• requestGuildMembersOptsLimit :: Integer

Instances

Read RequestGuildMembersOpts

Defined in Discord.Internal.Types.Gateway

Methods

readsPrec :: Int -> ReadS RequestGuildMembersOpts

readList :: ReadS [RequestGuildMembersOpts]

readPrec :: ReadPrec RequestGuildMembersOpts

readListPrec :: ReadPrec [RequestGuildMembersOpts]

Show RequestGuildMembersOpts

Defined in Discord.Internal.Types.Gateway

Methods

showsPrec :: Int -> RequestGuildMembersOpts -> ShowS

show :: RequestGuildMembersOpts -> String

showList :: [RequestGuildMembersOpts] -> ShowS

Eq RequestGuildMembersOpts

Defined in Discord.Internal.Types.Gateway

Methods

(==) :: RequestGuildMembersOpts -> RequestGuildMembersOpts -> Bool

(/=) :: RequestGuildMembersOpts -> RequestGuildMembersOpts -> Bool

Ord RequestGuildMembersOpts

Defined in Discord.Internal.Types.Gateway

Methods

compare :: RequestGuildMembersOpts -> RequestGuildMembersOpts -> Ordering

(<) :: RequestGuildMembersOpts -> RequestGuildMembersOpts -> Bool

(<=) :: RequestGuildMembersOpts -> RequestGuildMembersOpts -> Bool

(>) :: RequestGuildMembersOpts -> RequestGuildMembersOpts -> Bool

(>=) :: RequestGuildMembersOpts -> RequestGuildMembersOpts -> Bool

max :: RequestGuildMembersOpts -> RequestGuildMembersOpts -> RequestGuildMembersOpts

min :: RequestGuildMembersOpts -> RequestGuildMembersOpts -> RequestGuildMembersOpts

data UpdateStatusVoiceOpts

Options for UpdateStatusVoice

Constructors

UpdateStatusVoiceOpts

Fields

• updateStatusVoiceOptsGuildId :: GuildId
• updateStatusVoiceOptsChannelId :: Maybe ChannelId
• updateStatusVoiceOptsIsMuted :: Bool
• updateStatusVoiceOptsIsDeaf :: Bool

Instances

Read UpdateStatusVoiceOpts

Defined in Discord.Internal.Types.Gateway

Methods

readsPrec :: Int -> ReadS UpdateStatusVoiceOpts

readList :: ReadS [UpdateStatusVoiceOpts]

readPrec :: ReadPrec UpdateStatusVoiceOpts

readListPrec :: ReadPrec [UpdateStatusVoiceOpts]

Show UpdateStatusVoiceOpts

Defined in Discord.Internal.Types.Gateway

Methods

showsPrec :: Int -> UpdateStatusVoiceOpts -> ShowS

show :: UpdateStatusVoiceOpts -> String

showList :: [UpdateStatusVoiceOpts] -> ShowS

Eq UpdateStatusVoiceOpts

Defined in Discord.Internal.Types.Gateway

Methods

(==) :: UpdateStatusVoiceOpts -> UpdateStatusVoiceOpts -> Bool

(/=) :: UpdateStatusVoiceOpts -> UpdateStatusVoiceOpts -> Bool

Ord UpdateStatusVoiceOpts

Defined in Discord.Internal.Types.Gateway

Methods

compare :: UpdateStatusVoiceOpts -> UpdateStatusVoiceOpts -> Ordering

(<) :: UpdateStatusVoiceOpts -> UpdateStatusVoiceOpts -> Bool

(<=) :: UpdateStatusVoiceOpts -> UpdateStatusVoiceOpts -> Bool

(>) :: UpdateStatusVoiceOpts -> UpdateStatusVoiceOpts -> Bool

(>=) :: UpdateStatusVoiceOpts -> UpdateStatusVoiceOpts -> Bool

max :: UpdateStatusVoiceOpts -> UpdateStatusVoiceOpts -> UpdateStatusVoiceOpts

min :: UpdateStatusVoiceOpts -> UpdateStatusVoiceOpts -> UpdateStatusVoiceOpts

data UpdateStatusOpts

Options for UpdateStatus Presence Update - https://discord.com/developers/docs/topics/gateway-events#update-presence

Constructors

UpdateStatusOpts

Fields

• updateStatusOptsSince :: Maybe UTCTime
• updateStatusOptsActivities :: [Activity]
• updateStatusOptsNewStatus :: UpdateStatusType
• updateStatusOptsAFK :: Bool

Instances

Read UpdateStatusOpts

Defined in Discord.Internal.Types.Gateway

Methods

readsPrec :: Int -> ReadS UpdateStatusOpts

readList :: ReadS [UpdateStatusOpts]

readPrec :: ReadPrec UpdateStatusOpts

readListPrec :: ReadPrec [UpdateStatusOpts]

Show UpdateStatusOpts

Defined in Discord.Internal.Types.Gateway

Methods

showsPrec :: Int -> UpdateStatusOpts -> ShowS

show :: UpdateStatusOpts -> String

showList :: [UpdateStatusOpts] -> ShowS

Eq UpdateStatusOpts

Defined in Discord.Internal.Types.Gateway

Methods

(==) :: UpdateStatusOpts -> UpdateStatusOpts -> Bool

(/=) :: UpdateStatusOpts -> UpdateStatusOpts -> Bool

Ord UpdateStatusOpts

Defined in Discord.Internal.Types.Gateway

Methods

compare :: UpdateStatusOpts -> UpdateStatusOpts -> Ordering

(<) :: UpdateStatusOpts -> UpdateStatusOpts -> Bool

(<=) :: UpdateStatusOpts -> UpdateStatusOpts -> Bool

(>) :: UpdateStatusOpts -> UpdateStatusOpts -> Bool

(>=) :: UpdateStatusOpts -> UpdateStatusOpts -> Bool

max :: UpdateStatusOpts -> UpdateStatusOpts -> UpdateStatusOpts

min :: UpdateStatusOpts -> UpdateStatusOpts -> UpdateStatusOpts

data UpdateStatusType

Possible values for updateStatusOptsNewStatus

Constructors

UpdateStatusOnline

UpdateStatusDoNotDisturb

UpdateStatusAwayFromKeyboard

UpdateStatusInvisibleOffline

UpdateStatusOffline

Instances

Enum UpdateStatusType

Defined in Discord.Internal.Types.Gateway

Methods

succ :: UpdateStatusType -> UpdateStatusType

pred :: UpdateStatusType -> UpdateStatusType

toEnum :: Int -> UpdateStatusType

fromEnum :: UpdateStatusType -> Int

enumFrom :: UpdateStatusType -> [UpdateStatusType]

enumFromThen :: UpdateStatusType -> UpdateStatusType -> [UpdateStatusType]

enumFromTo :: UpdateStatusType -> UpdateStatusType -> [UpdateStatusType]

enumFromThenTo :: UpdateStatusType -> UpdateStatusType -> UpdateStatusType -> [UpdateStatusType]

Read UpdateStatusType

Defined in Discord.Internal.Types.Gateway

Methods

readsPrec :: Int -> ReadS UpdateStatusType

readList :: ReadS [UpdateStatusType]

readPrec :: ReadPrec UpdateStatusType

readListPrec :: ReadPrec [UpdateStatusType]

Show UpdateStatusType

Defined in Discord.Internal.Types.Gateway

Methods

showsPrec :: Int -> UpdateStatusType -> ShowS

show :: UpdateStatusType -> String

showList :: [UpdateStatusType] -> ShowS

Eq UpdateStatusType

Defined in Discord.Internal.Types.Gateway

Methods

(==) :: UpdateStatusType -> UpdateStatusType -> Bool

(/=) :: UpdateStatusType -> UpdateStatusType -> Bool

Ord UpdateStatusType

Defined in Discord.Internal.Types.Gateway

Methods

compare :: UpdateStatusType -> UpdateStatusType -> Ordering

(<) :: UpdateStatusType -> UpdateStatusType -> Bool

(<=) :: UpdateStatusType -> UpdateStatusType -> Bool

(>) :: UpdateStatusType -> UpdateStatusType -> Bool

(>=) :: UpdateStatusType -> UpdateStatusType -> Bool

max :: UpdateStatusType -> UpdateStatusType -> UpdateStatusType

min :: UpdateStatusType -> UpdateStatusType -> UpdateStatusType

statusString :: UpdateStatusType -> Text

Converts an UpdateStatusType to a textual representation