Network.Discord.Rest

Provides framework to interact with REST api gateways. Implementations specific to the Discord API are provided in Network.Discord.Rest.Channel, Network.Discord.Rest.Guild, and Network.Discord.Rest.User.

Documentation

fetch :: (DoFetch a, Hashable a) => a -> Proxy X () c' c DiscordM Fetched

Perform an API request.

fetch' :: (DoFetch a, Hashable a) => a -> Proxy X () c' c DiscordM ()

Perform an API request, ignoring the response

withApi :: Client Fetchable Fetched DiscordM Fetched -> Effect DiscordM ()

Alternative method of interacting with the REST api

restServer :: Fetchable -> Server Fetchable Fetched DiscordM Fetched

Provides a pipe to perform REST actions

getGateway :: IO URL

Obtains a new gateway to connect to.

readInteger :: String -> Integer

Read function specialized for Integers

baseURL :: String

The base url for API requests

baseRequest :: DiscordM Options

Construct base request with auth from Discord state

class RateLimit a where

Class for rate-limitable actions

Minimal complete definition

getRateLimit, setRateLimit

Methods

getRateLimit :: a -> DiscordM (Maybe Int)

Return seconds to expiration if we're waiting for a rate limit to reset

setRateLimit :: a -> Int -> DiscordM ()

Set seconds to the next rate limit reset when we hit a rate limit

waitRateLimit :: a -> DiscordM ()

If we hit a rate limit, wait for it to reset

Instances

RateLimit (UserRequest a)

Methods

getRateLimit :: UserRequest a -> DiscordM (Maybe Int)

setRateLimit :: UserRequest a -> Int -> DiscordM ()

waitRateLimit :: UserRequest a -> DiscordM ()

RateLimit (GuildRequest a)

Methods

getRateLimit :: GuildRequest a -> DiscordM (Maybe Int)

setRateLimit :: GuildRequest a -> Int -> DiscordM ()

waitRateLimit :: GuildRequest a -> DiscordM ()

RateLimit (ChannelRequest a)

Methods

getRateLimit :: ChannelRequest a -> DiscordM (Maybe Int)

setRateLimit :: ChannelRequest a -> Int -> DiscordM ()

waitRateLimit :: ChannelRequest a -> DiscordM ()

class DoFetch a where

Class over which performing a data retrieval action is defined

Minimal complete definition

doFetch

Methods

doFetch :: a -> DiscordM Fetched

Instances

DoFetch Fetchable

Methods

doFetch :: Fetchable -> DiscordM Fetched

FromJSON a => DoFetch (UserRequest a)

Methods

doFetch :: UserRequest a -> DiscordM Fetched

FromJSON a => DoFetch (GuildRequest a)

Methods

doFetch :: GuildRequest a -> DiscordM Fetched

FromJSON a => DoFetch (ChannelRequest a)

Methods

doFetch :: ChannelRequest a -> DiscordM Fetched

data Fetchable

Polymorphic type for all DoFetch types

Constructors

(DoFetch a, Hashable a) => Fetch a

Instances

Eq Fetchable

Methods

(==) :: Fetchable -> Fetchable -> Bool

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

Hashable Fetchable

Methods

hashWithSalt :: Int -> Fetchable -> Int

hash :: Fetchable -> Int

DoFetch Fetchable

Methods

doFetch :: Fetchable -> DiscordM Fetched

data Fetched

Result of a data retrieval action

Constructors

FromJSON a => SyncFetched a

data Range

Represents a range of Snowflakes

Constructors

Range

Fields

• after :: Snowflake
• before :: Snowflake
• limit :: Int

Instances

Default Range

Methods

def :: Range

toQueryString :: Range -> String

Convert a Range to a query string

module Network.Discord.Rest.Channel

module Network.Discord.Rest.Guild

module Network.Discord.Rest.User