Discord.Internal.Types.Components

Documentation

data ComponentButton

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
• componentButtonDisabled :: Bool
• componentButtonStyle :: ButtonStyle
• componentButtonLabel :: Text
• componentButtonEmoji :: Maybe Emoji

ComponentButtonUrl

Fields

• componentButtonUrl :: Url 'Https
• componentButtonDisabled :: Bool
• componentButtonLabel :: Text
• componentButtonEmoji :: Maybe Emoji

Instances

Eq ComponentButton

Defined in Discord.Internal.Types.Components

Methods

(==) :: ComponentButton -> ComponentButton -> Bool

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

Show ComponentButton

Defined in Discord.Internal.Types.Components

Methods

showsPrec :: Int -> ComponentButton -> ShowS

show :: ComponentButton -> String

showList :: [ComponentButton] -> ShowS

data ButtonStyle

Constructors

ButtonStylePrimary

ButtonStyleSecondary

ButtonStyleSuccess

ButtonStyleDanger

Instances

Eq ButtonStyle

Defined in Discord.Internal.Types.Components

Methods

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

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

Read ButtonStyle

Defined in Discord.Internal.Types.Components

Methods

readsPrec :: Int -> ReadS ButtonStyle

readList :: ReadS [ButtonStyle]

readPrec :: ReadPrec ButtonStyle

readListPrec :: ReadPrec [ButtonStyle]

Show ButtonStyle

Defined in Discord.Internal.Types.Components

Methods

showsPrec :: Int -> ButtonStyle -> ShowS

show :: ButtonStyle -> String

showList :: [ButtonStyle] -> ShowS

Internals ButtonStyle InternalButtonStyle

Defined in Discord.Internal.Types.Components

Methods

toInternal :: ButtonStyle -> InternalButtonStyle

fromInternal :: InternalButtonStyle -> Maybe ButtonStyle

buttonStyles :: [(ButtonStyle, InternalButtonStyle)]

data ComponentSelectMenu

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
• componentSelectMenuDisabled :: Bool
• componentSelectMenuOptions :: [SelectOption]
• componentSelectMenuPlaceholder :: Maybe Text
• componentSelectMenuMinValues :: Maybe Integer
• componentSelectMenuMaxValues :: Maybe Integer

Instances

Eq ComponentSelectMenu

Defined in Discord.Internal.Types.Components

Methods

(==) :: ComponentSelectMenu -> ComponentSelectMenu -> Bool

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

Read ComponentSelectMenu

Defined in Discord.Internal.Types.Components

Methods

readsPrec :: Int -> ReadS ComponentSelectMenu

readList :: ReadS [ComponentSelectMenu]

readPrec :: ReadPrec ComponentSelectMenu

readListPrec :: ReadPrec [ComponentSelectMenu]

Show ComponentSelectMenu

Defined in Discord.Internal.Types.Components

Methods

showsPrec :: Int -> ComponentSelectMenu -> ShowS

show :: ComponentSelectMenu -> String

showList :: [ComponentSelectMenu] -> ShowS

data ComponentActionRow

Constructors

ComponentActionRowButton [ComponentButton]

ComponentActionRowSelectMenu ComponentSelectMenu

Instances

Eq ComponentActionRow

Defined in Discord.Internal.Types.Components

Methods

(==) :: ComponentActionRow -> ComponentActionRow -> Bool

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

Show ComponentActionRow

Defined in Discord.Internal.Types.Components

Methods

showsPrec :: Int -> ComponentActionRow -> ShowS

show :: ComponentActionRow -> String

showList :: [ComponentActionRow] -> ShowS

Internals ComponentActionRow Component

Defined in Discord.Internal.Types.Components

Methods

toInternal :: ComponentActionRow -> Component

fromInternal :: Component -> Maybe ComponentActionRow

validPartialEmoji :: Emoji -> Maybe Emoji

data Component

Constructors

Component

Fields

• componentType :: ComponentType
• componentCustomId :: Maybe Text

  Buttons and Select Menus only

• componentDisabled :: Maybe Bool

  Buttons and Select Menus only

• componentStyle :: Maybe InternalButtonStyle

  Button only

• componentLabel :: Maybe Text

  Button only

• componentEmoji :: Maybe Emoji

  Button only

• componentUrl :: Maybe Text

  Button only, link buttons only

• componentOptions :: Maybe [SelectOption]

  Select Menus only, max 25

• componentPlaceholder :: Maybe Text

  Select Menus only, max 100 chars

• componentMinValues :: Maybe Integer

  Select Menus only, min values to choose, default 1

• componentMaxValues :: Maybe Integer

  Select Menus only, max values to choose, default 1

• componentComponents :: Maybe [Component]

  Action Rows only

Instances

Eq Component

Defined in Discord.Internal.Types.Components

Methods

(==) :: Component -> Component -> Bool

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

Ord Component

Defined in Discord.Internal.Types.Components

Methods

compare :: Component -> Component -> Ordering

(<) :: Component -> Component -> Bool

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

