Java Discord API (JDA)

https://docs.jda.wiki/
Admin
The Java Discord API (JDA) is a Java library for interacting with the Discord API, enabling...
Tokens:1,459,959
Snippets:14,652
Trust Score:6
Update:3 months ago
Show doc for...
Tokens:
Raw
### Set Install Parameters

Source: https://docs.jda.wiki/net/dv8tion/jda/api/managers/ApplicationManager.html

Sets the default installation parameters for the application, used when a custom install URL is not employed. This configures scopes and permissions for invite URLs.

```java
manager.setInstallParams(installParams);
```

--------------------------------

### build

Source: https://docs.jda.wiki/net/dv8tion/jda/api/JDABuilder.html

Builds a new `JDA` instance and uses the provided token to start the login process. The login process runs in a different thread, so while this will return immediately, `JDA` has not finished loading, thus many `JDA` methods have the chance to return incorrect information. For example `JDA.getGuilds()` might return an empty list or `JDA.getUserById(long)` might return null for arbitrary user IDs. If you wish to be sure that the `JDA` information is correct, please use `JDA.awaitReady()` or register an `EventListener` to listen for the `ReadyEvent`.

```APIDOC
## build

### Description
Builds a new `JDA` instance and uses the provided token to start the login process. The login process runs in a different thread, so while this will return immediately, `JDA` has not finished loading, thus many `JDA` methods have the chance to return incorrect information. For example `JDA.getGuilds()` might return an empty list or `JDA.getUserById(long)` might return null for arbitrary user IDs. If you wish to be sure that the `JDA` information is correct, please use `JDA.awaitReady()` or register an `EventListener` to listen for the `ReadyEvent`.

### Method
`public JDA build()`

### Parameters
None

### Returns
* `JDA` - A new JDA instance.

```

--------------------------------

### Example: Listening Once for MessageReceivedEvent

Source: https://docs.jda.wiki/net/dv8tion/jda/api/JDA.html

Demonstrates setting up a one-time listener for MessageReceivedEvent, filtering by channel and author, with a timeout and a success callback. This example shows how to react to a specific user's message in a specific channel after a slash command.

```java
final Duration timeout = Duration.ofSeconds(5);
event.reply("Reply in " + TimeFormat.RELATIVE.after(timeout) + " if you can!")
        .setEphemeral(true)
        .queue();

event.getJDA().listenOnce(MessageReceivedEvent.class)
        .filter(messageEvent -> messageEvent.getChannel().getIdLong() == event.getChannel().getIdLong())
        .filter(messageEvent -> messageEvent.getAuthor().getIdLong() == event.getUser().getIdLong())
        .timeout(timeout, () -> {
            event.getHook().editOriginal("Timeout!").queue();
        })
        .subscribe(messageEvent -> {
            event.getHook().editOriginal("You sent: " + messageEvent.getMessage().getContentRaw()).queue();
        });

```

--------------------------------

### StageChannelManager Example

Source: https://docs.jda.wiki/net/dv8tion/jda/api/managers/channel/concrete/StageChannelManager.html

This example demonstrates how to use the StageChannelManager to set the name and bitrate of a stage channel, and then queue the changes.

```APIDOC
## StageChannelManager

Manager providing methods to modify a `StageChannel`.

### Method Summary

Methods inherited from interface `AudioChannelManager`:
`setBitrate(int bitrate)`
`setRegion(String region)`
`setUserLimit(int userLimit)`

Methods inherited from interface `ChannelManager`:
`setName(String name)`

### Example
```java
manager.setName("School Presentations")
       .setBitrate(96000)
       .queue();
```
```

--------------------------------

### start(int shardId)

Source: https://docs.jda.wiki/net/dv8tion/jda/api/sharding/DefaultShardManager.html

Adds and starts a new shard with the specified ID to this ShardManager.

```APIDOC
## start
public void start(int shardId)
### Description
Adds a new shard with the given id to this ShardManager and starts it.
### Parameters
#### Path Parameters
- **shardId** (int) - The id of the shard that should be started
```

--------------------------------

### EntitySelectMenu Creation Example

Source: https://docs.jda.wiki/net/dv8tion/jda/api/components/selections/EntitySelectMenu.html

Demonstrates how to create and send an EntitySelectMenu in response to a slash command interaction. This example shows how to set a custom ID, the target entity type (ROLE in this case), a placeholder text, and the required range for selections.

```APIDOC
## SlashCommandInteractionEvent Handling

### Description
Handles slash command interactions to create and send an `EntitySelectMenu`.

### Method
`onSlashCommandInteraction`

### Endpoint
N/A (SDK method)

### Parameters
- **event** (`SlashCommandInteractionEvent`) - The interaction event.

### Code Example
```java
public void onSlashCommandInteraction(SlashCommandInteractionEvent event) {
  if (!event.getName().equals("class")) return;

  EntitySelectMenu menu = EntitySelectMenu.create("menu:class", SelectTarget.ROLE)
    .setPlaceholder("Choose your class") // shows the placeholder indicating what this menu is for
    .setRequiredRange(1, 1) // must select exactly one
    .build();

  event.reply("Please pick your class below")
    .setEphemeral(true)
    .addComponents(ActionRow.of(menu))
    .queue();
}
```

### Related Methods
- `EntitySelectMenu.create(String, Collection<EntitySelectMenu.SelectTarget>)`
- `EntitySelectMenu.create(String, EntitySelectMenu.SelectTarget, EntitySelectMenu.SelectTarget...)`
- `EntitySelectMenu.Builder.build()`
```

--------------------------------

### login

Source: https://docs.jda.wiki/net/dv8tion/jda/api/sharding/DefaultShardManager.html

Initializes and starts all shards. This method should only be called once.

```APIDOC
## login
public void login()
### Description
Initializes and starts all shards. This should only be called once.
```

--------------------------------

### setInstallParams

Source: https://docs.jda.wiki/net/dv8tion/jda/api/managers/ApplicationManager.html

Sets the default installation parameters of this application. This is used if the application does not use a custom install URL. It configures which scopes and permissions should be applied to invite URLs of this application.

