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, (<>) merges embeds using (<>)

Defined in Calamity.Types.Tellable

Methods

intoMsg :: Embed -> 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 TFile

Message file, (<>) keeps the last added file

Defined in Calamity.Types.Tellable

Methods

intoMsg :: TFile -> 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 Context

Defined in Calamity.Commands.Context

Methods

getChannel :: forall (r :: [(Type -> Type) -> Type -> Type]). (BotC r, Member (Error RestError) r) => Context -> Sem r (Snowflake Channel)

Tellable Channel

Defined in Calamity.Types.Tellable

Methods

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

Tellable Message

Defined in Calamity.Types.Tellable

Methods

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

Tellable Member

Defined in Calamity.Types.Tellable

Methods

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

Tellable User

Defined in Calamity.Types.Tellable

Methods

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

Tellable DMChannel

Defined in Calamity.Types.Tellable

Methods

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

Tellable TextChannel

Defined in Calamity.Types.Tellable

Methods

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

Tellable (Snowflake Channel)

Defined in Calamity.Types.Tellable

Methods

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

Tellable (Snowflake Member)

Defined in Calamity.Types.Tellable

Methods

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

Tellable (Snowflake User)

Defined in Calamity.Types.Tellable

Methods

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

Tellable (Snowflake DMChannel)

Defined in Calamity.Types.Tellable

Methods

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

Tellable (Snowflake TextChannel)

Defined in Calamity.Types.Tellable

Methods

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

data TFile

A wrapper type for sending files

Constructors

TFile

Fields

• Text

  The filename

• ByteString

  The content

Instances

Show TFile

Defined in Calamity.Types.Tellable

Methods

showsPrec :: Int -> TFile -> ShowS

show :: TFile -> String

showList :: [TFile] -> ShowS

Generic TFile

Defined in Calamity.Types.Tellable

Associated Types

type Rep TFile :: Type -> Type

Methods

from :: TFile -> Rep TFile x

to :: Rep TFile x -> TFile

ToMessage TFile

Message file, (<>) keeps the last added file

Defined in Calamity.Types.Tellable

Methods

intoMsg :: TFile -> Endo CreateMessageOptions

type Rep TFile

Defined in Calamity.Types.Tellable

type Rep TFile = D1 ('MetaData "TFile" "Calamity.Types.Tellable" "calamity-0.1.26.0-8Rbyh2JfYBvC9UHgZLNZiA" 'False) (C1 ('MetaCons "TFile" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString)))

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.1.26.0-8Rbyh2JfYBvC9UHgZLNZiA" '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)