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

Default InteractionCallbackMessageOptions

Defined in Calamity.HTTP.Interaction

Methods

def :: InteractionCallbackMessageOptions

(k ~ A_Lens, a ~ Maybe AllowedMentions, b ~ Maybe AllowedMentions) => LabelOptic "allowedMentions" k InteractionCallbackMessageOptions InteractionCallbackMessageOptions a b

Defined in Calamity.HTTP.Interaction

Methods

labelOptic :: Optic k NoIx InteractionCallbackMessageOptions InteractionCallbackMessageOptions a b

(k ~ A_Lens, a ~ Maybe [CreateMessageAttachment], b ~ Maybe [CreateMessageAttachment]) => LabelOptic "attachments" k InteractionCallbackMessageOptions InteractionCallbackMessageOptions a b

Defined in Calamity.HTTP.Interaction

Methods

labelOptic :: Optic k NoIx InteractionCallbackMessageOptions InteractionCallbackMessageOptions a b

(k ~ A_Lens, a ~ Maybe [Component], b ~ Maybe [Component]) => LabelOptic "components" k InteractionCallbackMessageOptions InteractionCallbackMessageOptions a b

Defined in Calamity.HTTP.Interaction

Methods

labelOptic :: Optic k NoIx InteractionCallbackMessageOptions InteractionCallbackMessageOptions a b

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "content" k InteractionCallbackMessageOptions InteractionCallbackMessageOptions a b

Defined in Calamity.HTTP.Interaction

Methods

labelOptic :: Optic k NoIx InteractionCallbackMessageOptions InteractionCallbackMessageOptions a b

(k ~ A_Lens, a ~ Maybe [Embed], b ~ Maybe [Embed]) => LabelOptic "embeds" k InteractionCallbackMessageOptions InteractionCallbackMessageOptions a b

Defined in Calamity.HTTP.Interaction

Methods

labelOptic :: Optic k NoIx InteractionCallbackMessageOptions InteractionCallbackMessageOptions a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "ephemeral" k InteractionCallbackMessageOptions InteractionCallbackMessageOptions a b

Defined in Calamity.HTTP.Interaction

Methods

labelOptic :: Optic k NoIx InteractionCallbackMessageOptions InteractionCallbackMessageOptions a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "suppressEmbeds" k InteractionCallbackMessageOptions InteractionCallbackMessageOptions a b

Defined in Calamity.HTTP.Interaction

Methods

labelOptic :: Optic k NoIx InteractionCallbackMessageOptions InteractionCallbackMessageOptions a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "tts" k InteractionCallbackMessageOptions InteractionCallbackMessageOptions a b

Defined in Calamity.HTTP.Interaction

Methods

labelOptic :: Optic k NoIx InteractionCallbackMessageOptions InteractionCallbackMessageOptions a b

newtype InteractionCallbackAutocomplete

Constructors

InteractionCallbackAutocomplete

Fields

• choices :: [InteractionCallbackAutocompleteChoice]

Instances

ToJSON InteractionCallbackAutocomplete

Defined in Calamity.HTTP.Interaction

Methods

toJSON :: InteractionCallbackAutocomplete -> Value

toEncoding :: InteractionCallbackAutocomplete -> Encoding

toJSONList :: [InteractionCallbackAutocomplete] -> Value

toEncodingList :: [InteractionCallbackAutocomplete] -> Encoding

Show InteractionCallbackAutocomplete

Defined in Calamity.HTTP.Interaction

Methods

showsPrec :: Int -> InteractionCallbackAutocomplete -> ShowS

show :: InteractionCallbackAutocomplete -> String

showList :: [InteractionCallbackAutocomplete] -> ShowS

CalamityToJSON' InteractionCallbackAutocomplete

Defined in Calamity.HTTP.Interaction

Methods

toPairs :: KeyValue kv => InteractionCallbackAutocomplete -> [Maybe kv]

(k ~ An_Iso, a ~ [InteractionCallbackAutocompleteChoice], b ~ [InteractionCallbackAutocompleteChoice]) => LabelOptic "choices" k InteractionCallbackAutocomplete InteractionCallbackAutocomplete a b

