Safe Haskell	None
Language	Haskell2010

Discord.Internal.Types.Components

Description

Message components

Synopsis

data ActionRow
- = ActionRowButtons [Button]
- | ActionRowSelectMenu SelectMenu
data Button
- = Button {
  - buttonCustomId :: Text
  - buttonDisabled :: Bool
  - buttonStyle :: ButtonStyle
  - buttonLabel :: Maybe Text
  - buttonEmoji :: Maybe Emoji
  }
- | ButtonUrl {
  - buttonUrl :: Text
  - buttonDisabled :: Bool
  - buttonLabel :: Maybe Text
  - buttonEmoji :: Maybe Emoji
  }
data ButtonStyle
mkButton :: Text -> Text -> Button
data SelectMenu = SelectMenu {
- selectMenuCustomId :: Text
- selectMenuDisabled :: Bool
- selectMenuOptions :: [SelectOption]
- selectMenuPlaceholder :: Maybe Text
- selectMenuMinValues :: Maybe Integer
- selectMenuMaxValues :: Maybe Integer
}
mkSelectMenu :: Text -> [SelectOption] -> SelectMenu
data SelectOption = SelectOption {
- selectOptionLabel :: Text
- selectOptionValue :: Text
- selectOptionDescription :: Maybe Text
- selectOptionEmoji :: Maybe Emoji
- selectOptionDefault :: Maybe Bool
}
mkSelectOption :: Text -> Text -> SelectOption
data TextInput = TextInput {
- textInputCustomId :: Text
- textInputIsParagraph :: Bool
- textInputLabel :: Text
- textInputMinLength :: Maybe Integer
- textInputMaxLength :: Maybe Integer
- textInputRequired :: Bool
- textInputValue :: Text
- textInputPlaceholder :: Text
}
mkTextInput :: Text -> Text -> TextInput

Documentation

data ActionRow Source #

Container for other message Components

Constructors

ActionRowButtons [Button]
ActionRowSelectMenu SelectMenu

Instances

Instances details

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

data Button 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

Button
Fields buttonCustomId :: Text Dev indentifier buttonDisabled :: Bool Whether the button is disabled buttonStyle :: ButtonStyle What is the style of the button buttonLabel :: Maybe Text What is the user-facing label of the button buttonEmoji :: Maybe Emoji What emoji is displayed on the button
ButtonUrl
Fields buttonUrl :: Text The url for the button. If this is not a valid url, everything will break buttonDisabled :: Bool Whether the button is disabled buttonLabel :: Maybe Text What is the user-facing label of the button buttonEmoji :: Maybe Emoji What emoji is displayed on the button

Instances

Instances details

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

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 -> Button Source #

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

data SelectMenu Source #

Component type for a select menu.

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

Constructors

SelectMenu

Fields

selectMenuCustomId :: Text
Dev identifier
selectMenuDisabled :: Bool
Whether the select menu is disabled
selectMenuOptions :: [SelectOption]
What options are in this select menu (up to 25)
selectMenuPlaceholder :: Maybe Text
Placeholder text if nothing is selected
selectMenuMinValues :: Maybe Integer
Minimum number of values to select (def 1, min 0, max 25)
selectMenuMaxValues :: Maybe Integer
Maximum number of values to select (def 1, max 25)

Instances

Instances details

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

mkSelectMenu :: Text -> [SelectOption] -> SelectMenu 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 TextInput Source #

Constructors

TextInput

Fields

textInputCustomId :: Text
Dev identifier
textInputIsParagraph :: Bool
What style to use (short or paragraph)
textInputLabel :: Text
The label for this component
textInputMinLength :: Maybe Integer
The minimum input length for a text input (0-4000)
textInputMaxLength :: Maybe Integer
The maximum input length for a text input (1-4000)
textInputRequired :: Bool
Whether this component is required to be filled
textInputValue :: Text
The prefilled value for this component (max 4000)
textInputPlaceholder :: Text
Placeholder text if empty (max 4000)

Instances

Instances details

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

mkTextInput :: Text -> Text -> TextInput Source #

Create a text input from an id and a label