Safe Haskell	None
Language	Haskell2010

Calamity.Commands.Context

Description

Command invokation context

Synopsis

class CommandContext c => CalamityCommandContext c where
- ctxChannelID :: c -> Snowflake Channel
- ctxGuildID :: c -> Maybe (Snowflake Guild)
- ctxUserID :: c -> Snowflake User
- ctxMessage :: c -> Message
data FullContext = FullContext {
- message :: Message
- guild :: Maybe Guild
- member :: Maybe Member
- channel :: Channel
- user :: User
- command :: Command FullContext
- prefix :: Text
- unparsedParams :: Text
}
useFullContext :: Member CacheEff r => Sem (ConstructContext (Message, User, Maybe Member) FullContext IO () ': r) a -> Sem r a
data LightContext = LightContext {
- message :: Message
- guildID :: Maybe (Snowflake Guild)
- channelID :: Snowflake Channel
- user :: User
- member :: Maybe Member
- command :: Command LightContext
- prefix :: Text
- unparsedParams :: Text
}
useLightContext :: Sem (ConstructContext (Message, User, Maybe Member) LightContext IO () ': r) a -> Sem r a

Documentation

class CommandContext c => CalamityCommandContext c where Source #

Methods

ctxChannelID :: c -> Snowflake Channel Source #

The id of the channel that invoked this command

ctxGuildID :: c -> Maybe (Snowflake Guild) Source #

The id of the guild the command was invoked in, if in a guild

ctxUserID :: c -> Snowflake User Source #

The id of the user that invoked this command

ctxMessage :: c -> Message Source #

The message that triggered this command

Instances

Instances details

CalamityCommandContext LightContext Source #
Instance details Defined in Calamity.Commands.Context Methods ctxChannelID :: LightContext -> Snowflake Channel Source # ctxGuildID :: LightContext -> Maybe (Snowflake Guild) Source # ctxUserID :: LightContext -> Snowflake User Source # ctxMessage :: LightContext -> Message Source #
CalamityCommandContext FullContext Source #
Instance details Defined in Calamity.Commands.Context Methods ctxChannelID :: FullContext -> Snowflake Channel Source # ctxGuildID :: FullContext -> Maybe (Snowflake Guild) Source # ctxUserID :: FullContext -> Snowflake User Source # ctxMessage :: FullContext -> Message Source #

data FullContext Source #

Invokation context for commands

Constructors

FullContext

Fields

message :: Message
The message that the command was invoked from
guild :: Maybe Guild
If the command was sent in a guild, this will be present
member :: Maybe Member
The member that invoked the command, if in a guild
Note: If discord sent a member with the message, this is used; otherwise we try to fetch the member from the cache.
channel :: Channel
The channel the command was invoked from
user :: User
The user that invoked the command
command :: Command FullContext
The command that was invoked
prefix :: Text
The prefix that was used to invoke the command
unparsedParams :: Text
The message remaining after consuming the prefix

Instances

Instances details

Show FullContext Source #
Instance details Defined in Calamity.Commands.Context Methods showsPrec :: Int -> FullContext -> ShowS # show :: FullContext -> String # showList :: [FullContext] -> ShowS #
Generic FullContext Source #
Instance details Defined in Calamity.Commands.Context Associated Types type Rep FullContext :: Type -> Type # Methods from :: FullContext -> Rep FullContext x # to :: Rep FullContext x -> FullContext #
TextShow FullContext Source #
Instance details Defined in Calamity.Commands.Context Methods showbPrec :: Int -> FullContext -> Builder # showb :: FullContext -> Builder # showbList :: [FullContext] -> Builder # showtPrec :: Int -> FullContext -> Text # showt :: FullContext -> Text # showtList :: [FullContext] -> Text # showtlPrec :: Int -> FullContext -> Text # showtl :: FullContext -> Text # showtlList :: [FullContext] -> Text #
Tellable FullContext Source #
Instance details Defined in Calamity.Commands.Context Methods getChannel :: forall (r :: EffectRow). (BotC r, Member (Error RestError) r) => FullContext -> Sem r (Snowflake Channel) Source #
CalamityCommandContext FullContext Source #
Instance details Defined in Calamity.Commands.Context Methods ctxChannelID :: FullContext -> Snowflake Channel Source # ctxGuildID :: FullContext -> Maybe (Snowflake Guild) Source # ctxUserID :: FullContext -> Snowflake User Source # ctxMessage :: FullContext -> Message Source #
HasID Channel FullContext Source #
Instance details Defined in Calamity.Commands.Context Methods getID :: FullContext -> Snowflake Channel Source #
HasID Message FullContext Source #
Instance details Defined in Calamity.Commands.Context Methods getID :: FullContext -> Snowflake Message Source #
HasID User FullContext Source #
Instance details Defined in Calamity.Commands.Context Methods getID :: FullContext -> Snowflake User Source #
CommandContext IO FullContext () Source #
Instance details Defined in Calamity.Commands.Context Methods ctxPrefix :: FullContext -> Text ctxCommand :: FullContext -> Command IO FullContext () ctxUnparsedParams :: FullContext -> Text
type Rep FullContext Source #
Instance details Defined in Calamity.Commands.Context type Rep FullContext = D1 ('MetaData "FullContext" "Calamity.Commands.Context" "calamity-0.4.0.0-inplace" 'False) (C1 ('MetaCons "FullContext" 'PrefixI 'True) (((S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Message) :: S1 ('MetaSel ('Just "guild") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Guild))) :: (S1 ('MetaSel ('Just "member") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Member)) :: S1 ('MetaSel ('Just "channel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Channel))) :: ((S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 User) :: S1 ('MetaSel ('Just "command") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Command FullContext))) :: (S1 ('MetaSel ('Just "prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "unparsedParams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

useFullContext :: Member CacheEff r => Sem (ConstructContext (Message, User, Maybe Member) FullContext IO () ': r) a -> Sem r a Source #

data LightContext Source #

A lightweight context that doesn't need any cache information

Constructors

LightContext

Fields

message :: Message
The message that the command was invoked from
guildID :: Maybe (Snowflake Guild)
If the command was sent in a guild, this will be present
channelID :: Snowflake Channel
The channel the command was invoked from
user :: User
The user that invoked the command
member :: Maybe Member
The member that triggered the command.
Note: Only sent if discord sent the member object with the message.
command :: Command LightContext
The command that was invoked
prefix :: Text
The prefix that was used to invoke the command
unparsedParams :: Text
The message remaining after consuming the prefix

Instances

Instances details

Show LightContext Source #
Instance details Defined in Calamity.Commands.Context Methods showsPrec :: Int -> LightContext -> ShowS # show :: LightContext -> String # showList :: [LightContext] -> ShowS #
Generic LightContext Source #
Instance details Defined in Calamity.Commands.Context Associated Types type Rep LightContext :: Type -> Type # Methods from :: LightContext -> Rep LightContext x # to :: Rep LightContext x -> LightContext #
TextShow LightContext Source #
Instance details Defined in Calamity.Commands.Context Methods showbPrec :: Int -> LightContext -> Builder # showb :: LightContext -> Builder # showbList :: [LightContext] -> Builder # showtPrec :: Int -> LightContext -> Text # showt :: LightContext -> Text # showtList :: [LightContext] -> Text # showtlPrec :: Int -> LightContext -> Text # showtl :: LightContext -> Text # showtlList :: [LightContext] -> Text #
Tellable LightContext Source #
Instance details Defined in Calamity.Commands.Context Methods getChannel :: forall (r :: EffectRow). (BotC r, Member (Error RestError) r) => LightContext -> Sem r (Snowflake Channel) Source #
CalamityCommandContext LightContext Source #
Instance details Defined in Calamity.Commands.Context Methods ctxChannelID :: LightContext -> Snowflake Channel Source # ctxGuildID :: LightContext -> Maybe (Snowflake Guild) Source # ctxUserID :: LightContext -> Snowflake User Source # ctxMessage :: LightContext -> Message Source #
HasID Channel LightContext Source #
Instance details Defined in Calamity.Commands.Context Methods getID :: LightContext -> Snowflake Channel Source #
HasID Message LightContext Source #
Instance details Defined in Calamity.Commands.Context Methods getID :: LightContext -> Snowflake Message Source #
HasID User LightContext Source #
Instance details Defined in Calamity.Commands.Context Methods getID :: LightContext -> Snowflake User Source #
CommandContext IO LightContext () Source #
Instance details Defined in Calamity.Commands.Context Methods ctxPrefix :: LightContext -> Text ctxCommand :: LightContext -> Command IO LightContext () ctxUnparsedParams :: LightContext -> Text
type Rep LightContext Source #
Instance details Defined in Calamity.Commands.Context type Rep LightContext = D1 ('MetaData "LightContext" "Calamity.Commands.Context" "calamity-0.4.0.0-inplace" 'False) (C1 ('MetaCons "LightContext" 'PrefixI 'True) (((S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Message) :: S1 ('MetaSel ('Just "guildID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Snowflake Guild)))) :: (S1 ('MetaSel ('Just "channelID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Snowflake Channel)) :: S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 User))) :: ((S1 ('MetaSel ('Just "member") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Member)) :: S1 ('MetaSel ('Just "command") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Command LightContext))) :: (S1 ('MetaSel ('Just "prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "unparsedParams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

useLightContext :: Sem (ConstructContext (Message, User, Maybe Member) LightContext IO () ': r) a -> Sem r a Source #