```APIDOC
## setInstallParams

### Description
Sets the default installation parameters of this application. This is used if the application does not use a `custom install URL`. Configures which scopes and permissions should be applied to invite URLs of this application.

### Method
`setInstallParams`

### Parameters
#### Path Parameters
- `installParams` (ApplicationManager.IntegrationTypeConfig) - Optional - The default install parameters

### See Also
- `ApplicationManager.IntegrationTypeConfig.of(Collection, Collection)`
```

--------------------------------

### Set Custom Install URL

Source: https://docs.jda.wiki/net/dv8tion/jda/api/managers/ApplicationManager.html

Sets a custom install URL for the application. The URL has a maximum length of 2048 characters.

```java
manager.setCustomInstallUrl("https://example.com/install");
```

--------------------------------

### Example: Set Global Commands

Source: https://docs.jda.wiki/net/dv8tion/jda/api/JDA.html

Demonstrates setting a list of two global commands, including a slash command with options and context.

```java
jda.updateCommands()
  .addCommands(Commands.slash("ping", "Gives the current ping"))
  .addCommands(Commands.slash("ban", "Ban the target user")
    .setContexts(InteractionContextType.GUILD)
    .setDefaultPermissions(DefaultMemberPermissions.enabledFor(Permission.BAN_MEMBERS))
    .addOption(OptionType.USER, "user", "The user to ban", true))
  .queue();
```

--------------------------------

### getIntegrationTypes()

Source: https://docs.jda.wiki/index-all.html

Gets the integration types on which this command can be installed.

```APIDOC
## getIntegrationTypes()

### Description
Gets the integration types on which this command can be installed on.

### Method
Method

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **integrationTypes** (List<IntegrationType>) - A list of supported integration types.
```

--------------------------------

### SelectOption Creation and Configuration

Source: https://docs.jda.wiki/net/dv8tion/jda/api/components/selections/SelectOption.html

Demonstrates how to create a new SelectOption and configure its properties like label, value, description, emoji, and default status.

```APIDOC
## SelectOption

Represents one of the possible options provided in a `SelectMenu`.

### Methods

#### `static SelectOption of(String label, String value)`
Creates a new SelectOption instance.

Parameters:
- `label` (String) - The label for the option, up to 100 characters.
- `value` (String) - The value for the option, up to 100 characters.

Returns:
A new select option instance.

#### `SelectOption withLabel(String label)`
Returns a copy of this select option with the changed label.

Parameters:
- `label` (String) - The new label for the option, up to 100 characters.

Returns:
The new select option instance.

#### `SelectOption withValue(String value)`
Returns a copy of this select option with the changed value.

Parameters:
- `value` (String) - The new value for the option, up to 100 characters.

Returns:
The new select option instance.

#### `SelectOption withDescription(String description)`
Returns a copy of this select option with the changed description of this option.

Parameters:
- `description` (String) - The new description or null to have no description, up to 100 characters.

Returns:
The new select option instance.

#### `SelectOption withEmoji(Emoji emoji)`
Returns a copy of this select option with the changed emoji.

#### `SelectOption withDefault(boolean isDefault)`
Returns a copy of this select option with the changed default status.

### Constants

- `LABEL_MAX_LENGTH`: The maximum length a select option label can have (100 characters).
- `VALUE_MAX_LENGTH`: The maximum length a select option value can have (100 characters).
- `DESCRIPTION_MAX_LENGTH`: The maximum length a select option description can have (100 characters).
```

--------------------------------

### getStartTime()

Source: https://docs.jda.wiki/index-all.html

Provides a shortcut to get the start time as an Instant.

```APIDOC
## getStartTime()

### Description
Shortcut for `Instant.ofEpochSecond(start)`.

### Method
Method

### Endpoint
N/A (Java Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
N/A

### Response
#### Success Response
- **Instant**: The start time as an Instant object.

#### Response Example
N/A
```

--------------------------------

### AudioChannelManager Example

Source: https://docs.jda.wiki/net/dv8tion/jda/api/managers/channel/middleman/AudioChannelManager.html

Demonstrates how to set the bitrate and region of an audio channel, and how to reset specific properties.

```APIDOC
## AudioChannelManager

### Description
Manager providing functionality common for all `AudioChannels`.

### Example
```java
manager.setBitrate(48000)
       .setRegion(Region.AUTOMATIC)
       .queue();
manager.reset(ChannelManager.REGION | ChannelManager.BITRATE)
       .setRegion(Region.BRAZIL)
       .queue();
```
```

--------------------------------

### getUserInstallCount

Source: https://docs.jda.wiki/net/dv8tion/jda/api/entities/ApplicationInfo.html

Gets the approximate count of users that have installed this application, or -1 if it is unknown.

```APIDOC
## getUserInstallCount

### Description
The approximate count of users that have installed this application, or `-1` if it is unknown.

### Method
```java
long getUserInstallCount()
```

### Returns
The approximate count of users that have installed this application.
```

--------------------------------

### StandardGuildChannelManager Example

Source: https://docs.jda.wiki/net/dv8tion/jda/api/managers/channel/middleman/StandardGuildChannelManager.html

Demonstrates how to use StandardGuildChannelManager to set a channel's name, parent, and queue changes, as well as how to reset and modify permission overrides.

```APIDOC
## StandardGuildChannelManager

Manager providing functionality common for all `StandardGuildChannels`.

### Example
```java
manager.setName("help")
       .setParent(categoryChannel)
       .queue();
manager.reset(ChannelManager.PARENT | ChannelManager.NAME)
       .putPermissionOverride(member, 0, Permission.ALL_PERMISSIONS)
       .queue();
```

### See Also
* `StandardGuildChannel.getManager()`
```

--------------------------------

### getIntegrationTypes

Source: https://docs.jda.wiki/net/dv8tion/jda/api/interactions/commands/build/CommandData.html

Gets the integration types on which this command can be installed. Returns an unmodifiable set of IntegrationType.

```APIDOC
## getIntegrationTypes

### Description
Gets the integration types on which this command can be installed on.

### Method
GET

### Endpoint
N/A (Method within a class)

### Returns
@Nonnull @UnmodifiableView Set<IntegrationType> - The integration types on which this command can be installed on.
```

--------------------------------

### Thread Channel Start Message Retrieval

Source: https://docs.jda.wiki/index-all.html

Attempts to get the Message that was posted when this thread was created.

