Safe Haskell	None
Language	Haskell2010

Discord.Internal.Types.Components

Synopsis

data ComponentActionRow
- = ComponentActionRowButton [ComponentButton]
- | ComponentActionRowSelectMenu ComponentSelectMenu
data ComponentButton
- = ComponentButton {
  - componentButtonCustomId :: Text
  - componentButtonDisabled :: Bool
  - componentButtonStyle :: ButtonStyle
  - componentButtonLabel :: Maybe Text
  - componentButtonEmoji :: Maybe Emoji
  }
- | ComponentButtonUrl {
  - componentButtonUrl :: Text
  - componentButtonDisabled :: Bool
  - componentButtonLabel :: Maybe Text
  - componentButtonEmoji :: Maybe Emoji
  }
data ButtonStyle
mkButton :: Text -> Text -> ComponentButton
data ComponentSelectMenu = ComponentSelectMenu {
}
mkSelectMenu :: Text -> [SelectOption] -> ComponentSelectMenu
data SelectOption = SelectOption {
- selectOptionLabel :: Text
- selectOptionValue :: Text
- selectOptionDescription :: Maybe Text
- selectOptionEmoji :: Maybe Emoji
- selectOptionDefault :: Maybe Bool
}
mkSelectOption :: Text -> Text -> SelectOption
data ComponentTextInput = ComponentTextInput {
}
mkComponentTextInput :: Text -> Text -> ComponentTextInput
data Emoji = Emoji {
- emojiId :: Maybe EmojiId
- emojiName :: Text
- emojiRoles :: Maybe [RoleId]
- emojiUser :: Maybe User
- emojiManaged :: Maybe Bool
- emojiAnimated :: Maybe Bool
}
mkEmoji :: Text -> Emoji

Documentation

data ComponentActionRow Source #

Constructors

ComponentActionRowButton [ComponentButton]
ComponentActionRowSelectMenu ComponentSelectMenu

Instances

Instances details

Eq ComponentActionRow Source #
Instance details Defined in Discord.Internal.Types.Components Methods (==) :: ComponentActionRow -> ComponentActionRow -> Bool # (/=) :: ComponentActionRow -> ComponentActionRow -> Bool #
Ord ComponentActionRow Source #
Instance details Defined in Discord.Internal.Types.Components Methods compare :: ComponentActionRow -> ComponentActionRow -> Ordering # (<) :: ComponentActionRow -> ComponentActionRow -> Bool # (<=) :: ComponentActionRow -> ComponentActionRow -> Bool # (>) :: ComponentActionRow -> ComponentActionRow -> Bool # (>=) :: ComponentActionRow -> ComponentActionRow -> Bool # max :: ComponentActionRow -> ComponentActionRow -> ComponentActionRow # min :: ComponentActionRow -> ComponentActionRow -> ComponentActionRow #
Read ComponentActionRow Source #
Instance details Defined in Discord.Internal.Types.Components Methods readsPrec :: Int -> ReadS ComponentActionRow # readList :: ReadS [ComponentActionRow] # readPrec :: ReadPrec ComponentActionRow # readListPrec :: ReadPrec [ComponentActionRow] #
Show ComponentActionRow Source #
Instance details Defined in Discord.Internal.Types.Components Methods showsPrec :: Int -> ComponentActionRow -> ShowS # show :: ComponentActionRow -> String # showList :: [ComponentActionRow] -> ShowS #
ToJSON ComponentActionRow Source #
Instance details Defined in Discord.Internal.Types.Components Methods toJSON :: ComponentActionRow -> Value # toEncoding :: ComponentActionRow -> Encoding # toJSONList :: [ComponentActionRow] -> Value # toEncodingList :: [ComponentActionRow] -> Encoding #
FromJSON ComponentActionRow Source #
Instance details Defined in Discord.Internal.Types.Components Methods parseJSON :: Value -> Parser ComponentActionRow # parseJSONList :: Value -> Parser [ComponentActionRow] #

data ComponentButton Source #

Component type for a button, split into URL button and not URL button.

Don't directly send button components - they need to be within an action row.

Constructors

ComponentButton
Fields componentButtonCustomId :: Text Dev indentifier componentButtonDisabled :: Bool Whether the button is disabled componentButtonStyle :: ButtonStyle What is the style of the button componentButtonLabel :: Maybe Text What is the user-facing label of the button componentButtonEmoji :: Maybe Emoji What emoji is displayed on the button
ComponentButtonUrl
Fields componentButtonUrl :: Text The url for the button. If this is not a valid url, everything will break componentButtonDisabled :: Bool Whether the button is disabled componentButtonLabel :: Maybe Text What is the user-facing label of the button componentButtonEmoji :: Maybe Emoji What emoji is displayed on the button

Instances

Instances details

