Calamity.Client.Types

Types for the client

Documentation

data Client

Constructors

Client

Fields

• shards :: TVar [(InChan ControlMessage, Async (Maybe ()))]
• numShards :: MVar Int
• token :: Token
• rlState :: RateLimitState
• eventsIn :: InChan CalamityEvent
• eventsOut :: OutChan CalamityEvent
• ehidCounter :: IORef Integer
• initialDi :: Maybe (Di Level Path Message)

Instances

Generic Client

Defined in Calamity.Client.Types

Associated Types

type Rep Client :: Type -> Type

Methods

from :: Client -> Rep Client x

to :: Rep Client x -> Client

type Rep Client

Defined in Calamity.Client.Types

type Rep Client = D1 ('MetaData "Client" "Calamity.Client.Types" "calamity-0.1.26.0-8Rbyh2JfYBvC9UHgZLNZiA" 'False) (C1 ('MetaCons "Client" 'PrefixI 'True) (((S1 ('MetaSel ('Just "shards") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (TVar [(InChan ControlMessage, Async (Maybe ()))])) :*: S1 ('MetaSel ('Just "numShards") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (MVar Int))) :*: (S1 ('MetaSel ('Just "token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Token) :*: S1 ('MetaSel ('Just "rlState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RateLimitState))) :*: ((S1 ('MetaSel ('Just "eventsIn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (InChan CalamityEvent)) :*: S1 ('MetaSel ('Just "eventsOut") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (OutChan CalamityEvent))) :*: (S1 ('MetaSel ('Just "ehidCounter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (IORef Integer)) :*: S1 ('MetaSel ('Just "initialDi") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Di Level Path Message)))))))

newtype StartupError

Constructors

StartupError String

Instances

Show StartupError

Defined in Calamity.Client.Types

Methods

showsPrec :: Int -> StartupError -> ShowS

show :: StartupError -> String

showList :: [StartupError] -> ShowS

data EventType

A Data Kind used to fire custom events

Constructors

ReadyEvt

ChannelCreateEvt

ChannelUpdateEvt

ChannelDeleteEvt

ChannelpinsUpdateEvt

GuildCreateEvt

GuildUpdateEvt

GuildDeleteEvt

GuildBanAddEvt

GuildBanRemoveEvt

GuildEmojisUpdateEvt

GuildIntegrationsUpdateEvt

GuildMemberAddEvt

GuildMemberRemoveEvt

GuildMemberUpdateEvt

GuildMembersChunkEvt

GuildRoleCreateEvt

GuildRoleUpdateEvt

GuildRoleDeleteEvt

InviteCreateEvt

InviteDeleteEvt

MessageCreateEvt

MessageUpdateEvt

Fired when a cached message is updated, use RawMessageUpdateEvt to see updates of uncached messages

RawMessageUpdateEvt

Fired when a message is updated

MessageDeleteEvt

Fired when a cached message is deleted, use RawMessageDeleteEvt to see deletes of uncached messages.

Does not include messages deleted through bulk deletes, use MessageDeleteBulkEvt for those

RawMessageDeleteEvt

Fired when a message is deleted.

Does not include messages deleted through bulk deletes, use RawMessageDeleteBulkEvt for those

MessageDeleteBulkEvt

Fired when messages are bulk deleted. Only includes cached messages, use RawMessageDeleteBulkEvt to see deletes of uncached messages.

RawMessageDeleteBulkEvt

Fired when messages are bulk deleted.

MessageReactionAddEvt

Fired when a reaction is added to a cached message, use RawMessageReactionAddEvt to see reactions on uncached messages.

RawMessageReactionAddEvt

Fired when a reaction is added to a message.

MessageReactionRemoveEvt

Fired when a reaction is removed from a cached message, use RawMessageReactionRemoveEvt to see reactions on uncached messages.

RawMessageReactionRemoveEvt

Fired when a reaction is removed from a message.

MessageReactionRemoveAllEvt

Fired when all reactions are removed from a cached message, use RawMessageReactionRemoveEvt to see reactions on uncached messages.

The message passed will contain the removed events.

RawMessageReactionRemoveAllEvt

Fired when all reactions are removed from a message.

TypingStartEvt

UserUpdateEvt

VoiceStateUpdateEvt

Sent when someone joinsleavesmoves voice channels

forall s a. CustomEvt s a

A custom event, s is the name and a is the data sent to the handler

Instances

(EHInstanceSelector a ~ flag, RemoveEventHandler' flag a) => RemoveEventHandler (a :: EventType)

Defined in Calamity.Client.Types

Methods

removeEventHandler :: Proxy a -> Integer -> EventHandlers -> EventHandlers

data GuildCreateStatus

Constructors

GuildCreateNew

The guild was just joined

GuildCreateAvailable

The guild is becoming available

Instances

Show GuildCreateStatus

Defined in Calamity.Client.Types

Methods

showsPrec :: Int -> GuildCreateStatus -> ShowS

show :: GuildCreateStatus -> String

showList :: [GuildCreateStatus] -> ShowS

Generic GuildCreateStatus

Defined in Calamity.Client.Types

Associated Types

type Rep GuildCreateStatus :: Type -> Type

Methods

from :: GuildCreateStatus -> Rep GuildCreateStatus x

to :: Rep GuildCreateStatus x -> GuildCreateStatus

TextShow GuildCreateStatus

Defined in Calamity.Client.Types

Methods

showbPrec :: Int -> GuildCreateStatus -> Builder

showb :: GuildCreateStatus -> Builder

showbList :: [GuildCreateStatus] -> Builder

showtPrec :: Int -> GuildCreateStatus -> Text

showt :: GuildCreateStatus -> Text

showtList :: [GuildCreateStatus] -> Text

showtlPrec :: Int -> GuildCreateStatus -> Text

showtl :: GuildCreateStatus -> Text

showtlList :: [GuildCreateStatus] -> Text

type Rep GuildCreateStatus

Defined in Calamity.Client.Types

type Rep GuildCreateStatus = D1 ('MetaData "GuildCreateStatus" "Calamity.Client.Types" "calamity-0.1.26.0-8Rbyh2JfYBvC9UHgZLNZiA" 'False) (C1 ('MetaCons "GuildCreateNew" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "GuildCreateAvailable" 'PrefixI 'False) (U1 :: Type -> Type))

data GuildDeleteStatus

Constructors

GuildDeleteUnavailable

The guild became unavailable

GuildDeleteRemoved

The bot was removed from the guild

Instances

Show GuildDeleteStatus

Defined in Calamity.Client.Types

Methods

showsPrec :: Int -> GuildDeleteStatus -> ShowS

show :: GuildDeleteStatus -> String

showList :: [GuildDeleteStatus] -> ShowS

Generic GuildDeleteStatus

Defined in Calamity.Client.Types

Associated Types

type Rep GuildDeleteStatus :: Type -> Type

Methods

from :: GuildDeleteStatus -> Rep GuildDeleteStatus x

to :: Rep GuildDeleteStatus x -> GuildDeleteStatus

TextShow GuildDeleteStatus

Defined in Calamity.Client.Types

Methods

showbPrec :: Int -> GuildDeleteStatus -> Builder

showb :: GuildDeleteStatus -> Builder

showbList :: [GuildDeleteStatus] -> Builder

showtPrec :: Int -> GuildDeleteStatus -> Text

showt :: GuildDeleteStatus -> Text

showtList :: [GuildDeleteStatus] -> Text

showtlPrec :: Int -> GuildDeleteStatus -> Text

showtl :: GuildDeleteStatus -> Text

showtlList :: [GuildDeleteStatus] -> Text

type Rep GuildDeleteStatus

Defined in Calamity.Client.Types

type Rep GuildDeleteStatus = D1 ('MetaData "GuildDeleteStatus" "Calamity.Client.Types" "calamity-0.1.26.0-8Rbyh2JfYBvC9UHgZLNZiA" 'False) (C1 ('MetaCons "GuildDeleteUnavailable" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "GuildDeleteRemoved" 'PrefixI 'False) (U1 :: Type -> Type))

type family EHType (d :: EventType) where ...

A type family to decide what the parameters for an event handler should be determined by the type of event it is handling.

Equations

EHType 'ReadyEvt = ReadyData

EHType 'ChannelCreateEvt = Channel

EHType 'ChannelUpdateEvt = (Channel, Channel)

EHType 'ChannelDeleteEvt = Channel

EHType 'ChannelpinsUpdateEvt = (Channel, Maybe UTCTime)

EHType 'GuildCreateEvt = (Guild, GuildCreateStatus)

EHType 'GuildUpdateEvt = (Guild, Guild)

EHType 'GuildDeleteEvt = (Guild, GuildDeleteStatus)

EHType 'GuildBanAddEvt = (Guild, User)

EHType 'GuildBanRemoveEvt = (Guild, User)

EHType 'GuildEmojisUpdateEvt = (Guild, [Emoji])

EHType 'GuildIntegrationsUpdateEvt = Guild

EHType 'GuildMemberAddEvt = Member

EHType 'GuildMemberRemoveEvt = Member

EHType 'GuildMemberUpdateEvt = (Member, Member)

EHType 'GuildMembersChunkEvt = (Guild, [Member])

EHType 'GuildRoleCreateEvt = (Guild, Role)

EHType 'GuildRoleUpdateEvt = (Guild, Role, Role)

EHType 'GuildRoleDeleteEvt = (Guild, Role)

EHType 'InviteCreateEvt = InviteCreateData

EHType 'InviteDeleteEvt = InviteDeleteData

EHType 'MessageCreateEvt = Message

EHType 'MessageUpdateEvt = (Message, Message)

EHType 'MessageDeleteEvt = Message

EHType 'MessageDeleteBulkEvt = [Message]

EHType 'MessageReactionAddEvt = (Message, Reaction)

EHType 'MessageReactionRemoveEvt = (Message, Reaction)

EHType 'MessageReactionRemoveAllEvt = Message

EHType 'RawMessageUpdateEvt = UpdatedMessage

EHType 'RawMessageDeleteEvt = Snowflake Message

EHType 'RawMessageDeleteBulkEvt = [Snowflake Message]

EHType 'RawMessageReactionAddEvt = Reaction

EHType 'RawMessageReactionRemoveEvt = Reaction

EHType 'RawMessageReactionRemoveAllEvt = Snowflake Message

EHType 'TypingStartEvt = (Channel, Snowflake User, UnixTimestamp)

EHType 'UserUpdateEvt = (User, User)

EHType 'VoiceStateUpdateEvt = (Maybe VoiceState, VoiceState)

EHType ('CustomEvt s a) = a

type BotC r = (Members '[LogEff, MetricEff, CacheEff, Reader Client, AtomicState EventHandlers, Embed IO, Final IO, Async] r, Typeable r)

type SetupEff r = Reader Client ': (AtomicState EventHandlers ': (Async ': r))

A concrete effect stack used inside the bot

type ReactConstraints s = (InsertEventHandler s, RemoveEventHandler s)

Some constraints that react needs to work. Don't worry about these since they are satisfied for any type s can be

newtype EventHandlers

Constructors

EventHandlers (TypeRepMap EventHandler)

Instances

Semigroup EventHandlers

Defined in Calamity.Client.Types

Methods

(<>) :: EventHandlers -> EventHandlers -> EventHandlers

sconcat :: NonEmpty EventHandlers -> EventHandlers

stimes :: Integral b => b -> EventHandlers -> EventHandlers

Monoid EventHandlers

Defined in Calamity.Client.Types

Methods

mempty :: EventHandlers

mappend :: EventHandlers -> EventHandlers -> EventHandlers

mconcat :: [EventHandlers] -> EventHandlers

Default EventHandlers

Defined in Calamity.Client.Types

Methods

def :: EventHandlers

class InsertEventHandler a where

A helper typeclass that is used to decide how to register regular events, and custom events which require storing in a map at runtime.

Methods

makeEventHandlers :: Proxy a -> Integer -> StoredEHType a -> EventHandlers

Instances

(EHInstanceSelector a ~ flag, InsertEventHandler' flag a) => InsertEventHandler a

Defined in Calamity.Client.Types

Methods

makeEventHandlers :: Proxy a -> Integer -> StoredEHType a -> EventHandlers

class RemoveEventHandler a where

Methods

removeEventHandler :: Proxy a -> Integer -> EventHandlers -> EventHandlers

Instances

(EHInstanceSelector a ~ flag, RemoveEventHandler' flag a) => RemoveEventHandler (a :: EventType)

Defined in Calamity.Client.Types

Methods

removeEventHandler :: Proxy a -> Integer -> EventHandlers -> EventHandlers

getEventHandlers :: GetEventHandlers a => EventHandlers -> [StoredEHType a]

getCustomEventHandlers :: TypeRep -> TypeRep -> EventHandlers -> [Dynamic -> IO ()]