```APIDOC
## retrieveStartMessage()

### Description
Attempts to get the `Message` that was posted when this thread was created.

### Method
`retrieveStartMessage()`

### Endpoint
N/A (Java Method Call)

### Response
Returns the starting `Message` of the thread or null if it cannot be retrieved.
```

--------------------------------

### initialize

Source: https://docs.jda.wiki/net/dv8tion/jda/api/audio/dave/DaveSession.html

Called when the connection is established.

```APIDOC
## initialize

### Description
Called when the connection is established.

### Method
void
```

--------------------------------

### Get Activity Timestamps

Source: https://docs.jda.wiki/net/dv8tion/jda/api/entities/Activity.html

Retrieves the timestamps associated with the Activity, which can indicate the start and end times of a match or session.

```java
activity.getTimestamps()
```

--------------------------------

### Get Scheduled Event Manager

Source: https://docs.jda.wiki/net/dv8tion/jda/api/entities/ScheduledEvent.html

Retrieves the ScheduledEventManager for this event, allowing modification of event details, starting, ending, or canceling the event.

```APIDOC
## getManager
@Nonnull @CheckReturnValue ScheduledEventManager getManager()

### Description
The `ScheduledEventManager` for this event. In the ScheduledEventManager, you can modify all values and also start, end, or cancel events. You can modify multiple fields in one request by chaining setters before calling `RestAction.queue()`.

### Returns
The ScheduledEventManager of this event.

### Throws
* `InsufficientPermissionException` - If the currently logged in account created the event, and does not have `Permission.MANAGE_EVENTS` nor `Permission.CREATE_SCHEDULED_EVENTS`, or if the account did not create the event and does not have `Permission.MANAGE_EVENTS`.
```

--------------------------------

### Get Mentioned Users Count

Source: https://docs.jda.wiki/net/dv8tion/jda/api/entities/Mentions.html

Retrieves a distinct list of mentioned users and their mention counts from a message. This example demonstrates iterating through the distinct mentions and using a Bag to get the count for each user. It handles direct mentions and mentions via replies.

```java
void sendCount(Message msg)
{
    List<User> mentions = msg.getMentions().getUsers(); // distinct list, in order of appearance
    Bag<User> count = msg.getMentions().getUsersBag();
    StringBuilder content = new StringBuilder();
    for (User user : mentions)
    {
        content.append(user.getAsTag())
               .append(": ")
               .append(count.getCount(user))
               .append("\n");
    }
    msg.getChannel().sendMessage(content.toString()).queue();
}
```

--------------------------------

### Get Gateway WebSocket Scheduler

Source: https://docs.jda.wiki/net/dv8tion/jda/api/JDA.html

Retrieves the ScheduledExecutorService responsible for sending WebSocket messages to Discord, including initial setup and connection maintenance.

```java
ScheduledExecutorService gatewayPool = jda.getGatewayPool();
```

--------------------------------

### GuildWelcomeScreen.Channel.of(StandardGuildChannel, String)

Source: https://docs.jda.wiki/index-all.html

Constructs a new welcome channel.

```APIDOC
## GuildWelcomeScreen.Channel.of(StandardGuildChannel, String)

### Description
Constructs a new welcome channel.

### Method
Static

### Parameters
* **StandardGuildChannel** - The guild channel.
* **String** - The welcome message.
```

--------------------------------

### Get All Scheduled Events

Source: https://docs.jda.wiki/net/dv8tion/jda/api/entities/Guild.html

Retrieves all ScheduledEvents currently in this guild. The events are sorted by their start time, and then by their snowflake ID for events starting at the same time. This method creates a new list on each call, so it's recommended to cache the result if called frequently. Requires `CacheFlag.SCHEDULED_EVENTS` to be enabled.

```APIDOC
## getScheduledEvents

### Description
Gets all `ScheduledEvents` in this guild. Scheduled events are sorted by their start time, and events that start at the same time are sorted by their snowflake ID. This copies the backing store into a list. This means every call creates a new list with O(n) complexity. It is recommended to store this into a local variable or use `getScheduledEventCache()` and use its more efficient versions of handling these values. This requires `CacheFlag.SCHEDULED_EVENTS` to be enabled.

### Returns
Possibly-empty immutable List of `ScheduledEvents`.

### Throws
* `DetachedEntityException` - If this entity is `detached`
```

--------------------------------

### Update Guild Welcome Screen

Source: https://docs.jda.wiki/net/dv8tion/jda/api/managers/GuildWelcomeScreenManager.html

Demonstrates how to enable or disable the welcome screen, set a description, and configure welcome channels. This snippet shows both disabling with a null description and enabling with a custom description and channels, including emojis.

```java
manager.setEnabled(false)
       .setDescription(null)
       .setWelcomeChannels()
       .queue();
manager.setEnabled(true)
       .setDescription("Bot desc")
       .setWelcomeChannels(Arrays.asList(
               GuildWelcomeScreen.Channel.of(rulesChannel, "Read the rules first"),
               GuildWelcomeScreen.Channel.of(generalChannel, "Go have a chat", Emoji.fromUnicode("U+1F4AC"))
       ))
       .queue();
```

--------------------------------

### Get Activity State

Source: https://docs.jda.wiki/net/dv8tion/jda/api/entities/Activity.html

Retrieves the user's activity state, which appears below the main activity information. Example: 'Looking to Play', 'Playing Solo'.

```java
activity.getState()
```

--------------------------------

### Modal Creation and Interaction Example

Source: https://docs.jda.wiki/net/dv8tion/jda/api/modals/Modal.html

Demonstrates how to create a modal with text inputs and reply to a slash command interaction with it.

```APIDOC
## Slash Command Interaction with Modal

### Description
This example shows how to handle a slash command interaction, create a modal with subject and body text inputs, and then reply to the interaction with the constructed modal.

### Method
`onSlashCommandInteraction(@Nonnull SlashCommandInteractionEvent event)`

### Endpoint
N/A (Client-side interaction handling)

### Parameters
- `event` (SlashCommandInteractionEvent) - The event object for the slash command interaction.

### Request Body
N/A

### Request Example
```java
public void onSlashCommandInteraction(@Nonnull SlashCommandInteractionEvent event)
{
    if (event.getName().equals("modmail"))
    {
        TextInput subject = TextInput.create("subject", TextInputStyle.SHORT)
                .setPlaceholder("Subject of this ticket")
                .setMinLength(10)
                .setMaxLength(100) // or setRequiredRange(10, 100)
                .build();

        TextInput body = TextInput.create("body", TextInputStyle.PARAGRAPH)
                .setPlaceholder("Your concerns go here")
                .setMinLength(30)
                .setMaxLength(1000)
                .build();

        Modal modal = Modal.create("modmail", "Modmail")
                .addComponents(Label.of("Subject", subject), Label.of("Body", body))
                .build();

        event.replyModal(modal).queue();
    }
}
```

### Response
#### Success Response
Opens a modal on the user's Discord client.

#### Response Example
N/A (Modal is presented to the user)
```