Eq ComponentButton Source #
Instance details Defined in Discord.Internal.Types.Components Methods (==) :: ComponentButton -> ComponentButton -> Bool # (/=) :: ComponentButton -> ComponentButton -> Bool #
Ord ComponentButton Source #
Instance details Defined in Discord.Internal.Types.Components Methods compare :: ComponentButton -> ComponentButton -> Ordering # (<) :: ComponentButton -> ComponentButton -> Bool # (<=) :: ComponentButton -> ComponentButton -> Bool # (>) :: ComponentButton -> ComponentButton -> Bool # (>=) :: ComponentButton -> ComponentButton -> Bool # max :: ComponentButton -> ComponentButton -> ComponentButton # min :: ComponentButton -> ComponentButton -> ComponentButton #
Read ComponentButton Source #
Instance details Defined in Discord.Internal.Types.Components Methods readsPrec :: Int -> ReadS ComponentButton # readList :: ReadS [ComponentButton] # readPrec :: ReadPrec ComponentButton # readListPrec :: ReadPrec [ComponentButton] #
Show ComponentButton Source #
Instance details Defined in Discord.Internal.Types.Components Methods showsPrec :: Int -> ComponentButton -> ShowS # show :: ComponentButton -> String # showList :: [ComponentButton] -> ShowS #
ToJSON ComponentButton Source #
Instance details Defined in Discord.Internal.Types.Components Methods toJSON :: ComponentButton -> Value # toEncoding :: ComponentButton -> Encoding # toJSONList :: [ComponentButton] -> Value # toEncodingList :: [ComponentButton] -> Encoding #
FromJSON ComponentButton Source #
Instance details Defined in Discord.Internal.Types.Components Methods parseJSON :: Value -> Parser ComponentButton # parseJSONList :: Value -> Parser [ComponentButton] #

data ButtonStyle Source #

Buttton colors.

Constructors

ButtonStylePrimary	Blurple button
ButtonStyleSecondary	Grey button
ButtonStyleSuccess	Green button
ButtonStyleDanger	Red button

Instances

Instances details

Eq ButtonStyle Source #
Instance details Defined in Discord.Internal.Types.Components Methods (==) :: ButtonStyle -> ButtonStyle -> Bool # (/=) :: ButtonStyle -> ButtonStyle -> Bool #
Ord ButtonStyle Source #
Instance details Defined in Discord.Internal.Types.Components Methods compare :: ButtonStyle -> ButtonStyle -> Ordering # (<) :: ButtonStyle -> ButtonStyle -> Bool # (<=) :: ButtonStyle -> ButtonStyle -> Bool # (>) :: ButtonStyle -> ButtonStyle -> Bool # (>=) :: ButtonStyle -> ButtonStyle -> Bool # max :: ButtonStyle -> ButtonStyle -> ButtonStyle # min :: ButtonStyle -> ButtonStyle -> ButtonStyle #
Read ButtonStyle Source #
Instance details Defined in Discord.Internal.Types.Components Methods readsPrec :: Int -> ReadS ButtonStyle # readList :: ReadS [ButtonStyle] # readPrec :: ReadPrec ButtonStyle # readListPrec :: ReadPrec [ButtonStyle] #
Show ButtonStyle Source #
Instance details Defined in Discord.Internal.Types.Components Methods showsPrec :: Int -> ButtonStyle -> ShowS # show :: ButtonStyle -> String # showList :: [ButtonStyle] -> ShowS #
ToJSON ButtonStyle Source #
Instance details Defined in Discord.Internal.Types.Components Methods toJSON :: ButtonStyle -> Value # toEncoding :: ButtonStyle -> Encoding # toJSONList :: [ButtonStyle] -> Value # toEncodingList :: [ButtonStyle] -> Encoding #
FromJSON ButtonStyle Source #
Instance details Defined in Discord.Internal.Types.Components Methods parseJSON :: Value -> Parser ButtonStyle # parseJSONList :: Value -> Parser [ButtonStyle] #

mkButton :: Text -> Text -> ComponentButton Source #

Takes the label and the custom id of the button that is to be generated.

data ComponentSelectMenu Source #

Component type for a select menus.

Don't directly send select menus - they need to be within an action row.

Constructors

ComponentSelectMenu

Fields

componentSelectMenuCustomId :: Text
Dev identifier
componentSelectMenuDisabled :: Bool
Whether the select menu is disabled
componentSelectMenuOptions :: [SelectOption]
What options are in this select menu (up to 25)
componentSelectMenuPlaceholder :: Maybe Text
Placeholder text if nothing is selected
componentSelectMenuMinValues :: Maybe Integer
Minimum number of values to select (def 1, min 0, max 25)
componentSelectMenuMaxValues :: Maybe Integer
Maximum number of values to select (def 1, max 25)