(>) :: Component -> Component -> Bool

(>=) :: Component -> Component -> Bool

max :: Component -> Component -> Component

min :: Component -> Component -> Component

Read Component

Defined in Discord.Internal.Types.Components

Methods

readsPrec :: Int -> ReadS Component

readList :: ReadS [Component]

readPrec :: ReadPrec Component

readListPrec :: ReadPrec [Component]

Show Component

Defined in Discord.Internal.Types.Components

Methods

showsPrec :: Int -> Component -> ShowS

show :: Component -> String

showList :: [Component] -> ShowS

ToJSON Component

Defined in Discord.Internal.Types.Components

Methods

toJSON :: Component -> Value

toEncoding :: Component -> Encoding

toJSONList :: [Component] -> Value

toEncodingList :: [Component] -> Encoding

FromJSON Component

Defined in Discord.Internal.Types.Components

Methods

parseJSON :: Value -> Parser Component

parseJSONList :: Value -> Parser [Component]

Internals ComponentActionRow Component

Defined in Discord.Internal.Types.Components

Methods

toInternal :: ComponentActionRow -> Component

fromInternal :: Component -> Maybe ComponentActionRow

data ComponentType

The different types of components

Constructors

ComponentTypeActionRow

A container for other components

ComponentTypeButton

A button

ComponentTypeSelectMenu

A select menu for picking from choices

Instances

Enum ComponentType

Defined in Discord.Internal.Types.Components

Methods

succ :: ComponentType -> ComponentType

pred :: ComponentType -> ComponentType

toEnum :: Int -> ComponentType

fromEnum :: ComponentType -> Int

enumFrom :: ComponentType -> [ComponentType]

enumFromThen :: ComponentType -> ComponentType -> [ComponentType]

enumFromTo :: ComponentType -> ComponentType -> [ComponentType]

enumFromThenTo :: ComponentType -> ComponentType -> ComponentType -> [ComponentType]

Eq ComponentType

Defined in Discord.Internal.Types.Components

Methods

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

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

Data ComponentType

Defined in Discord.Internal.Types.Components

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ComponentType -> c ComponentType

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ComponentType

toConstr :: ComponentType -> Constr

dataTypeOf :: ComponentType -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ComponentType)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ComponentType)

gmapT :: (forall b. Data b => b -> b) -> ComponentType -> ComponentType

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ComponentType -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ComponentType -> r

gmapQ :: (forall d. Data d => d -> u) -> ComponentType -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ComponentType -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ComponentType -> m ComponentType

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ComponentType -> m ComponentType

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ComponentType -> m ComponentType

Ord ComponentType

Defined in Discord.Internal.Types.Components

Methods

compare :: ComponentType -> ComponentType -> Ordering

(<) :: ComponentType -> ComponentType -> Bool

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

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

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

max :: ComponentType -> ComponentType -> ComponentType

min :: ComponentType -> ComponentType -> ComponentType

Read ComponentType

Defined in Discord.Internal.Types.Components

Methods

readsPrec :: Int -> ReadS ComponentType

readList :: ReadS [ComponentType]

readPrec :: ReadPrec ComponentType

readListPrec :: ReadPrec [ComponentType]

Show ComponentType

Defined in Discord.Internal.Types.Components

Methods

showsPrec :: Int -> ComponentType -> ShowS

show :: ComponentType -> String

showList :: [ComponentType] -> ShowS

ToJSON ComponentType

Defined in Discord.Internal.Types.Components

Methods

toJSON :: ComponentType -> Value

toEncoding :: ComponentType -> Encoding

toJSONList :: [ComponentType] -> Value

toEncodingList :: [ComponentType] -> Encoding

FromJSON ComponentType

Defined in Discord.Internal.Types.Components

Methods

parseJSON :: Value -> Parser ComponentType

parseJSONList :: Value -> Parser [ComponentType]

data InternalButtonStyle

Constructors

InternalButtonStylePrimary

Blurple button

InternalButtonStyleSecondary

Grey button

InternalButtonStyleSuccess

Green button

InternalButtonStyleDanger

Red button

InternalButtonStyleLink

Grey button, navigates to URL

Instances

Enum InternalButtonStyle

Defined in Discord.Internal.Types.Components

Methods

succ :: InternalButtonStyle -> InternalButtonStyle

pred :: InternalButtonStyle -> InternalButtonStyle

toEnum :: Int -> InternalButtonStyle

fromEnum :: InternalButtonStyle -> Int

enumFrom :: InternalButtonStyle -> [InternalButtonStyle]

enumFromThen :: InternalButtonStyle -> InternalButtonStyle -> [InternalButtonStyle]

enumFromTo :: InternalButtonStyle -> InternalButtonStyle -> [InternalButtonStyle]

enumFromThenTo :: InternalButtonStyle -> InternalButtonStyle -> InternalButtonStyle -> [InternalButtonStyle]

Eq InternalButtonStyle

Defined in Discord.Internal.Types.Components

Methods