--------------------------------

### VoiceChannelManager Example

Source: https://docs.jda.wiki/net/dv8tion/jda/api/managers/channel/concrete/VoiceChannelManager.html

Demonstrates how to use VoiceChannelManager to set the name and bitrate of a VoiceChannel.

```APIDOC
## VoiceChannelManager

### Description
Manager providing methods to modify a `VoiceChannel`.

### Example
```java
manager.setName("Music")
       .setBitrate(96000)
       .queue();
```

### Methods
#### Inherited from AudioChannelManager
- `setBitrate(int bitrate)`: Sets the bitrate of the voice channel.
- `setRegion(String region)`: Sets the region of the voice channel.
- `setUserLimit(int userLimit)`: Sets the user limit for the voice channel.

#### Inherited from ChannelManager
- `setName(String name)`: Sets the name of the channel.
- `reset()`: Resets all changes made to the channel.

#### Inherited from IAgeRestrictedChannelManager
- `setNSFW(boolean nsfw)`: Sets whether the channel is NSFW.

#### Inherited from ISlowmodeChannelManager
- `setSlowmode(int slowmode)`: Sets the slowmode delay for the channel in seconds.

#### Inherited from Manager
- `setCheck(Consumer<? super RestAction<?>> check)`: Sets a check to be performed before executing the action.
- `timeout(long timeout, TimeUnit unit)`: Sets a timeout for the action.

#### Inherited from AuditableRestAction
- `reason(String reason)`: Sets the audit log reason for this action.
```

--------------------------------

### getMessageCount

Source: https://docs.jda.wiki/net/dv8tion/jda/api/entities/channel/concrete/ThreadChannel.html

Gets the current number of messages present in this thread. Threads started from seed messages in the parent channel will not count that seed message. This will be capped at 50 for threads created before July 1, 2022.

```APIDOC
## getMessageCount
int getMessageCount()
Gets the current number of messages present in this thread.   
Threads started from seed messages in the `parent channel` will not count that seed message.   
This will be capped at 50 for threads created before **July 1, 2022**. 

Returns:
    The number of messages sent in this thread
```

--------------------------------

### Counting Members Mentioned in a Message

Source: https://docs.jda.wiki/net/dv8tion/jda/api/entities/Mentions.html

This example shows how to get a list of unique members mentioned in a message and use a Bag to count how many times each member was mentioned. The code iterates through the mentioned members, appending their user tag and mention count to a StringBuilder.

```java
void sendCount(Message msg)
{
    List<Member> mentions = msg.getMentions().getMembers(); // distinct list, in order of appearance
    Bag<Member> count = msg.getMentions().getMembersBag();
    StringBuilder content = new StringBuilder();
    for (Member user : mentions)
    {
        content.append(member.getUser().getAsTag())
               .append(": ")
               .append(count.getCount(member))
               .append("\n");
    }
    msg.getChannel().sendMessage(content.toString()).queue();
}
```

--------------------------------

### ApplicationInfo.InstallParameters

Source: https://docs.jda.wiki/net/dv8tion/jda/api/entities/ApplicationInfo.InstallParameters.html

Provides methods to retrieve the permissions and scopes that a bot requests during the invitation process.

```APIDOC
## Interface: ApplicationInfo.InstallParameters

OAuth2 install parameter for the default in-app authorization link.

### Methods

#### getPermissions

@Nonnull Set<Permission> getPermissions()

Gets the permissions your bot asks for when invited. Note: Users can choose to disable permissions before and after inviting your bot.

* **Returns**: The permissions your bot asks for when invited.

#### getScopes

@Nonnull List<String> getScopes()

Gets the required scopes granted to the bot when invited.

* **Returns**: The required scopes granted to the bot when invited.
```

--------------------------------

### getInstallParameters()

Source: https://docs.jda.wiki/index-all.html

Retrieves the OAuth2 install parameters for the default in-app authorization link.

```APIDOC
## getInstallParameters()

### Description
The OAuth2 install parameters for the default in-app authorization link.

### Method
Method

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **installParameters** (OAuth2InstallParameters) - The OAuth2 install parameters.
```

--------------------------------

### Setting Scheduled Event Start Time

Source: https://docs.jda.wiki/net/dv8tion/jda/api/managers/ScheduledEventManager.html

Sets the start time for the scheduled event. Events of Type.EXTERNAL start automatically. Events of Type.STAGE_INSTANCE and Type.VOICE need manual starting. Events not started after their scheduled time may be automatically cancelled.

```java
@Nonnull @CheckReturnValue ScheduledEventManager setStartTime(@Nonnull TemporalAccessor startTime)
```

--------------------------------

### setStartTime

Source: https://docs.jda.wiki/net/dv8tion/jda/api/managers/ScheduledEventManager.html

Sets the start time for the ScheduledEvent. Events of Type.EXTERNAL start automatically. Events of Type.STAGE_INSTANCE and Type.VOICE need manual starting. Events that do not begin after their scheduled start time will be automatically cancelled.

```APIDOC
## setStartTime

### Description
Sets the time that the selected `ScheduledEvent` should start at. Events of `Type.EXTERNAL` will automatically start at this time. Events of `Type.STAGE_INSTANCE` and `Type.VOICE` need to be manually started. If the `ScheduledEvent` has not begun after its scheduled start time, it will be automatically cancelled after a few hours.

### Method
`setStartTime`

### Parameters
#### Path Parameters
- **startTime** (TemporalAccessor) - Required - The time that the selected `ScheduledEvent` is set to start at.
```

--------------------------------

### Creating and Responding to Buttons