Instances

Instances details

Eq ComponentSelectMenu Source #
Instance details Defined in Discord.Internal.Types.Components Methods (==) :: ComponentSelectMenu -> ComponentSelectMenu -> Bool # (/=) :: ComponentSelectMenu -> ComponentSelectMenu -> Bool #
Ord ComponentSelectMenu Source #
Instance details Defined in Discord.Internal.Types.Components Methods compare :: ComponentSelectMenu -> ComponentSelectMenu -> Ordering # (<) :: ComponentSelectMenu -> ComponentSelectMenu -> Bool # (<=) :: ComponentSelectMenu -> ComponentSelectMenu -> Bool # (>) :: ComponentSelectMenu -> ComponentSelectMenu -> Bool # (>=) :: ComponentSelectMenu -> ComponentSelectMenu -> Bool # max :: ComponentSelectMenu -> ComponentSelectMenu -> ComponentSelectMenu # min :: ComponentSelectMenu -> ComponentSelectMenu -> ComponentSelectMenu #
Read ComponentSelectMenu Source #
Instance details Defined in Discord.Internal.Types.Components Methods readsPrec :: Int -> ReadS ComponentSelectMenu # readList :: ReadS [ComponentSelectMenu] # readPrec :: ReadPrec ComponentSelectMenu # readListPrec :: ReadPrec [ComponentSelectMenu] #
Show ComponentSelectMenu Source #
Instance details Defined in Discord.Internal.Types.Components Methods showsPrec :: Int -> ComponentSelectMenu -> ShowS # show :: ComponentSelectMenu -> String # showList :: [ComponentSelectMenu] -> ShowS #
ToJSON ComponentSelectMenu Source #
Instance details Defined in Discord.Internal.Types.Components Methods toJSON :: ComponentSelectMenu -> Value # toEncoding :: ComponentSelectMenu -> Encoding # toJSONList :: [ComponentSelectMenu] -> Value # toEncodingList :: [ComponentSelectMenu] -> Encoding #
FromJSON ComponentSelectMenu Source #
Instance details Defined in Discord.Internal.Types.Components Methods parseJSON :: Value -> Parser ComponentSelectMenu # parseJSONList :: Value -> Parser [ComponentSelectMenu] #

mkSelectMenu :: Text -> [SelectOption] -> ComponentSelectMenu Source #

Takes the custom id and the options of the select menu that is to be generated.

data SelectOption Source #

A single option in a select menu.

Constructors

SelectOption
Fields selectOptionLabel :: Text User facing option name selectOptionValue :: Text Dev facing option value selectOptionDescription :: Maybe Text additional description selectOptionEmoji :: Maybe Emoji A partial emoji to show with the object (id, name, animated) selectOptionDefault :: Maybe Bool Use this value by default

Instances

Instances details

Eq SelectOption Source #
Instance details Defined in Discord.Internal.Types.Components Methods (==) :: SelectOption -> SelectOption -> Bool # (/=) :: SelectOption -> SelectOption -> Bool #
Ord SelectOption Source #
Instance details Defined in Discord.Internal.Types.Components Methods compare :: SelectOption -> SelectOption -> Ordering # (<) :: SelectOption -> SelectOption -> Bool # (<=) :: SelectOption -> SelectOption -> Bool # (>) :: SelectOption -> SelectOption -> Bool # (>=) :: SelectOption -> SelectOption -> Bool # max :: SelectOption -> SelectOption -> SelectOption # min :: SelectOption -> SelectOption -> SelectOption #
Read SelectOption Source #
Instance details Defined in Discord.Internal.Types.Components Methods readsPrec :: Int -> ReadS SelectOption # readList :: ReadS [SelectOption] # readPrec :: ReadPrec SelectOption # readListPrec :: ReadPrec [SelectOption] #
Show SelectOption Source #
Instance details Defined in Discord.Internal.Types.Components Methods showsPrec :: Int -> SelectOption -> ShowS # show :: SelectOption -> String # showList :: [SelectOption] -> ShowS #
ToJSON SelectOption Source #
Instance details Defined in Discord.Internal.Types.Components Methods toJSON :: SelectOption -> Value # toEncoding :: SelectOption -> Encoding # toJSONList :: [SelectOption] -> Value # toEncodingList :: [SelectOption] -> Encoding #
FromJSON SelectOption Source #
Instance details Defined in Discord.Internal.Types.Components Methods parseJSON :: Value -> Parser SelectOption # parseJSONList :: Value -> Parser [SelectOption] #

mkSelectOption :: Text -> Text -> SelectOption Source #

Make a select option from the given label and value.

data ComponentTextInput Source #

Constructors

ComponentTextInput

Fields

