Calamity.Types.Model.Channel.Component

Message components

Documentation

newtype CustomID

Constructors

CustomID Text

Instances

Eq CustomID

Defined in Calamity.Types.Model.Channel.Component

Methods

(==) :: CustomID -> CustomID -> Bool

(/=) :: CustomID -> CustomID -> Bool

Ord CustomID

Defined in Calamity.Types.Model.Channel.Component

Methods

compare :: CustomID -> CustomID -> Ordering

(<) :: CustomID -> CustomID -> Bool

(<=) :: CustomID -> CustomID -> Bool

(>) :: CustomID -> CustomID -> Bool

(>=) :: CustomID -> CustomID -> Bool

max :: CustomID -> CustomID -> CustomID

min :: CustomID -> CustomID -> CustomID

Show CustomID

Defined in Calamity.Types.Model.Channel.Component

Methods

showsPrec :: Int -> CustomID -> ShowS

show :: CustomID -> String

showList :: [CustomID] -> ShowS

ToJSON CustomID

Defined in Calamity.Types.Model.Channel.Component

Methods

toJSON :: CustomID -> Value

toEncoding :: CustomID -> Encoding

toJSONList :: [CustomID] -> Value

toEncodingList :: [CustomID] -> Encoding

FromJSON CustomID

Defined in Calamity.Types.Model.Channel.Component

Methods

parseJSON :: Value -> Parser CustomID

parseJSONList :: Value -> Parser [CustomID]

Uniform CustomID

Defined in Calamity.Types.Model.Channel.Component

Methods

uniformM :: StatefulGen g m => g -> m CustomID

TextShow CustomID

Defined in Calamity.Types.Model.Channel.Component

Methods

showbPrec :: Int -> CustomID -> Builder

showb :: CustomID -> Builder

showbList :: [CustomID] -> Builder

showtPrec :: Int -> CustomID -> Text

showt :: CustomID -> Text

showtList :: [CustomID] -> Text

showtlPrec :: Int -> CustomID -> Text

showtl :: CustomID -> Text

showtlList :: [CustomID] -> Text

data Component

Constructors

ActionRow' [Component]

Button' Button

LinkButton' LinkButton

Select' Select

TextInput' TextInput

Instances

Show Component

Defined in Calamity.Types.Model.Channel.Component

Methods

showsPrec :: Int -> Component -> ShowS

show :: Component -> String

showList :: [Component] -> ShowS

ToJSON Component

Defined in Calamity.Types.Model.Channel.Component

Methods

toJSON :: Component -> Value

toEncoding :: Component -> Encoding

toJSONList :: [Component] -> Value

toEncodingList :: [Component] -> Encoding

FromJSON Component

Defined in Calamity.Types.Model.Channel.Component

Methods

parseJSON :: Value -> Parser Component

parseJSONList :: Value -> Parser [Component]

TextShow Component

Defined in Calamity.Types.Model.Channel.Component

Methods

showbPrec :: Int -> Component -> Builder

showb :: Component -> Builder

showbList :: [Component] -> Builder

showtPrec :: Int -> Component -> Text

showt :: Component -> Text

showtList :: [Component] -> Text

showtlPrec :: Int -> Component -> Text

showtl :: Component -> Text