Source: https://docs.jda.wiki/net/dv8tion/jda/api/components/buttons/Button.html

Demonstrates how to create primary and success buttons with labels and emojis, and how to respond to button clicks. Includes handling slash commands to send messages with buttons and processing button interactions.

```java
public class HelloBot extends ListenerAdapter {
  public void onSlashCommandInteraction(SlashCommandInteractionEvent event) {
      if (event.getName().equals("hello")) {
          event.reply("Click the button to say hello")
              .addComponents(
                ActionRow.of(
                  Button.primary("hello", "Click Me"), // Button with only a label
                  Button.success("emoji", Emoji.fromMarkdown("<:minn:245267426227388416>")))) // Button with only an emoji
              .queue();
      } else if (event.getName().equals("info")) {
          event.reply("Click the buttons for more info")
              .addComponents(
                  ActionRow.of(
                    // link buttons don't send events, they just open a link in the browser when clicked
                    Button.link("https://github.com/discord-jda/JDA", "GitHub")
                      .withEmoji(Emoji.fromMarkdown("<:github:849286315580719104>")), // Link Button with label and emoji
                    Button.link("https://docs.jda.wiki/", "Javadocs"))) // Link Button with only a label
              .queue();
      }
  }

  public void onButtonInteraction(ButtonInteractionEvent event) {
      if (event.getComponentId().equals("hello")) {
          event.reply("Hello :)").queue();
      }
  }
}
```

--------------------------------

### Started Thread

Source: https://docs.jda.wiki/net/dv8tion/jda/api/entities/Message.html

Returns the ThreadChannel that was started from this message, if any.

```APIDOC
## getStartedThread()

### Description
Returns a possibly `null` `ThreadChannel` that was started from this message.

### Method
GET

### Endpoint
`/channels/{channelId}/threads/messages/{messageId}` (Conceptual)

### Returns
`ThreadChannel`
```

--------------------------------

### Get Template Name

Source: https://docs.jda.wiki/net/dv8tion/jda/api/entities/templates/Template.html

Gets the template name.

```APIDOC
## GET /template/name

### Description
Gets the template name.

### Method
GET

### Endpoint
This operation is performed on a specific template instance.

### Parameters
None

### Response
#### Success Response (200)
- **name** (String) - The template name.
```

--------------------------------

### Get Template Description

Source: https://docs.jda.wiki/net/dv8tion/jda/api/entities/templates/Template.html

Gets the template description.

```APIDOC
## GET /template/description

### Description
Gets the template description.

### Method
GET

### Endpoint
This operation is performed on a specific template instance.

### Parameters
None

### Response
#### Success Response (200)
- **description** (String) - The template description.
```

--------------------------------

### getInstallParameters

Source: https://docs.jda.wiki/net/dv8tion/jda/api/entities/ApplicationInfo.IntegrationTypeConfiguration.html

Retrieves the OAuth2 install parameters for the default in-app authorization link. These parameters are used when a user invites your application through the Discord app.

```APIDOC
## getInstallParameters

### Description
The OAuth2 install parameters for the default in-app authorization link. When a user invites your application in the Discord app, these will be the parameters of the invite url.

### Method
`getInstallParameters()`

### Returns
`ApplicationInfo.InstallParameters` - The OAuth2 install parameters for the default in-app authorization link.
```

--------------------------------

### Get Template Code

Source: https://docs.jda.wiki/net/dv8tion/jda/api/entities/templates/Template.html

Gets the template code.

```APIDOC
## GET /template/code

### Description
Gets the template code.

### Method
GET

### Endpoint
This operation is performed on a specific template instance.

### Parameters
None

### Response
#### Success Response (200)
- **code** (String) - The template code.
```

--------------------------------

### Example: Set Action Rows for Message Components

Source: https://docs.jda.wiki/net/dv8tion/jda/api/utils/messages/AbstractMessageBuilder.html

Demonstrates how to set multiple action rows with different components, such as select menus and buttons, for a message.

```java
final List<MessageTopLevelComponent> list = new ArrayList<>();
list.add(ActionRow.of(selectMenu); // first row
list.add(ActionRow.of(button1, button2)); // second row (shows below the first)

channel.sendMessage("Content here")
  .setComponents(list)
  .queue();
```

--------------------------------

### Get Emojis Route

Source: https://docs.jda.wiki/net/dv8tion/jda/api/requests/Route.Emojis.html

Represents the route for getting all emojis.

```APIDOC
## GET_EMOJIS

### Description
Represents the route for getting all emojis.

### Method
GET

### Endpoint
/emojis

### Response
#### Success Response (200)
- **emojis** (array) - An array of emoji objects.
```

--------------------------------

### AudioModuleConfig Configuration

Source: https://docs.jda.wiki/net/dv8tion/jda/api/audio/AudioModuleConfig.html

Demonstrates how to create and configure an AudioModuleConfig instance using builder-style methods.

```APIDOC
## AudioModuleConfig Configuration Example

This example shows how to set a custom audio send factory and a DAVE session factory for JDA's audio module.

### Usage

```java
jdaBuilder.setAudioModuleConfig(
  new AudioModuleConfig()
    .withAudioSendFactory(new NativeAudioSendFactory())
    .withDaveSessionFactory(new JDaveSessionFactory())
)
```
```

--------------------------------

### Get Template Uses

Source: https://docs.jda.wiki/net/dv8tion/jda/api/entities/templates/Template.html

Gets how often this template has been used.

```APIDOC
## GET /template/uses

### Description
Gets how often this template has been used.

### Method
GET

### Endpoint
This operation is performed on a specific template instance.

### Parameters
None

### Response
#### Success Response (200)
- **uses** (int) - The number of times this template has been used.
```

--------------------------------

### setDescription

Source: https://docs.jda.wiki/net/dv8tion/jda/api/managers/GuildWelcomeScreenManager.html

Sets the description of the welcome screen. The description must not be longer than 140 characters.

```APIDOC
## setDescription

### Description
Sets the description of the welcome screen. The description must not be longer than 140 characters.

### Method
`setDescription`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **description** (String) - The new description of the welcome screen, or `null` to remove the description.

### Response
#### Success Response
Returns `GuildWelcomeScreenManager` for chaining convenience.

### Throws
* `IllegalArgumentException` - If the description is longer than 140 characters.
```