Defined in Calamity.HTTP.Interaction

Methods

labelOptic :: Optic k NoIx InteractionCallbackAutocomplete InteractionCallbackAutocomplete a b

data InteractionCallbackAutocompleteChoice

Constructors

InteractionCallbackAutocompleteChoice

Fields

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

  Either text or numeric

Instances

ToJSON InteractionCallbackAutocompleteChoice

Defined in Calamity.HTTP.Interaction

Methods

toJSON :: InteractionCallbackAutocompleteChoice -> Value

toEncoding :: InteractionCallbackAutocompleteChoice -> Encoding

toJSONList :: [InteractionCallbackAutocompleteChoice] -> Value

toEncodingList :: [InteractionCallbackAutocompleteChoice] -> Encoding

Show InteractionCallbackAutocompleteChoice

Defined in Calamity.HTTP.Interaction

Methods

showsPrec :: Int -> InteractionCallbackAutocompleteChoice -> ShowS

show :: InteractionCallbackAutocompleteChoice -> String

showList :: [InteractionCallbackAutocompleteChoice] -> ShowS

CalamityToJSON' InteractionCallbackAutocompleteChoice

Defined in Calamity.HTTP.Interaction

Methods

toPairs :: KeyValue kv => InteractionCallbackAutocompleteChoice -> [Maybe kv]

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "name" k InteractionCallbackAutocompleteChoice InteractionCallbackAutocompleteChoice a b

Defined in Calamity.HTTP.Interaction

Methods

labelOptic :: Optic k NoIx InteractionCallbackAutocompleteChoice InteractionCallbackAutocompleteChoice a b

(k ~ A_Lens, a ~ HashMap Text Text, b ~ HashMap Text Text) => LabelOptic "nameLocalizations" k InteractionCallbackAutocompleteChoice InteractionCallbackAutocompleteChoice a b

Defined in Calamity.HTTP.Interaction

Methods

labelOptic :: Optic k NoIx InteractionCallbackAutocompleteChoice InteractionCallbackAutocompleteChoice a b

(k ~ A_Lens, a ~ Value, b ~ Value) => LabelOptic "value" k InteractionCallbackAutocompleteChoice InteractionCallbackAutocompleteChoice a b

Defined in Calamity.HTTP.Interaction

Methods

labelOptic :: Optic k NoIx InteractionCallbackAutocompleteChoice InteractionCallbackAutocompleteChoice a b

data InteractionCallbackModal

Constructors

InteractionCallbackModal

Fields

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

Instances

ToJSON InteractionCallbackModal

Defined in Calamity.HTTP.Interaction

Methods

toJSON :: InteractionCallbackModal -> Value

toEncoding :: InteractionCallbackModal -> Encoding

toJSONList :: [InteractionCallbackModal] -> Value

toEncodingList :: [InteractionCallbackModal] -> Encoding

Show InteractionCallbackModal

Defined in Calamity.HTTP.Interaction

Methods

showsPrec :: Int -> InteractionCallbackModal -> ShowS

show :: InteractionCallbackModal -> String

showList :: [InteractionCallbackModal] -> ShowS

CalamityToJSON' InteractionCallbackModal

Defined in Calamity.HTTP.Interaction

Methods

toPairs :: KeyValue kv => InteractionCallbackModal -> [Maybe kv]

(k ~ A_Lens, a ~ [Component], b ~ [Component]) => LabelOptic "components" k InteractionCallbackModal InteractionCallbackModal a b

Defined in Calamity.HTTP.Interaction

Methods

labelOptic :: Optic k NoIx InteractionCallbackModal InteractionCallbackModal a b

(k ~ A_Lens, a ~ CustomID, b ~ CustomID) => LabelOptic "customID" k InteractionCallbackModal InteractionCallbackModal a b

Defined in Calamity.HTTP.Interaction

Methods

labelOptic :: Optic k NoIx InteractionCallbackModal InteractionCallbackModal a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "title" k InteractionCallbackModal InteractionCallbackModal a b

Defined in Calamity.HTTP.Interaction

Methods

labelOptic :: Optic k NoIx InteractionCallbackModal InteractionCallbackModal a b