Discord

Documentation

module Discord.Types

module Discord.Rest.Channel

module Discord.Rest.Guild

module Discord.Rest.User

module Discord.Rest.Invite

module Discord.Rest.Emoji

data Cache

Constructors

Cache

Fields

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

Instances

Show Cache

Defined in Discord.Gateway.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 ByteString

RestCallNoParse String ByteString

RestCallHttpException HttpException

Instances

Show RestCallException

Defined in Discord.Rest.HTTP

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

Defined in Discord.Gateway.EventLoop

Methods

showsPrec :: Int -> GatewayException -> ShowS

show :: GatewayException -> String

showList :: [GatewayException] -> ShowS

class Request a where

Methods

majorRoute :: a -> String

jsonRequest :: a -> JsonRequest

Instances

Request (UserRequest a)

Defined in Discord.Rest.User

Methods

majorRoute :: UserRequest a -> String

jsonRequest :: UserRequest a -> JsonRequest

Request (InviteRequest a)

Defined in Discord.Rest.Invite

Methods

majorRoute :: InviteRequest a -> String

jsonRequest :: InviteRequest a -> JsonRequest

Request (GuildRequest a)

Defined in Discord.Rest.Guild

Methods

majorRoute :: GuildRequest a -> String

jsonRequest :: GuildRequest a -> JsonRequest

Request (EmojiRequest a)

Defined in Discord.Rest.Emoji

Methods

majorRoute :: EmojiRequest a -> String

jsonRequest :: EmojiRequest a -> JsonRequest

Request (ChannelRequest a)

Defined in Discord.Rest.Channel

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