--------------------------------

### Get Template Creator

Source: https://docs.jda.wiki/net/dv8tion/jda/api/entities/templates/Template.html

Gets the user who created this template.

```APIDOC
## GET /template/creator

### Description
Gets the user who created this template.

### Method
GET

### Endpoint
This operation is performed on a specific template instance.

### Parameters
None

### Response
#### Success Response (200)
- **creator** (User) - The user who created this template.
```

--------------------------------

### GuildWelcomeScreen.Channel.of(StandardGuildChannel, String, Emoji)

Source: https://docs.jda.wiki/index-all.html

Constructs a new welcome channel.

```APIDOC
## GuildWelcomeScreen.Channel.of(StandardGuildChannel, String, Emoji)

### Description
Constructs a new welcome channel.

### Method
Static

### Parameters
* **StandardGuildChannel** - The guild channel.
* **String** - The welcome message.
* **Emoji** - The emoji for the welcome channel.
```

--------------------------------

### Basic String Splitting with Strategy

Source: https://docs.jda.wiki/net/dv8tion/jda/api/utils/SplitUtil.html

Demonstrates splitting a string by spaces, respecting a character limit. If the string fits within the limit, no splitting occurs.

```java
String input = "Hello World";

SplitUtil.split(input, 8, true, Strategy.SPACE);

SplitUtil.split(input, 50, true, Strategy.SPACE);
```

--------------------------------

### Get Emoji Route

Source: https://docs.jda.wiki/net/dv8tion/jda/api/requests/Route.Emojis.html

Represents the route for getting a specific emoji.

```APIDOC
## GET_EMOJI

### Description
Represents the route for getting a specific emoji.

### Method
GET

### Endpoint
/emojis/{emojiId}

### Parameters
#### Path Parameters
- **emojiId** (string) - Required - The ID of the emoji to retrieve.
```

--------------------------------

### GET_WELCOME_SCREEN

Source: https://docs.jda.wiki/net/dv8tion/jda/api/requests/Route.Guilds.html

Retrieves the welcome screen configuration for a guild.

```APIDOC
## GET /guilds/{guild.id}/welcome-screen

### Description
Retrieves the welcome screen configuration for a guild.

### Method
GET

### Endpoint
/guilds/{guild.id}/welcome-screen
```

--------------------------------

### Get Options by Type

Source: https://docs.jda.wiki/net/dv8tion/jda/api/interactions/commands/CommandInteractionPayload.html

Gets all options that match the specified type.

```APIDOC
## getOptionsByType(OptionType type)

### Description
Gets all options for the specified type.

### Method
`getOptionsByType(OptionType type)`

### Parameters
#### Path Parameters
- **type** (OptionType) - The type of the options to retrieve.

### Returns
- `List<OptionMapping>` - A list of options with the specified type.
```

--------------------------------

### Get Options by Name

Source: https://docs.jda.wiki/net/dv8tion/jda/api/interactions/commands/CommandInteractionPayload.html

Gets all options that match the specified name.

```APIDOC
## getOptionsByName(String name)

### Description
Gets all options for the specified name.

### Method
`getOptionsByName(String name)`

### Parameters
#### Path Parameters
- **name** (String) - The name of the options to retrieve.

### Returns
- `List<OptionMapping>` - A list of options with the specified name.
```

--------------------------------

### StringSelectMenu Creation Example

Source: https://docs.jda.wiki/net/dv8tion/jda/api/components/selections/StringSelectMenu.html

Demonstrates how to create a StringSelectMenu with options, a placeholder, and default selections, then attach it to an ActionRow for a SlashCommandInteractionEvent.

```APIDOC
## StringSelectMenu Creation Example

### Description
This example shows how to build a `StringSelectMenu` for a slash command interaction. It includes setting a custom ID, placeholder text, defining the range of selectable options, adding individual options with labels and values, and setting a default selection. The created menu is then embedded within an `ActionRow` and sent as part of a reply to the user, with the message being ephemeral.

### Method
`SlashCommandInteractionEvent.reply().addComponents(ActionRow.of(StringSelectMenu.create(...).build())).queue()`

### Parameters
- `event`: The `SlashCommandInteractionEvent` that triggered the command.
- `StringSelectMenu.create("menu:class")`: Initializes the builder with a unique custom ID for the menu.
- `.setPlaceholder("Choose your class")`: Sets the text displayed when no option is selected.
- `.setRequiredRange(1, 1)`: Specifies that exactly one option must be selected.
- `.addOption("Arcane Mage", "mage-arcane")`: Adds an option with a visible label and an internal value.
- `.setDefaultValues("mage-fire")`: Sets a pre-selected option when the menu first appears.
- `ActionRow.of(menu)`: Wraps the `StringSelectMenu` in an `ActionRow`, which is required for message components.
- `.setEphemeral(true)`: Makes the reply visible only to the user who invoked the command.
- `.queue()`: Sends the reply with the attached components.

### Response
- A reply message containing the interactive StringSelectMenu.

### Example
```java
public void onSlashCommandInteraction(SlashCommandInteractionEvent event) {
  if (!event.getName().equals("class")) return;

  StringSelectMenu menu = StringSelectMenu.create("menu:class")
    .setPlaceholder("Choose your class") // shows the placeholder indicating what this menu is for
    .setRequiredRange(1, 1) // exactly one must be selected
    .addOption("Arcane Mage", "mage-arcane")
    .addOption("Fire Mage", "mage-fire")
    .addOption("Frost Mage", "mage-frost")
    .setDefaultValues("mage-fire") // default to fire mage
    .build();

  event.reply("Please pick your class below")
    .setEphemeral(true)
    .addComponents(ActionRow.of(menu))
    .queue();
}
```
```

--------------------------------

### Example Usage

Source: https://docs.jda.wiki/net/dv8tion/jda/api/utils/TimeFormat.html

Example demonstrating how to use TimeFormat to format timestamps in messages.

```APIDOC
```java
channel.sendMessage("Current Time: " + TimeFormat.RELATIVE.now()).queue();
channel.sendMessage("Uptime: " + TimeFormat.RELATIVE.format(getStartTime())).queue();
```
```

--------------------------------

### Create ImageFormat with Extension and Query Parameters

