Calamity.Types.Tellable

Things that are messageable

Documentation

class ToMessage a where

Things that can be used to send a message

Can be used to compose text, embeds, and files. e.g.

intoMsg Text "A message" <> intoMsg Embed (def & #description ?~ "Embed description")

Methods

intoMsg :: a -> Endo CreateMessageOptions

Turn a into a CreateMessageOptions builder

Instances

ToMessage String

Message content, (<>) concatenates the content

Defined in Calamity.Types.Tellable

Methods

intoMsg :: String -> Endo CreateMessageOptions

ToMessage Text

Message content, (<>) concatenates the content

Defined in Calamity.Types.Tellable

Methods

intoMsg :: Text -> Endo CreateMessageOptions

ToMessage Text

Message content, (<>) concatenates the content

Defined in Calamity.Types.Tellable

Methods

intoMsg :: Text -> Endo CreateMessageOptions

ToMessage Embed

Message embed, (<>) appends a new embed

Defined in Calamity.Types.Tellable

Methods

intoMsg :: Embed -> Endo CreateMessageOptions

ToMessage MessageReference

Set a MessageReference as the message to reply to

Defined in Calamity.Types.Tellable

Methods

intoMsg :: MessageReference -> Endo CreateMessageOptions

ToMessage Component

Add a singleton row containing a Component to the message

If the component is not already an actionrow, it is wrapped in a singleton row

Defined in Calamity.Types.Tellable

Methods

intoMsg :: Component -> Endo CreateMessageOptions

ToMessage Select

Add a singleton row containing a Select to the message,

Defined in Calamity.Types.Tellable

Methods

intoMsg :: Select -> Endo CreateMessageOptions

ToMessage LinkButton

Add a singleton row containing a LinkButton to the message,

Defined in Calamity.Types.Tellable

Methods

intoMsg :: LinkButton -> Endo CreateMessageOptions

ToMessage Button

Add a singleton row containing a Button to the message,

Defined in Calamity.Types.Tellable

Methods

intoMsg :: Button -> Endo CreateMessageOptions

ToMessage AllowedMentions

Allowed mentions, (<>) combines allowed mentions

Defined in Calamity.Types.Tellable

Methods

intoMsg :: AllowedMentions -> Endo CreateMessageOptions

ToMessage CreateMessageOptions

Defined in Calamity.Types.Tellable

Methods

intoMsg :: CreateMessageOptions -> Endo CreateMessageOptions

ToMessage CreateMessageAttachment

Message attachments, (<>) appends a new file

Defined in Calamity.Types.Tellable

Methods

intoMsg :: CreateMessageAttachment -> Endo CreateMessageOptions

ToMessage [Component]

Add many components to a message.

Each component will be wrapped in a singleton ActionRow if not already

Defined in Calamity.Types.Tellable

Methods

intoMsg :: [Component] -> Endo CreateMessageOptions

ToMessage [Select]

Add an row of Selects to the message

Defined in Calamity.Types.Tellable

Methods

intoMsg :: [Select] -> Endo CreateMessageOptions

ToMessage [LinkButton]

Add an row of LinkButtons to the message

Defined in Calamity.Types.Tellable

Methods

intoMsg :: [LinkButton] -> Endo CreateMessageOptions

ToMessage [Button]

Add an row of Buttons to the message

Defined in Calamity.Types.Tellable

Methods

intoMsg :: [Button] -> Endo CreateMessageOptions

ToMessage (Endo CreateMessageOptions)

Defined in Calamity.Types.Tellable

Methods

intoMsg :: Endo CreateMessageOptions -> Endo CreateMessageOptions

ToMessage (TMention Member)

Add a Member id to the list of allowed user mentions

Defined in Calamity.Types.Tellable

Methods

intoMsg :: TMention Member -> Endo CreateMessageOptions

ToMessage (TMention User)

Add a User id to the list of allowed user mentions

Defined in Calamity.Types.Tellable

Methods

intoMsg :: TMention User -> Endo CreateMessageOptions

ToMessage (TMention Role)

Add a Role id to the list of allowed role mentions

Defined in Calamity.Types.Tellable

Methods

intoMsg :: TMention Role -> Endo CreateMessageOptions

ToMessage (CreateMessageOptions -> CreateMessageOptions)

Defined in Calamity.Types.Tellable

Methods

intoMsg :: (CreateMessageOptions -> CreateMessageOptions) -> Endo CreateMessageOptions

class Tellable a where

Methods

getChannel :: (BotC r, Member (Error RestError) r) => a -> Sem r (Snowflake Channel)

Instances

Tellable Channel

Defined in Calamity.Types.Tellable

Methods

getChannel :: forall (r :: EffectRow). (BotC r, Member (Error RestError) r) => Channel -> Sem r (Snowflake Channel)

Tellable Message

Defined in Calamity.Types.Tellable

Methods

getChannel :: forall (r :: EffectRow). (BotC r, Member (Error RestError) r) => Message -> Sem r (Snowflake Channel)

Tellable Member

Defined in Calamity.Types.Tellable

Methods

getChannel :: forall (r :: EffectRow). (BotC r, Member0 (Error RestError) r) => Member -> Sem r (Snowflake Channel)

Tellable User

Defined in Calamity.Types.Tellable

Methods

getChannel :: forall (r :: EffectRow). (BotC r, Member (Error RestError) r) => User -> Sem r (Snowflake Channel)

Tellable DMChannel

Defined in Calamity.Types.Tellable

Methods

getChannel :: forall (r :: EffectRow). (BotC r, Member (Error RestError) r) => DMChannel -> Sem r (Snowflake Channel)

Tellable TextChannel

Defined in Calamity.Types.Tellable

Methods

getChannel :: forall (r :: EffectRow). (BotC r, Member (Error RestError) r) => TextChannel -> Sem r (Snowflake Channel)

Tellable LightContext

Defined in Calamity.Commands.Context

Methods

getChannel :: forall (r :: EffectRow). (BotC r, Member (Error RestError) r) => LightContext -> Sem r (Snowflake Channel)

Tellable FullContext

Defined in Calamity.Commands.Context

Methods

getChannel :: forall (r :: EffectRow). (BotC r, Member (Error RestError) r) => FullContext -> Sem r (Snowflake Channel)

Tellable (Snowflake Channel)

Defined in Calamity.Types.Tellable

Methods

getChannel :: forall (r :: EffectRow). (BotC r, Member (Error RestError) r) => Snowflake Channel -> Sem r (Snowflake Channel)

Tellable (Snowflake Member)

Defined in Calamity.Types.Tellable

Methods

getChannel :: forall (r :: EffectRow). (BotC r, Member0 (Error RestError) r) => Snowflake Member -> Sem r (Snowflake Channel)

Tellable (Snowflake User)

Defined in Calamity.Types.Tellable

Methods

getChannel :: forall (r :: EffectRow). (BotC r, Member (Error RestError) r) => Snowflake User -> Sem r (Snowflake Channel)

Tellable (Snowflake DMChannel)

Defined in Calamity.Types.Tellable

Methods

getChannel :: forall (r :: EffectRow). (BotC r, Member (Error RestError) r) => Snowflake DMChannel -> Sem r (Snowflake Channel)

Tellable (Snowflake TextChannel)

Defined in Calamity.Types.Tellable

Methods

getChannel :: forall (r :: EffectRow). (BotC r, Member (Error RestError) r) => Snowflake TextChannel -> Sem r (Snowflake Channel)

newtype TMention a

A wrapper type for allowing mentions

Constructors

TMention (Snowflake a)

Instances

Show (TMention a)

Defined in Calamity.Types.Tellable

Methods

showsPrec :: Int -> TMention a -> ShowS

show :: TMention a -> String

showList :: [TMention a] -> ShowS

Generic (TMention a)

Defined in Calamity.Types.Tellable

Associated Types

type Rep (TMention a) :: Type -> Type

Methods

from :: TMention a -> Rep (TMention a) x

to :: Rep (TMention a) x -> TMention a

ToMessage (TMention Member)

Add a Member id to the list of allowed user mentions

Defined in Calamity.Types.Tellable

Methods

intoMsg :: TMention Member -> Endo CreateMessageOptions

ToMessage (TMention User)

Add a User id to the list of allowed user mentions

Defined in Calamity.Types.Tellable

Methods

intoMsg :: TMention User -> Endo CreateMessageOptions

ToMessage (TMention Role)

Add a Role id to the list of allowed role mentions

Defined in Calamity.Types.Tellable

Methods

intoMsg :: TMention Role -> Endo CreateMessageOptions

type Rep (TMention a)

Defined in Calamity.Types.Tellable

type Rep (TMention a) = D1 ('MetaData "TMention" "Calamity.Types.Tellable" "calamity-0.3.0.0-inplace" 'True) (C1 ('MetaCons "TMention" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Snowflake a))))

tell :: forall msg r t. (BotC r, ToMessage msg, Tellable t) => t -> msg -> Sem r (Either RestError Message)

Send a message to something that is messageable

To send a string literal you'll probably want to use TypeApplication to specify the type of msg

Examples

Sending a string:

void $ tell @Text m ("Somebody told me to tell you about: " <> s)

reply :: forall msg r t. (BotC r, ToMessage msg, HasID Channel t, HasID Message t) => t -> msg -> Sem r (Either RestError Message)

Create a reply to an existing message in the same channel

To send a string literal you'll probably want to use TypeApplication to specify the type of msg

Examples

Sending a string:

void $ reply @Text msgToReplyTo ("Somebody told me to tell you about: " <> s)

runToMessage :: ToMessage a => a -> CreateMessageOptions