Message
Table of Contents
Classes
- ActionRow
- An Action Row is a top-level layout component used in messages and modals.
- AllowedMentions
- The allowed mention field allows for more granular control over mentions without various hacks to the message.
- Button
- A Button is an interactive component that can only be used in messages.
- ChannelSelect
- A Channel Select is an interactive component that allows users to select one or more channels in a message.
- Component
- Components allow you to style and structure your messages, modals, and interactions.
- Container
- A Container is a top-level layout component. Containers are visually distinct from surrounding components and have an optional customizable color bar.
- Content
- Abstract class for content components.
- DefaultValue
- List of default values for auto-populated select menu components; number of default values must be in the range defined by min_values and max_values
- File
- A File is a top-level component that allows you to display an uploaded file as an attachment to the message and reference it in the component. Each file component can only display 1 attached file, but you can upload multiple files and add them to different file components within your payload.
- Interactive
- Abstract class for interactive components.
- Layout
- Abstract class for layout components.
- MediaGallery
- A Media Gallery is a top-level content component that allows you to display 1-10 media attachments in an organized gallery format. Each item can have optional descriptions and can be marked as spoilers.
- MediaGalleryItem
- This class is the base of all objects that are returned. All "Parts" extend
off this base class.
- MentionableSelect
- A Mentionable Select is an interactive component that allows users to select one or more mentionables in a message. Options are automatically populated based on available mentionables in the server.
- MessageCall
- Represents information about a call in a private channel.
- MessageInteractionMetadata
- Represents metadata about the interaction that caused a message.
- MessageReference
- Represents a message reference object, which points to another message for replies, forwards, pins, etc.
- RoleSelect
- A Role Select is an interactive component that allows users to select one or more roles in a message. Options are automatically populated based on the server's available roles.
- Section
- A Separator is a top-level layout component that adds vertical padding and visual division between other components.
- SelectMenu
- Select menus are interactive components that allow users to select one or
more options from a dropdown list in messages.
- Separator
- A Separator is a top-level layout component that adds vertical padding and visual division between other components.
- StringSelect
- A String Select is an interactive component that allows users to select one or more provided options in a message.
- StringSelectOption
- Specified choices in a string select menu; max 25
- TextDisplay
- A Text Display is a top-level content component that allows you to add text to your message formatted with markdown and mention users and roles. This is similar to the content field of a message, but allows you to add multiple text components, controlling the layout of your message.
- TextInput
- Text Input is an interactive component that allows users to enter free-form text responses in modals. It supports both short, single-line inputs and longer, multi-line paragraph inputs.
- Thumbnail
- A Thumbnail is a content component that is a small image only usable as an accessory in a section. The preview comes from an url or attachment through the unfurled media item structure.
- UnfurledMediaItem
- A url or attachment, except in the case of File, which only supports attachment.
- UserSelect
- A User Select is an interactive component that allows users to select one or more users in a message. Options are automatically populated based on the server's available users.