Source: https://docs.jda.wiki/net/dv8tion/jda/api/utils/ImageFormat.html

Creates an ImageFormat instance with a specified extension and a list of query parameters. It requires the extension and query parameters to be non-null, the extension to be non-blank, and the query parameter list length to be a multiple of 2.

```java
@Nonnull public static ImageFormat of(@Nonnull String extension, @Nonnull List<String> queryParameters)
Creates an `ImageFormat` using the provided extension.
```

--------------------------------

### createLight(String, GatewayIntent, GatewayIntent...)

Source: https://docs.jda.wiki/index-all.html

Creates a JDABuilder or DefaultShardManagerBuilder with low memory profile settings.

```APIDOC
## createLight(String, GatewayIntent, GatewayIntent...)

### Description
Creates a JDABuilder or DefaultShardManagerBuilder with low memory profile settings.

### Method
Static method

### Endpoint
Not applicable (SDK method)

### Parameters
* **String** (String) - Description not specified
* **GatewayIntent** (GatewayIntent) - Description not specified
* **GatewayIntent...** (GatewayIntent...) - Description not specified
```

--------------------------------

### start

Source: https://docs.jda.wiki/net/dv8tion/jda/api/audio/factory/DefaultSendSystem.html

Represents the start of the loop, similar to Thread.start(). After a call to this method, JDA assumes that the instance will be sending UDP audio packets in a loop. The packet sending loop should NOT be started on the current thread.

```APIDOC
## start()

### Description
Represents the start of the loop, similar to Thread.start(), and after a call to this method JDA assumes that the instance will be sending UDP audio packets in a loop. The packet sending loop should NOT be started on the current thread.

### Note
This method should not block forever, in the same way that Thread.start() does not. Just like in Thread, the running action of this system should be implemented asynchronously.
```

--------------------------------

### Get JDA Instance

Source: https://docs.jda.wiki/net/dv8tion/jda/api/entities/templates/Template.html

Gets the JDA instance used to create this Template instance.

```APIDOC
## GET /template/jda

### Description
Gets the `JDA` instance used to create this Template instance.

### Method
GET

### Endpoint
This operation is performed on a specific template instance.

### Parameters
None

### Response
#### Success Response (200)
- **jda** (JDA) - The `JDA` instance used to create this Template instance.
```

--------------------------------

### Request to Speak in a Stage Channel

Source: https://docs.jda.wiki/net/dv8tion/jda/api/entities/Guild.html

This example shows how to initiate a request to speak in a Stage Channel. It first creates a Stage Instance and then uses `guild.requestToSpeak()` to set the flag. Finally, it opens an audio connection to the Stage Channel. Ensure the bot is connected to a voice channel and has the necessary permissions.

```java
stageChannel.createStageInstance("Talent Show").queue()
guild.requestToSpeak(); // Set request to speak flag
guild.getAudioManager().openAudioConnection(stageChannel); // join the channel
```

--------------------------------

### getStartedThread

Source: https://docs.jda.wiki/net/dv8tion/jda/api/entities/Message.html

Retrieves the `ThreadChannel` that was started from this message, if any. Returns null if no thread was started or if the thread has been deleted.

```APIDOC
## getStartedThread

### Description
Returns a possibly `null` `ThreadChannel` that was started from this message. This can be `null` due to no ThreadChannel being started from it or the ThreadChannel later being deleted.

### Method
`getStartedThread()`

### Returns
* `@Nullable ThreadChannel` - The `ThreadChannel` started from this message, or null if none exists or it was deleted.
```

--------------------------------

### Command Creation and Configuration

Source: https://docs.jda.wiki/net/dv8tion/jda/api/requests/restaction/CommandCreateAction.html

This section details the methods available on CommandCreateAction for configuring and creating commands. It covers setting names, descriptions, options, permissions, and other properties.

```APIDOC
## CommandCreateAction Methods

### Description
Provides methods to create and update commands. If a command with the same name exists, it will be replaced. This operation is not idempotent.

### Methods

- **addCheck(BooleanSupplier checks)**: Shortcut for `setCheck(() -> getCheck().getAsBoolean() && checks.getAsBoolean())`.
- **addOption(OptionType type, String name, String description)**: Adds an option to this command.
- **addOption(OptionType type, String name, String description, boolean required)**: Adds an option to this command with a required flag.
- **addOption(OptionType type, String name, String description, boolean required, boolean autoComplete)**: Adds an option to this command with required and autoComplete flags.
- **addOptions(Collection<? extends OptionData> options)**: Adds up to 25 options to this command.
- **addOptions(OptionData... options)**: Adds up to 25 options to this command.
- **addSubcommandGroups(Collection<? extends SubcommandGroupData> groups)**: Adds up to 25 subcommand groups to this command.
- **addSubcommandGroups(SubcommandGroupData... groups)**: Adds up to 25 subcommand groups to this command.
- **addSubcommands(Collection<? extends SubcommandData> subcommands)**: Adds up to 25 subcommands to this command.
- **addSubcommands(SubcommandData... subcommands)**: Adds up to 25 subcommands to this command.
- **deadline(long timestamp)**: Schedules a deadline for the request completion.
- **setCheck(BooleanSupplier checks)**: Sets the last-second checks before executing the HTTP request.
- **setContexts(Collection<InteractionContextType> contexts)**: Sets the contexts in which this command can be used.
- **setContexts(InteractionContextType... contexts)**: Sets the contexts in which this command can be used.
- **setDefaultPermissions(DefaultMemberPermissions permission)**: Sets the default permissions required to use this command.
- **setDescription(String description)**: Configures the description of the command.
- **setDescriptionLocalization(DiscordLocale locale, String description)**: Sets a language-specific localization for the command's description.
- **setDescriptionLocalizations(Map<DiscordLocale, String> map)**: Sets multiple language-specific localizations for the command's description.
- **setIntegrationTypes(Collection<IntegrationType> integrationTypes)**: Sets the integration types on which this command can be installed.
- **setIntegrationTypes(IntegrationType... integrationTypes)**: Sets the integration types on which this command can be installed.
- **setLocalizationFunction(LocalizationFunction localizationFunction)**: Sets the LocalizationFunction for this command.
- **setName(String name)**: Configures the name of the command.
- **setNameLocalization(DiscordLocale locale, String name)**: Sets a language-specific localization for the command's name.
- **setNameLocalizations(Map<DiscordLocale, String> map)**: Sets multiple language-specific localizations for the command's name.
- **setNSFW(boolean nsfw)**: Sets whether the command should only be usable in NSFW channels.
- **timeout(long timeout, TimeUnit unit)**: Sets a timeout for this RestAction instance.
```