showtlList :: [Component] -> Text

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 [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

data Button

Constructors

Button

Fields

• style :: ButtonStyle
• label :: Maybe Text
• emoji :: Maybe RawEmoji
• disabled :: Bool
• customID :: CustomID

Instances

Show Button

Defined in Calamity.Types.Model.Channel.Component

Methods

showsPrec :: Int -> Button -> ShowS

show :: Button -> String

showList :: [Button] -> ShowS

ToJSON Button

Defined in Calamity.Types.Model.Channel.Component

Methods

toJSON :: Button -> Value

toEncoding :: Button -> Encoding

toJSONList :: [Button] -> Value

toEncodingList :: [Button] -> Encoding

FromJSON Button

Defined in Calamity.Types.Model.Channel.Component

Methods

parseJSON :: Value -> Parser Button

parseJSONList :: Value -> Parser [Button]

TextShow Button

Defined in Calamity.Types.Model.Channel.Component

Methods

showbPrec :: Int -> Button -> Builder

showb :: Button -> Builder

showbList :: [Button] -> Builder

showtPrec :: Int -> Button -> Text

showt :: Button -> Text

showtList :: [Button] -> Text

showtlPrec :: Int -> Button -> Text

showtl :: Button -> Text

showtlList :: [Button] -> Text

CalamityToJSON' Button

Defined in Calamity.Types.Model.Channel.Component

Methods

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

ToMessage Button

Add a singleton row containing a Button to the message,

Defined in Calamity.Types.Tellable

Methods

intoMsg :: Button -> Endo CreateMessageOptions

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

Defined in Calamity.Types.Model.Channel.Component

Methods

labelOptic :: Optic k NoIx Button Button a b

(k ~ A_Lens, a ~ Bool, b ~ Bool) => LabelOptic "disabled" k Button Button a b

Defined in Calamity.Types.Model.Channel.Component

Methods

labelOptic :: Optic k NoIx Button Button a b

(k ~ A_Lens, a ~ Maybe RawEmoji, b ~ Maybe RawEmoji) => LabelOptic "emoji" k Button Button a b

Defined in Calamity.Types.Model.Channel.Component

Methods

labelOptic :: Optic k NoIx Button Button a b

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "label" k Button Button a b

Defined in Calamity.Types.Model.Channel.Component

Methods

labelOptic :: Optic k NoIx Button Button a b

(k ~ A_Lens, a ~ ButtonStyle, b ~ ButtonStyle) => LabelOptic "style" k Button Button a b

Defined in Calamity.Types.Model.Channel.Component

Methods

labelOptic :: Optic k NoIx Button Button a b

ToMessage [Button]

Add an row of Buttons to the message

Defined in Calamity.Types.Tellable

Methods

intoMsg :: [Button] -> Endo CreateMessageOptions

data LinkButton

Constructors

LinkButton

Fields

• style :: ButtonStyle
• label :: Maybe Text
• emoji :: Maybe RawEmoji
• url :: Text
• disabled :: Bool

Instances

Show LinkButton

Defined in Calamity.Types.Model.Channel.Component

Methods

showsPrec :: Int -> LinkButton -> ShowS

show :: LinkButton -> String

showList :: [LinkButton] -> ShowS

ToJSON LinkButton

Defined in Calamity.Types.Model.Channel.Component

Methods

toJSON :: LinkButton -> Value

toEncoding :: LinkButton -> Encoding

toJSONList :: [LinkButton] -> Value

toEncodingList :: [LinkButton] -> Encoding

FromJSON LinkButton

Defined in Calamity.Types.Model.Channel.Component

Methods

parseJSON :: Value -> Parser LinkButton

parseJSONList :: Value -> Parser [LinkButton]

TextShow LinkButton

Defined in Calamity.Types.Model.Channel.Component

Methods

showbPrec :: Int -> LinkButton -> Builder

showb :: LinkButton -> Builder

showbList :: [LinkButton] -> Builder

showtPrec :: Int -> LinkButton -> Text

showt :: LinkButton -> Text

showtList :: [LinkButton] -> Text

showtlPrec :: Int -> LinkButton -> Text

showtl :: LinkButton -> Text

showtlList :: [LinkButton] -> Text

CalamityToJSON' LinkButton

Defined in Calamity.Types.Model.Channel.Component

Methods

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

ToMessage LinkButton

Add a singleton row containing a LinkButton to the message,

Defined in Calamity.Types.Tellable

Methods

intoMsg :: LinkButton -> Endo CreateMessageOptions

(k ~ A_Lens, a ~ Bool, b ~ Bool) => LabelOptic "disabled" k LinkButton LinkButton a b

Defined in Calamity.Types.Model.Channel.Component

Methods

labelOptic :: Optic k NoIx LinkButton LinkButton a b

(k ~ A_Lens, a ~ Maybe RawEmoji, b ~ Maybe RawEmoji) => LabelOptic "emoji" k LinkButton LinkButton a b

Defined in Calamity.Types.Model.Channel.Component

Methods

labelOptic :: Optic k NoIx LinkButton LinkButton a b

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "label" k LinkButton LinkButton a b

Defined in Calamity.Types.Model.Channel.Component

Methods

labelOptic :: Optic k NoIx LinkButton LinkButton a b

(k ~ A_Lens, a ~ ButtonStyle, b ~ ButtonStyle) => LabelOptic "style" k LinkButton LinkButton a b

Defined in Calamity.Types.Model.Channel.Component

Methods

labelOptic :: Optic k NoIx LinkButton LinkButton a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "url" k LinkButton LinkButton a b

Defined in Calamity.Types.Model.Channel.Component

Methods

labelOptic :: Optic k NoIx LinkButton LinkButton a b

ToMessage [LinkButton]

Add an row of LinkButtons to the message

Defined in Calamity.Types.Tellable

Methods

intoMsg :: [LinkButton] -> Endo CreateMessageOptions

button :: ButtonStyle -> CustomID -> Button

Constuct a non-disabled Button with the given ButtonStyle and CustomID, all other fields are set to Nothing

button' :: ButtonStyle -> Text -> CustomID -> Button

Constuct a non-disabled Button with the given ButtonStyle, CustomID, and label, all other fields are set to Nothing

lbutton

Arguments

:: ButtonStyle

-> Text

The link to use

-> LinkButton

Constuct a non-disabled LinkButton with the given ButtonStyle, link, all other fields are set to Nothing

lbutton'

Arguments

:: ButtonStyle

-> Text

The link to use

-> Text

The label to use

-> LinkButton

Constuct a non-disabled LinkButton with the given ButtonStyle, link, and label, all other fields are set to Nothing

data ButtonStyle

Constructors

ButtonPrimary

ButtonSecondary

ButtonSuccess

ButtonDanger

ButtonLink

Instances

Eq ButtonStyle

Defined in Calamity.Types.Model.Channel.Component

Methods

(==) :: ButtonStyle -> ButtonStyle -> Bool

(/=) :: ButtonStyle -> ButtonStyle -> Bool

Show ButtonStyle

Defined in Calamity.Types.Model.Channel.Component

Methods

showsPrec :: Int -> ButtonStyle -> ShowS

show :: ButtonStyle -> String

showList :: [ButtonStyle] -> ShowS

ToJSON ButtonStyle

Defined in Calamity.Types.Model.Channel.Component

Methods

toJSON :: ButtonStyle -> Value

toEncoding :: ButtonStyle -> Encoding

toJSONList :: [ButtonStyle] -> Value

toEncodingList :: [ButtonStyle] -> Encoding

FromJSON ButtonStyle

Defined in Calamity.Types.Model.Channel.Component

Methods

parseJSON :: Value -> Parser ButtonStyle

parseJSONList :: Value -> Parser [ButtonStyle]

TextShow ButtonStyle

Defined in Calamity.Types.Model.Channel.Component

Methods

showbPrec :: Int -> ButtonStyle -> Builder

showb :: ButtonStyle -> Builder

showbList :: [ButtonStyle] -> Builder

showtPrec :: Int -> ButtonStyle -> Text

showt :: ButtonStyle -> Text

showtList :: [ButtonStyle] -> Text

showtlPrec :: Int -> ButtonStyle -> Text

showtl :: ButtonStyle -> Text

showtlList :: [ButtonStyle] -> Text

data Select

Constructors

Select

Fields

• options :: [SelectOption]
• placeholder :: Maybe Text
• minValues :: Maybe Int
• maxValues :: Maybe Int
• disabled :: Bool
• customID :: CustomID

Instances

Show Select

Defined in Calamity.Types.Model.Channel.Component

Methods

showsPrec :: Int -> Select -> ShowS

show :: Select -> String

showList :: [Select] -> ShowS

ToJSON Select

Defined in Calamity.Types.Model.Channel.Component

Methods

toJSON :: Select -> Value

toEncoding :: Select -> Encoding

toJSONList :: [Select] -> Value

toEncodingList :: [Select] -> Encoding

FromJSON Select

Defined in Calamity.Types.Model.Channel.Component

Methods

parseJSON :: Value -> Parser Select

parseJSONList :: Value -> Parser [Select]

TextShow Select

Defined in Calamity.Types.Model.Channel.Component

Methods

showbPrec :: Int -> Select -> Builder

showb :: Select -> Builder

showbList :: [Select] -> Builder

showtPrec :: Int -> Select -> Text

showt :: Select -> Text

showtList :: [Select] -> Text

showtlPrec :: Int -> Select -> Text

showtl :: Select -> Text

showtlList :: [Select] -> Text

CalamityToJSON' Select

Defined in Calamity.Types.Model.Channel.Component

Methods

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

ToMessage Select

Add a singleton row containing a Select to the message,

Defined in Calamity.Types.Tellable

Methods

intoMsg :: Select -> Endo CreateMessageOptions

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

Defined in Calamity.Types.Model.Channel.Component

Methods

labelOptic :: Optic k NoIx Select Select a b

(k ~ A_Lens, a ~ Bool, b ~ Bool) => LabelOptic "disabled" k Select Select a b

Defined in Calamity.Types.Model.Channel.Component

Methods

labelOptic :: Optic k NoIx Select Select a b

(k ~ A_Lens, a ~ Maybe Int, b ~ Maybe Int) => LabelOptic "maxValues" k Select Select a b

Defined in Calamity.Types.Model.Channel.Component

Methods

labelOptic :: Optic k NoIx Select Select a b

(k ~ A_Lens, a ~ Maybe Int, b ~ Maybe Int) => LabelOptic "minValues" k Select Select a b

Defined in Calamity.Types.Model.Channel.Component

Methods

labelOptic :: Optic k NoIx Select Select a b

(k ~ A_Lens, a ~ [SelectOption], b ~ [SelectOption]) => LabelOptic "options" k Select Select a b

Defined in Calamity.Types.Model.Channel.Component

Methods

labelOptic :: Optic k NoIx Select Select a b

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "placeholder" k Select Select a b

Defined in Calamity.Types.Model.Channel.Component

Methods

labelOptic :: Optic k NoIx Select Select a b

ToMessage [Select]

Add an row of Selects to the message

Defined in Calamity.Types.Tellable

Methods

intoMsg :: [Select] -> Endo CreateMessageOptions

select :: [SelectOption] -> CustomID -> Select

data SelectOption

Constructors

SelectOption

Fields

• label :: Text
• value :: Text
• description :: Maybe Text
• emoji :: Maybe RawEmoji
• default_ :: Bool

Instances

Show SelectOption

Defined in Calamity.Types.Model.Channel.Component

Methods

showsPrec :: Int -> SelectOption -> ShowS

show :: SelectOption -> String

showList :: [SelectOption] -> ShowS

ToJSON SelectOption

Defined in Calamity.Types.Model.Channel.Component

Methods

toJSON :: SelectOption -> Value

toEncoding :: SelectOption -> Encoding

toJSONList :: [SelectOption] -> Value

toEncodingList :: [SelectOption] -> Encoding

FromJSON SelectOption

Defined in Calamity.Types.Model.Channel.Component

Methods

parseJSON :: Value -> Parser SelectOption

parseJSONList :: Value -> Parser [SelectOption]

TextShow SelectOption

Defined in Calamity.Types.Model.Channel.Component

Methods

showbPrec :: Int -> SelectOption -> Builder

showb :: SelectOption -> Builder

showbList :: [SelectOption] -> Builder

showtPrec :: Int -> SelectOption -> Text

showt :: SelectOption -> Text

showtList :: [SelectOption] -> Text

showtlPrec :: Int -> SelectOption -> Text

showtl :: SelectOption -> Text

showtlList :: [SelectOption] -> Text

CalamityToJSON' SelectOption

Defined in Calamity.Types.Model.Channel.Component

Methods

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

(k ~ A_Lens, a ~ Bool, b ~ Bool) => LabelOptic "default_" k SelectOption SelectOption a b

Defined in Calamity.Types.Model.Channel.Component

Methods

labelOptic :: Optic k NoIx SelectOption SelectOption a b

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "description" k SelectOption SelectOption a b

Defined in Calamity.Types.Model.Channel.Component

Methods

labelOptic :: Optic k NoIx SelectOption SelectOption a b

(k ~ A_Lens, a ~ Maybe RawEmoji, b ~ Maybe RawEmoji) => LabelOptic "emoji" k SelectOption SelectOption a b

Defined in Calamity.Types.Model.Channel.Component

Methods

labelOptic :: Optic k NoIx SelectOption SelectOption a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "label" k SelectOption SelectOption a b

Defined in Calamity.Types.Model.Channel.Component

Methods

labelOptic :: Optic k NoIx SelectOption SelectOption a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "value" k SelectOption SelectOption a b

Defined in Calamity.Types.Model.Channel.Component

Methods

labelOptic :: Optic k NoIx SelectOption SelectOption a b

sopt

Arguments

:: Text

Label

-> Text

Value

-> SelectOption

data TextInput

Constructors

TextInput

Fields

• style :: TextInputStyle
• label :: Text
• minLength :: Maybe Int
• maxLength :: Maybe Int
• required :: Bool
• value :: Maybe Text
• placeholder :: Maybe Text
• customID :: CustomID

Instances

Show TextInput

Defined in Calamity.Types.Model.Channel.Component

Methods

showsPrec :: Int -> TextInput -> ShowS

show :: TextInput -> String

showList :: [TextInput] -> ShowS

ToJSON TextInput

Defined in Calamity.Types.Model.Channel.Component

Methods

toJSON :: TextInput -> Value

toEncoding :: TextInput -> Encoding

toJSONList :: [TextInput] -> Value

toEncodingList :: [TextInput] -> Encoding

FromJSON TextInput

Defined in Calamity.Types.Model.Channel.Component

Methods

parseJSON :: Value -> Parser TextInput

parseJSONList :: Value -> Parser [TextInput]

TextShow TextInput

Defined in Calamity.Types.Model.Channel.Component

Methods

showbPrec :: Int -> TextInput -> Builder

showb :: TextInput -> Builder

showbList :: [TextInput] -> Builder

showtPrec :: Int -> TextInput -> Text

showt :: TextInput -> Text

showtList :: [TextInput] -> Text

showtlPrec :: Int -> TextInput -> Text

showtl :: TextInput -> Text

showtlList :: [TextInput] -> Text

CalamityToJSON' TextInput

Defined in Calamity.Types.Model.Channel.Component

Methods

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

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

Defined in Calamity.Types.Model.Channel.Component

Methods

labelOptic :: Optic k NoIx TextInput TextInput a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "label" k TextInput TextInput a b

Defined in Calamity.Types.Model.Channel.Component

Methods

labelOptic :: Optic k NoIx TextInput TextInput a b

(k ~ A_Lens, a ~ Maybe Int, b ~ Maybe Int) => LabelOptic "maxLength" k TextInput TextInput a b

Defined in Calamity.Types.Model.Channel.Component

Methods

labelOptic :: Optic k NoIx TextInput TextInput a b

(k ~ A_Lens, a ~ Maybe Int, b ~ Maybe Int) => LabelOptic "minLength" k TextInput TextInput a b

Defined in Calamity.Types.Model.Channel.Component

Methods

labelOptic :: Optic k NoIx TextInput TextInput a b

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "placeholder" k TextInput TextInput a b

Defined in Calamity.Types.Model.Channel.Component

Methods

labelOptic :: Optic k NoIx TextInput TextInput a b

(k ~ A_Lens, a ~ Bool, b ~ Bool) => LabelOptic "required" k TextInput TextInput a b

Defined in Calamity.Types.Model.Channel.Component

Methods

labelOptic :: Optic k NoIx TextInput TextInput a b

(k ~ A_Lens, a ~ TextInputStyle, b ~ TextInputStyle) => LabelOptic "style" k TextInput TextInput a b

Defined in Calamity.Types.Model.Channel.Component

Methods

labelOptic :: Optic k NoIx TextInput TextInput a b

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "value" k TextInput TextInput a b

Defined in Calamity.Types.Model.Channel.Component

Methods

labelOptic :: Optic k NoIx TextInput TextInput a b

data TextInputStyle

Constructors

TextInputShort

TextInputParagraph

Instances

Show TextInputStyle

Defined in Calamity.Types.Model.Channel.Component

Methods

showsPrec :: Int -> TextInputStyle -> ShowS

show :: TextInputStyle -> String

showList :: [TextInputStyle] -> ShowS

ToJSON TextInputStyle

Defined in Calamity.Types.Model.Channel.Component

Methods

toJSON :: TextInputStyle -> Value

toEncoding :: TextInputStyle -> Encoding

toJSONList :: [TextInputStyle] -> Value

toEncodingList :: [TextInputStyle] -> Encoding

FromJSON TextInputStyle

Defined in Calamity.Types.Model.Channel.Component

Methods

parseJSON :: Value -> Parser TextInputStyle

parseJSONList :: Value -> Parser [TextInputStyle]

TextShow TextInputStyle

Defined in Calamity.Types.Model.Channel.Component

Methods

showbPrec :: Int -> TextInputStyle -> Builder

showb :: TextInputStyle -> Builder

showbList :: [TextInputStyle] -> Builder

showtPrec :: Int -> TextInputStyle -> Text

showt :: TextInputStyle -> Text

showtList :: [TextInputStyle] -> Text

showtlPrec :: Int -> TextInputStyle -> Text

showtl :: TextInputStyle -> Text

showtlList :: [TextInputStyle] -> Text

textInput

Arguments

:: TextInputStyle

-> Text

Label

-> CustomID

-> TextInput

data ComponentType

Constructors

ActionRowType

ButtonType

SelectType

TextInputType

Instances

Eq ComponentType

Defined in Calamity.Types.Model.Channel.Component

Methods

(==) :: ComponentType -> ComponentType -> Bool

(/=) :: ComponentType -> ComponentType -> Bool

Show ComponentType

Defined in Calamity.Types.Model.Channel.Component

Methods

showsPrec :: Int -> ComponentType -> ShowS

show :: ComponentType -> String

showList :: [ComponentType] -> ShowS

ToJSON ComponentType

Defined in Calamity.Types.Model.Channel.Component

Methods

toJSON :: ComponentType -> Value

toEncoding :: ComponentType -> Encoding

toJSONList :: [ComponentType] -> Value

toEncodingList :: [ComponentType] -> Encoding

FromJSON ComponentType

Defined in Calamity.Types.Model.Channel.Component

Methods

parseJSON :: Value -> Parser ComponentType

parseJSONList :: Value -> Parser [ComponentType]

TextShow ComponentType

Defined in Calamity.Types.Model.Channel.Component

Methods

showbPrec :: Int -> ComponentType -> Builder

showb :: ComponentType -> Builder

showbList :: [ComponentType] -> Builder

showtPrec :: Int -> ComponentType -> Text

showt :: ComponentType -> Text

showtList :: [ComponentType] -> Text

showtlPrec :: Int -> ComponentType -> Text

showtl :: ComponentType -> Text

showtlList :: [ComponentType] -> Text

componentType :: Component -> ComponentType