Version: Next

APIButtonComponentWithCustomId

@see: https://discord.com/developers/docs/components/reference#button

Hierarchy

APIButtonComponentBase<ButtonStyle.Danger | ButtonStyle.Primary | ButtonStyle.Secondary | ButtonStyle.Success>
- APIButtonComponentWithCustomId

Index

Properties

custom_id
disabled
emoji
id
label
style
type

Properties

custom_id

custom_id: string

The custom_id to be sent in the interaction when clicked

optionalinheriteddisabled

disabled?: boolean

The status of the button

optionalinheritedemoji

emoji?: APIMessageComponentEmoji

The emoji to display to the left of the text

optionalinheritedid

id?: number

32 bit integer used as an optional identifier for component

The id field is optional and is used to identify components in the response from an interaction that aren't interactive components. The id must be unique within the message and is generated sequentially if left empty. Generation of ids won't use another id that exists in the message if you have one defined for another component.

optionalinheritedlabel

label?: string

The label to be displayed on the button

inheritedstyle

style: Primary | Secondary | Success | Danger

The style of the button

inheritedtype

type: Button

The type of the component