--------------------------------

### ForumPost Constructor

Source: https://docs.jda.wiki/net/dv8tion/jda/api/entities/channel/forums/ForumPost.html

Constructs a new ForumPost instance with the specified starter message and thread channel.

```APIDOC
## ForumPost Constructor

### Description
Constructs a new ForumPost instance.

### Parameters
* **message** (Message) - Required - The starter message of the post.
* **thread** (ThreadChannel) - Required - The ThreadChannel representing the post.
```

--------------------------------

### onUserActivityStart

Source: https://docs.jda.wiki/net/dv8tion/jda/api/hooks/ListenerAdapter.html

Called when a user starts an activity. This method can be overridden to handle user activity start events.

```APIDOC
## onUserActivityStart

### Description
Callback for when a user starts an activity.

### Method
`public void onUserActivityStart(@Nonnull UserActivityStartEvent event)`

### Parameters
* **event** (`UserActivityStartEvent`) - Required - The event object containing details about the user's activity start.
```

--------------------------------

### CompareTo

Source: https://docs.jda.wiki/net/dv8tion/jda/api/entities/ScheduledEvent.html

Compares this ScheduledEvent with another based on their scheduled start times, and then by snowflake ID if start times are equal.

```APIDOC
## compareTo
int compareTo(@Nonnull ScheduledEvent scheduledEvent)

### Description
Compares two `ScheduledEvent` objects based on their scheduled start times. If two events are set to start at the same time, the comparison will be made based on their snowflake ID.

### Parameters
* `scheduledEvent` (ScheduledEvent) - The provided scheduled event.

### Returns
A negative number if the original event starts sooner than the provided event, or positive if it will start later. If start times are the same, the result is based on snowflake ID comparison.

### Throws
* `IllegalArgumentException` - If the provided scheduled event is `null`, from a different `Guild`, or is not a valid scheduled event provided by JDA.
```

--------------------------------

### Example: Count Users with Short Names using applyStream

Source: https://docs.jda.wiki/net/dv8tion/jda/api/utils/cache/CacheView.html

Demonstrates using applyStream to filter users by name length and count them. This approach avoids copying the entire cache for the operation.

```java
CacheView<User> view = jda.getUserCache();
long shortNames = view.applyStream(stream ->
    stream
        .filter(it -> it.getName().length() < 4)
        .count()
);

System.out.println(shortNames + " users with less than 4 characters in their name");
```

--------------------------------

### Get Template Guild Information

Source: https://docs.jda.wiki/net/dv8tion/jda/api/entities/templates/Template.html

Gets a Template.Guild object containing information about this template's origin guild.

```APIDOC
## GET /template/guild

### Description
Gets a `Template.Guild` object containing information about this template's origin guild.

### Method
GET

### Endpoint
This operation is performed on a specific template instance.

### Parameters
None

### Response
#### Success Response (200)
- **guild** (TemplateGuild) - A `Template.Guild` object containing information about this template's origin guild.
```

--------------------------------

### MediaGallery withItems (varargs)

Source: https://docs.jda.wiki/net/dv8tion/jda/api/components/mediagallery/MediaGallery.html

Creates a new MediaGallery instance with a specified item and an array of additional items. This is a default method that returns a new instance and does not modify the original gallery. It throws an IllegalArgumentException if the provided items are null or contain null.

```APIDOC
## MediaGallery withItems (default)

### Description
Creates a new `MediaGallery` with the specified items. This is a default method that returns a new instance and does not modify the original gallery.

### Method
`default MediaGallery withItems(MediaGalleryItem item, MediaGalleryItem... items)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
* `item` (MediaGalleryItem) - Required - The first new item.
* `items` (MediaGalleryItem...) - Required - Additional new items.

### Response
#### Success Response (200)
* `MediaGallery` - The new `MediaGallery` instance.

### Throws
* `IllegalArgumentException` - If the provided items are `null` or contains `null`.
```

--------------------------------

### Retrieve Interested Members Example

Source: https://docs.jda.wiki/net/dv8tion/jda/api/requests/restaction/pagination/ScheduledEventMembersPaginationAction.html

This example demonstrates how to retrieve all members interested in a scheduled event and collect their names.

```APIDOC
## retrieveInterestedMembers()

### Description
Retrieves an action to paginate through all members interested in this scheduled event.

### Method
This is a conceptual method call, not a direct HTTP request.

### Endpoint
N/A (SDK method)

### Parameters
None

### Request Example
```java
// Get every member interested in this event and add the members names to a list
public static void getInterestedMembers(ScheduledEvent event) {
     // get paginator
     ScheduledEventMembersPaginationAction members = event.retrieveInterestedMembers();
     // add the name of every interested member to a list
     ArrayList<String> memberNames = new ArrayList();
     members.forEachAsync(member -> memberNames.add(member.getEffectiveName()));
}
```

### Response
#### Success Response
Returns a `ScheduledEventMembersPaginationAction` object that can be used to iterate over `Member` objects.

#### Response Example
```java
ScheduledEventMembersPaginationAction members = event.retrieveInterestedMembers();
```
```

--------------------------------

### ForumChannelManager Example

Source: https://docs.jda.wiki/net/dv8tion/jda/api/managers/channel/concrete/ForumChannelManager.html

Demonstrates how to use ForumChannelManager to set channel properties like name, slowmode, and topic, and how to reset specific properties.

```APIDOC
## ForumChannelManager Usage Examples

This section provides examples of how to use the `ForumChannelManager` to modify forum channel properties.

### Example 1: Setting basic channel properties
```java
manager.setName("gamer-forum")
 .setSlowmode(10)
 .setTopic("Welcome to the gamer forum!")
 .queue();
```

### Example 2: Resetting and modifying properties
```java
manager.reset(ChannelManager.NSFW | ChannelManager.NAME)
 .setName("gamer-forum-nsfw")
 .setNSFW(true)
 .queue();
```
```
Tokens:
Raw