Discord

Documentation

module Discord.Types

module Discord.Rest.Channel

module Discord.Rest.Guild

module Discord.Rest.User

module Discord.Rest.Emoji

data Cache

Constructors

Cache

Fields

• _currentUser :: User
• _dmChannels :: Map Snowflake Channel
• _guilds :: Map Snowflake (Guild, GuildInfo)
• _channels :: Map Snowflake Channel

Instances

Show Cache

Methods

showsPrec :: Int -> Cache -> ShowS

show :: Cache -> String

showList :: [Cache] -> ShowS

data Gateway

Concurrency primitives that make up the gateway. Build a higher level interface over these

Constructors

Gateway

Fields

• _events :: Chan (Either GatewayException Event)
• _cache :: MVar (Either GatewayException Cache)
• _gatewayCommands :: Chan GatewaySendable

newtype RestChan

Constructors

RestChan (Chan (String, JsonRequest, MVar (Either RestCallException ByteString)))

data RestCallException

Constructors

RestCallErrorCode Int ByteString

RestCallNoParse String ByteString

RestCallHttpException HttpException

Instances

Show RestCallException

Methods

showsPrec :: Int -> RestCallException -> ShowS

show :: RestCallException -> String

showList :: [RestCallException] -> ShowS

data GatewayException

Constructors

GatewayExceptionCouldNotConnect Text

GatewayExceptionEventParseError String Text

GatewayExceptionUnexpected GatewayReceivable Text

GatewayExceptionConnection ConnectionException Text

Instances

Show GatewayException

Methods

showsPrec :: Int -> GatewayException -> ShowS

show :: GatewayException -> String

showList :: [GatewayException] -> ShowS

class Request a where

Minimal complete definition

majorRoute, jsonRequest

Methods

majorRoute :: a -> String

jsonRequest :: a -> JsonRequest

Instances

Request (UserRequest a)

Methods

majorRoute :: UserRequest a -> String

jsonRequest :: UserRequest a -> JsonRequest

Request (GuildRequest a)

Methods

majorRoute :: GuildRequest a -> String

jsonRequest :: GuildRequest a -> JsonRequest

Request (EmojiRequest a)

Methods

majorRoute :: EmojiRequest a -> String

jsonRequest :: EmojiRequest a -> JsonRequest

Request (ChannelRequest a)

Methods

majorRoute :: ChannelRequest a -> String

jsonRequest :: ChannelRequest a -> JsonRequest

data ThreadIdType

Thread Ids marked by what type they are

Constructors

ThreadRest ThreadId

ThreadGateway ThreadId

ThreadLogger ThreadId

restCall :: (FromJSON a, Request (r a)) => (RestChan, y, z) -> r a -> IO (Either RestCallException a)

Execute one http request and get a response

nextEvent :: (x, Gateway, z) -> IO (Either GatewayException Event)

Block until the gateway produces another event. Once an exception is returned, only return that exception

sendCommand :: (x, Gateway, z) -> GatewaySendable -> IO ()

Send a GatewaySendable, but not Heartbeat, Identify, or Resume

readCache :: (RestChan, Gateway, z) -> IO (Either GatewayException Cache)

Access the current state of the gateway cache

stopDiscord :: (x, y, [ThreadIdType]) -> IO ()

Stop all the background threads

loginRest :: Auth -> IO (RestChan, NotLoggedIntoGateway, [ThreadIdType])

Start HTTP rest handler background threads

loginRestGateway :: Auth -> IO (RestChan, Gateway, [ThreadIdType])

Start HTTP rest handler and gateway background threads