(==) :: InternalButtonStyle -> InternalButtonStyle -> Bool

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

Data InternalButtonStyle

Defined in Discord.Internal.Types.Components

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> InternalButtonStyle -> c InternalButtonStyle

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c InternalButtonStyle

toConstr :: InternalButtonStyle -> Constr

dataTypeOf :: InternalButtonStyle -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c InternalButtonStyle)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c InternalButtonStyle)

gmapT :: (forall b. Data b => b -> b) -> InternalButtonStyle -> InternalButtonStyle

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> InternalButtonStyle -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> InternalButtonStyle -> r

gmapQ :: (forall d. Data d => d -> u) -> InternalButtonStyle -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> InternalButtonStyle -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> InternalButtonStyle -> m InternalButtonStyle

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> InternalButtonStyle -> m InternalButtonStyle

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> InternalButtonStyle -> m InternalButtonStyle

Ord InternalButtonStyle

Defined in Discord.Internal.Types.Components

Methods

compare :: InternalButtonStyle -> InternalButtonStyle -> Ordering

(<) :: InternalButtonStyle -> InternalButtonStyle -> Bool

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

(>) :: InternalButtonStyle -> InternalButtonStyle -> Bool

(>=) :: InternalButtonStyle -> InternalButtonStyle -> Bool

max :: InternalButtonStyle -> InternalButtonStyle -> InternalButtonStyle

min :: InternalButtonStyle -> InternalButtonStyle -> InternalButtonStyle

Read InternalButtonStyle

Defined in Discord.Internal.Types.Components

Methods

readsPrec :: Int -> ReadS InternalButtonStyle

readList :: ReadS [InternalButtonStyle]

readPrec :: ReadPrec InternalButtonStyle

readListPrec :: ReadPrec [InternalButtonStyle]

Show InternalButtonStyle

Defined in Discord.Internal.Types.Components

Methods

showsPrec :: Int -> InternalButtonStyle -> ShowS

show :: InternalButtonStyle -> String

showList :: [InternalButtonStyle] -> ShowS

ToJSON InternalButtonStyle

Defined in Discord.Internal.Types.Components

Methods

toJSON :: InternalButtonStyle -> Value

toEncoding :: InternalButtonStyle -> Encoding

toJSONList :: [InternalButtonStyle] -> Value

toEncodingList :: [InternalButtonStyle] -> Encoding

FromJSON InternalButtonStyle

Defined in Discord.Internal.Types.Components

Methods

parseJSON :: Value -> Parser InternalButtonStyle

parseJSONList :: Value -> Parser [InternalButtonStyle]

Internals ButtonStyle InternalButtonStyle

Defined in Discord.Internal.Types.Components

Methods

toInternal :: ButtonStyle -> InternalButtonStyle

fromInternal :: InternalButtonStyle -> Maybe ButtonStyle

data Emoji

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

Eq Emoji

Defined in Discord.Internal.Types.Components

Methods

(==) :: Emoji -> Emoji -> Bool

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

Ord Emoji

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

Defined in Discord.Internal.Types.Components

Methods

readsPrec :: Int -> ReadS Emoji

readList :: ReadS [Emoji]

readPrec :: ReadPrec Emoji

readListPrec :: ReadPrec [Emoji]

Show Emoji

Defined in Discord.Internal.Types.Components

Methods

showsPrec :: Int -> Emoji -> ShowS

show :: Emoji -> String

showList :: [Emoji] -> ShowS

ToJSON Emoji

Defined in Discord.Internal.Types.Components

Methods

toJSON :: Emoji -> Value

toEncoding :: Emoji -> Encoding

toJSONList :: [Emoji] -> Value

toEncodingList :: [Emoji] -> Encoding

FromJSON Emoji

Defined in Discord.Internal.Types.Components

Methods

parseJSON :: Value -> Parser Emoji

parseJSONList :: Value -> Parser [Emoji]

data SelectOption

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

Eq SelectOption

Defined in Discord.Internal.Types.Components

Methods

(==) :: SelectOption -> SelectOption -> Bool

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

Ord SelectOption

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

Defined in Discord.Internal.Types.Components

Methods

readsPrec :: Int -> ReadS SelectOption

readList :: ReadS [SelectOption]

readPrec :: ReadPrec SelectOption

readListPrec :: ReadPrec [SelectOption]

Show SelectOption

Defined in Discord.Internal.Types.Components

Methods

showsPrec :: Int -> SelectOption -> ShowS

show :: SelectOption -> String

showList :: [SelectOption] -> ShowS

ToJSON SelectOption

Defined in Discord.Internal.Types.Components

Methods

toJSON :: SelectOption -> Value

toEncoding :: SelectOption -> Encoding

toJSONList :: [SelectOption] -> Value

toEncodingList :: [SelectOption] -> Encoding

FromJSON SelectOption

Defined in Discord.Internal.Types.Components

Methods

parseJSON :: Value -> Parser SelectOption

parseJSONList :: Value -> Parser [SelectOption]

filterOutIncorrectEmoji :: Component -> Component