Calamity.HTTP.Interaction

Interaction endpoints

Documentation

data InteractionRequest a where

Constructors

CreateResponseMessage :: HasID Interaction i => i -> InteractionToken -> InteractionCallbackMessageOptions -> InteractionRequest ()

CreateResponseDefer

Ack an interaction and defer the response

This route triggers the thinking message

Fields

• :: HasID Interaction i
• => i
• -> InteractionToken
• -> Bool

  Ephemeral

• -> InteractionRequest ()

CreateResponseDeferComponent :: HasID Interaction i => i -> InteractionToken -> InteractionRequest ()

Ack an interaction and defer the response

This route is only usable by component interactions, and doesn't trigger a thinking message

CreateResponseUpdate :: HasID Interaction i => i -> InteractionToken -> InteractionCallbackMessageOptions -> InteractionRequest ()

CreateResponseAutocomplete :: HasID Interaction i => i -> InteractionToken -> InteractionCallbackAutocomplete -> InteractionRequest ()

CreateResponseModal :: HasID Interaction i => i -> InteractionToken -> InteractionCallbackModal -> InteractionRequest ()

GetOriginalInteractionResponse :: HasID Application i => i -> InteractionToken -> InteractionRequest Message

EditOriginalInteractionResponse :: HasID Application i => i -> InteractionToken -> InteractionCallbackMessageOptions -> InteractionRequest Message

DeleteOriginalInteractionResponse :: HasID Application i => i -> InteractionToken -> InteractionRequest ()

CreateFollowupMessage :: HasID Application i => i -> InteractionToken -> InteractionCallbackMessageOptions -> InteractionRequest ()

GetFollowupMessage :: (HasID Application i, HasID Message m) => i -> m -> InteractionToken -> InteractionRequest Message

EditFollowupMessage :: (HasID Application i, HasID Message m) => i -> m -> InteractionToken -> InteractionCallbackMessageOptions -> InteractionRequest ()

DeleteFollowupMessage :: (HasID Application i, HasID Message m) => i -> m -> InteractionToken -> InteractionRequest ()

Instances

Request (InteractionRequest a)

Defined in Calamity.HTTP.Interaction

Associated Types

type Result (InteractionRequest a)

Methods

route :: InteractionRequest a -> Route

action :: InteractionRequest a -> Url 'Https -> Option 'Https -> Req LbsResponse

modifyResponse :: InteractionRequest a -> Value -> Value

type Result (InteractionRequest a)

Defined in Calamity.HTTP.Interaction

type Result (InteractionRequest a) = a

data InteractionCallbackMessageOptions

Constructors

InteractionCallbackMessageOptions

Fields

• tts :: Maybe Bool
• content :: Maybe Text
• embeds :: Maybe [Embed]
• allowedMentions :: Maybe AllowedMentions
• ephemeral :: Maybe Bool
• suppressEmbeds :: Maybe Bool
• components :: Maybe [Component]
• attachments :: Maybe [CreateMessageAttachment]

Instances

Show InteractionCallbackMessageOptions

Defined in Calamity.HTTP.Interaction

Methods

showsPrec :: Int -> InteractionCallbackMessageOptions -> ShowS

show :: InteractionCallbackMessageOptions -> String

showList :: [InteractionCallbackMessageOptions] -> ShowS

Generic InteractionCallbackMessageOptions

Defined in Calamity.HTTP.Interaction

Associated Types

type Rep InteractionCallbackMessageOptions :: Type -> Type

Methods

from :: InteractionCallbackMessageOptions -> Rep InteractionCallbackMessageOptions x

to :: Rep InteractionCallbackMessageOptions x -> InteractionCallbackMessageOptions

Default InteractionCallbackMessageOptions

Defined in Calamity.HTTP.Interaction

Methods

def :: InteractionCallbackMessageOptions

type Rep InteractionCallbackMessageOptions

Defined in Calamity.HTTP.Interaction