componentTextInputCustomId :: Text
Dev identifier
componentTextInputIsParagraph :: Bool
What style to use (short or paragraph)
componentTextInputLabel :: Text
The label for this component
componentTextInputMinLength :: Maybe Integer
The minimum input length for a text input (0-4000)
componentTextInputMaxLength :: Maybe Integer
The maximum input length for a text input (1-4000)
componentTextInputRequired :: Bool
Whether this component is required to be filled
componentTextInputValue :: Text
The prefilled value for this component (max 4000)
componentTextInputPlaceholder :: Text
Placeholder text if empty (max 4000)

Instances

Instances details

Eq ComponentTextInput Source #
Instance details Defined in Discord.Internal.Types.Components Methods (==) :: ComponentTextInput -> ComponentTextInput -> Bool # (/=) :: ComponentTextInput -> ComponentTextInput -> Bool #
Ord ComponentTextInput Source #
Instance details Defined in Discord.Internal.Types.Components Methods compare :: ComponentTextInput -> ComponentTextInput -> Ordering # (<) :: ComponentTextInput -> ComponentTextInput -> Bool # (<=) :: ComponentTextInput -> ComponentTextInput -> Bool # (>) :: ComponentTextInput -> ComponentTextInput -> Bool # (>=) :: ComponentTextInput -> ComponentTextInput -> Bool # max :: ComponentTextInput -> ComponentTextInput -> ComponentTextInput # min :: ComponentTextInput -> ComponentTextInput -> ComponentTextInput #
Read ComponentTextInput Source #
Instance details Defined in Discord.Internal.Types.Components Methods readsPrec :: Int -> ReadS ComponentTextInput # readList :: ReadS [ComponentTextInput] # readPrec :: ReadPrec ComponentTextInput # readListPrec :: ReadPrec [ComponentTextInput] #
Show ComponentTextInput Source #
Instance details Defined in Discord.Internal.Types.Components Methods showsPrec :: Int -> ComponentTextInput -> ShowS # show :: ComponentTextInput -> String # showList :: [ComponentTextInput] -> ShowS #
ToJSON ComponentTextInput Source #
Instance details Defined in Discord.Internal.Types.Components Methods toJSON :: ComponentTextInput -> Value # toEncoding :: ComponentTextInput -> Encoding # toJSONList :: [ComponentTextInput] -> Value # toEncodingList :: [ComponentTextInput] -> Encoding #
FromJSON ComponentTextInput Source #
Instance details Defined in Discord.Internal.Types.Components Methods parseJSON :: Value -> Parser ComponentTextInput # parseJSONList :: Value -> Parser [ComponentTextInput] #

mkComponentTextInput :: Text -> Text -> ComponentTextInput Source #

data Emoji Source #

Represents an emoticon (emoji)

Constructors

Emoji
Fields emojiId :: Maybe EmojiId The emoji id emojiName :: Text The emoji name emojiRoles :: Maybe [RoleId] Roles the emoji is active for emojiUser :: Maybe User User that created this emoji emojiManaged :: Maybe Bool Whether this emoji is managed emojiAnimated :: Maybe Bool Whether this emoji is animated

Instances

Instances details

Eq Emoji Source #
Instance details Defined in Discord.Internal.Types.Components Methods (==) :: Emoji -> Emoji -> Bool # (/=) :: Emoji -> Emoji -> Bool #
Ord Emoji Source #
Instance details Defined in Discord.Internal.Types.Components Methods compare :: Emoji -> Emoji -> Ordering # (<) :: Emoji -> Emoji -> Bool # (<=) :: Emoji -> Emoji -> Bool # (>) :: Emoji -> Emoji -> Bool # (>=) :: Emoji -> Emoji -> Bool # max :: Emoji -> Emoji -> Emoji # min :: Emoji -> Emoji -> Emoji #
Read Emoji Source #
Instance details Defined in Discord.Internal.Types.Components Methods readsPrec :: Int -> ReadS Emoji # readList :: ReadS [Emoji] # readPrec :: ReadPrec Emoji # readListPrec :: ReadPrec [Emoji] #
Show Emoji Source #
Instance details Defined in Discord.Internal.Types.Components Methods showsPrec :: Int -> Emoji -> ShowS # show :: Emoji -> String # showList :: [Emoji] -> ShowS #
ToJSON Emoji Source #
Instance details Defined in Discord.Internal.Types.Components Methods toJSON :: Emoji -> Value # toEncoding :: Emoji -> Encoding # toJSONList :: [Emoji] -> Value # toEncodingList :: [Emoji] -> Encoding #
FromJSON Emoji Source #
Instance details Defined in Discord.Internal.Types.Components Methods parseJSON :: Value -> Parser Emoji # parseJSONList :: Value -> Parser [Emoji] #

mkEmoji :: Text -> Emoji Source #

Make an emoji with only a name