type Rep InteractionCallbackMessageOptions = D1 ('MetaData "InteractionCallbackMessageOptions" "Calamity.HTTP.Interaction" "calamity-0.3.0.0-inplace" 'False) (C1 ('MetaCons "InteractionCallbackMessageOptions" 'PrefixI 'True) (((S1 ('MetaSel ('Just "tts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "embeds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Embed])) :*: S1 ('MetaSel ('Just "allowedMentions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AllowedMentions)))) :*: ((S1 ('MetaSel ('Just "ephemeral") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "suppressEmbeds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "components") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Component])) :*: S1 ('MetaSel ('Just "attachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CreateMessageAttachment]))))))

newtype InteractionCallbackAutocomplete

Constructors

InteractionCallbackAutocomplete

Fields

• choices :: [InteractionCallbackAutocompleteChoice]

Instances

Show InteractionCallbackAutocomplete

Defined in Calamity.HTTP.Interaction

Methods

showsPrec :: Int -> InteractionCallbackAutocomplete -> ShowS

show :: InteractionCallbackAutocomplete -> String

showList :: [InteractionCallbackAutocomplete] -> ShowS

Generic InteractionCallbackAutocomplete

Defined in Calamity.HTTP.Interaction

Associated Types

type Rep InteractionCallbackAutocomplete :: Type -> Type

Methods

from :: InteractionCallbackAutocomplete -> Rep InteractionCallbackAutocomplete x

to :: Rep InteractionCallbackAutocomplete x -> InteractionCallbackAutocomplete

ToJSON InteractionCallbackAutocomplete

Defined in Calamity.HTTP.Interaction

Methods

toJSON :: InteractionCallbackAutocomplete -> Value

toEncoding :: InteractionCallbackAutocomplete -> Encoding

toJSONList :: [InteractionCallbackAutocomplete] -> Value

toEncodingList :: [InteractionCallbackAutocomplete] -> Encoding

type Rep InteractionCallbackAutocomplete

Defined in Calamity.HTTP.Interaction

type Rep InteractionCallbackAutocomplete = D1 ('MetaData "InteractionCallbackAutocomplete" "Calamity.HTTP.Interaction" "calamity-0.3.0.0-inplace" 'True) (C1 ('MetaCons "InteractionCallbackAutocomplete" 'PrefixI 'True) (S1 ('MetaSel ('Just "choices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [InteractionCallbackAutocompleteChoice])))

data InteractionCallbackAutocompleteChoice

Constructors

InteractionCallbackAutocompleteChoice

Fields

• name :: Text
• nameLocalizations :: HashMap Text Text
• value :: Value

  Either text or numeric

Instances

Show InteractionCallbackAutocompleteChoice

Defined in Calamity.HTTP.Interaction

Methods

showsPrec :: Int -> InteractionCallbackAutocompleteChoice -> ShowS

show :: InteractionCallbackAutocompleteChoice -> String

showList :: [InteractionCallbackAutocompleteChoice] -> ShowS

Generic InteractionCallbackAutocompleteChoice

Defined in Calamity.HTTP.Interaction

Associated Types

type Rep InteractionCallbackAutocompleteChoice :: Type -> Type

Methods

from :: InteractionCallbackAutocompleteChoice -> Rep InteractionCallbackAutocompleteChoice x

to :: Rep InteractionCallbackAutocompleteChoice x -> InteractionCallbackAutocompleteChoice

ToJSON InteractionCallbackAutocompleteChoice

Defined in Calamity.HTTP.Interaction

Methods

toJSON :: InteractionCallbackAutocompleteChoice -> Value

toEncoding :: InteractionCallbackAutocompleteChoice -> Encoding

toJSONList :: [InteractionCallbackAutocompleteChoice] -> Value

toEncodingList :: [InteractionCallbackAutocompleteChoice] -> Encoding

type Rep InteractionCallbackAutocompleteChoice

Defined in Calamity.HTTP.Interaction

type Rep InteractionCallbackAutocompleteChoice = D1 ('MetaData "InteractionCallbackAutocompleteChoice" "Calamity.HTTP.Interaction" "calamity-0.3.0.0-inplace" 'False) (C1 ('MetaCons "InteractionCallbackAutocompleteChoice" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "nameLocalizations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Value))))

data InteractionCallbackModal

Constructors

InteractionCallbackModal

Fields

• customID :: CustomID
• title :: Text
• components :: [Component]

Instances

Show InteractionCallbackModal

Defined in Calamity.HTTP.Interaction

Methods

showsPrec :: Int -> InteractionCallbackModal -> ShowS

show :: InteractionCallbackModal -> String

showList :: [InteractionCallbackModal] -> ShowS

Generic InteractionCallbackModal

Defined in Calamity.HTTP.Interaction

Associated Types

type Rep InteractionCallbackModal :: Type -> Type

Methods

from :: InteractionCallbackModal -> Rep InteractionCallbackModal x

to :: Rep InteractionCallbackModal x -> InteractionCallbackModal

ToJSON InteractionCallbackModal

Defined in Calamity.HTTP.Interaction

Methods

toJSON :: InteractionCallbackModal -> Value

toEncoding :: InteractionCallbackModal -> Encoding

toJSONList :: [InteractionCallbackModal] -> Value

toEncodingList :: [InteractionCallbackModal] -> Encoding

type Rep InteractionCallbackModal

Defined in Calamity.HTTP.Interaction

type Rep InteractionCallbackModal = D1 ('MetaData "InteractionCallbackModal" "Calamity.HTTP.Interaction" "calamity-0.3.0.0-inplace" 'False) (C1 ('MetaCons "InteractionCallbackModal" 'PrefixI 'True) (S1 ('MetaSel ('Just "customID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CustomID) :*: (S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "components") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Component]))))