Discord.Net.Labs.WebSocket 2.4.9

Suggested Alternatives

Discord.Net.WebSocket

There is a newer version of this package available.
See the version list below for details.
dotnet add package Discord.Net.Labs.WebSocket --version 2.4.9                
NuGet\Install-Package Discord.Net.Labs.WebSocket -Version 2.4.9                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Discord.Net.Labs.WebSocket" Version="2.4.9" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Discord.Net.Labs.WebSocket --version 2.4.9                
#r "nuget: Discord.Net.Labs.WebSocket, 2.4.9"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Discord.Net.Labs.WebSocket as a Cake Addin
#addin nuget:?package=Discord.Net.Labs.WebSocket&version=2.4.9

// Install Discord.Net.Labs.WebSocket as a Cake Tool
#tool nuget:?package=Discord.Net.Labs.WebSocket&version=2.4.9                

Discord.Net Labs

NuGet

Join our Discord server for support using labs

This repo is a custom fork of Discord.Net that introduces the newest features of discord for testing and experimenting. Nothing here is guaranteed to work but you are more than welcome to submit bugs in the issues tabs

Known issues

Labs will not work with normal package of Playwo's InteractivityAddon. The reason is that his package depends on the base discord.net lib. You can instead use the InteractivityAddon.Labs package which implements some of the features added in Discord.Net-Labs.

How to use

Setting up labs in your project is really simple, here's how to do it:

  1. Remove Discord.Net from your project
  2. Add Discord.Net Labs nuget to your project
  3. Enjoy!

Listening for interactions

// Subscribe to the InteractionCreated event
client.InteractionCreated += Client_InteractionCreated;

...
private async Task Client_InteractionCreated(SocketInteraction arg)
{
  switch (arg.Type) // We want to check the type of this interaction
  {
    //Slash commands
    case InteractionType.ApplicationCommand:
      await MySlashCommandHandler(arg);
      break;
    //Button clicks/selection dropdowns
    case InteractionType.MessageComponent:
      await MyMessageComponentHandler(arg);
      break;
    //Unused
    case InteractionType.Ping:
      break;
    //Unknown/Unsupported
    default:
      Console.WriteLine("Unsupported interaction type: " + arg.Type);
      break;
  }
}

Handling button clicks and selection dropdowns

private async Task MyMessageComponentHandler(SocketInteraction arg)
{
    // Parse the arg
    var parsedArg = (SocketMessageComponent) arg;
    // Get the custom ID 
    var customId = parsedArg.Data.CustomId;
    // Get the user
    var user = (SocketGuildUser) arg.User;
    // Get the guild
    var guild = user.Guild;
    
    // Respond with the update message response type. This edits the original message if you have set AlwaysAcknowledgeInteractions to false.
    // You can also use "ephemeral" so that only the original user of the interaction sees the message
    await parsedArg.RespondAsync($"Clicked {parsedArg.Data.CustomId}!", type: InteractionResponseType.UpdateMessage, ephemeral: true);
    
    // You can also followup with a second message
    await parsedArg.FollowupAsync($"Clicked {parsedArg.Data.CustomId}!", type: InteractionResponseType.ChannelMessageWithSource, ephemeral: true);
    
    //If you are using selection dropdowns, you can get the selected label and values using these:
    var selectedLabel = ((SelectMenu) parsedArg.Message.Components.First().Components.First()).Options.FirstOrDefault(x => x.Value == parsedArg.Data.Values.FirstOrDefault())?.Label;
    var selectedValue = parsedArg.Data.Values.First();
}

Note: The example above assumes that the selection dropdown is expecting only 1 returned value, if you configured your dropdown for multiple values, you'll need to modify the code slightly.

Sending messages with buttons

Theres a new field in all SendMessageAsync functions that takes in a MessageComponent, you can use it like so:

var builder = new ComponentBuilder().WithButton("Hello!", customId: "id_1", ButtonStyle.Primary, row: 0);
await Context.Channel.SendMessageAsync("Test buttons!", component: builder.Build());

Sending messages with selection dropdowns

Theres a new field in all SendMessageAsync functions that takes in a MessageComponent, you can use it like so:

var builder = new ComponentBuilder()
  .WithSelectMenu(new SelectMenuBuilder()
  .WithCustomId("id_2")
  .WithLabel("Select menu!")
  .WithPlaceholder("This is a placeholder")
  .WithOptions(new List<SelectMenuOptionBuilder>()
  {
    new SelectMenuOptionBuilder()
      .WithLabel("Option A")
      .WithEmote(Emote.Parse("<:evanpog:810017136814194698>"))
      .WithDescription("Evan pog champ")
      .WithValue("value1"),
    new SelectMenuOptionBuilder()
      .WithLabel("Option B")
      .WithDescription("Option B is poggers")
      .WithValue("value2")
  }));
await Context.Channel.SendMessageAsync("Test selection!", component: builder.Build());

Note: You can only have 5 buttons per row and 5 rows per message. If a row contains a selection dropdown it cannot contain any buttons.

Slash commands

Slash command example how to's can be found here. If you want to read some code using slash commands, you can do that here

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 is compatible.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (4)

Showing the top 4 NuGet packages that depend on Discord.Net.Labs.WebSocket:

Package Downloads
Discord.Net.Labs

An experimental fork of Discord.NET that adds all the new discord features to play around with! This metapackage includes all of the optional Discord.Net Labs components.

Discord.Net.Labs.Interactions

A Discord.Net Labs extension adding support for Application Commands.

Fergun.Interactive.Labs

An addon that adds interactive functionality to commands. This is a fork of Discord.InteractivityAddon that adds several features like more customization and support for interactions.

Discord.InteractivityAddon.Labs

This package is an Addon for Discord.Net. It provides basic and advanced interactivity features for your Discord Bot. Moreover it includes support for any command framework.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.6.1 25,545 12/24/2021 3.6.1 is deprecated because it is no longer maintained.
3.6.0 1,164 12/24/2021 3.6.0 is deprecated because it is no longer maintained.
3.5.0 2,799 12/15/2021 3.5.0 is deprecated because it is no longer maintained.
3.4.9 5,750 12/6/2021 3.4.9 is deprecated because it is no longer maintained.
3.4.8 5,832 12/4/2021 3.4.8 is deprecated because it is no longer maintained.
3.4.7 3,738 11/28/2021 3.4.7 is deprecated because it is no longer maintained.
3.4.6 1,042 11/27/2021 3.4.6 is deprecated because it is no longer maintained.
3.4.5 886 11/27/2021 3.4.5 is deprecated because it is no longer maintained.
3.4.4 1,009 11/27/2021 3.4.4 is deprecated because it is no longer maintained.
3.4.3 1,027 11/27/2021 3.4.3 is deprecated because it is no longer maintained.
3.4.2 3,238 11/26/2021 3.4.2 is deprecated because it is no longer maintained.
3.4.1 2,497 11/26/2021 3.4.1 is deprecated because it is no longer maintained.
3.4.0 2,554 11/26/2021 3.4.0 is deprecated because it is no longer maintained.
3.3.3 1,482 11/23/2021 3.3.3 is deprecated because it is no longer maintained.
3.3.2 1,358 11/21/2021 3.3.2 is deprecated because it is no longer maintained.
3.3.1 1,533 11/21/2021 3.3.1 is deprecated because it is no longer maintained.
3.3.0 1,778 11/19/2021 3.3.0 is deprecated because it is no longer maintained.
3.2.0 2,661 11/9/2021 3.2.0 is deprecated because it is no longer maintained.
3.1.7 3,823 10/20/2021 3.1.7 is deprecated because it is no longer maintained.
3.1.6 1,704 10/15/2021 3.1.6 is deprecated because it is no longer maintained.
3.1.5 1,009 10/15/2021 3.1.5 is deprecated because it is no longer maintained.
3.1.4 2,643 10/13/2021 3.1.4 is deprecated because it is no longer maintained.
3.1.2 1,729 10/12/2021 3.1.2 is deprecated because it is no longer maintained.
3.1.1 3,631 9/23/2021 3.1.1 is deprecated because it is no longer maintained.
3.1.0 2,281 9/21/2021 3.1.0 is deprecated because it is no longer maintained.
3.0.4 1,508 9/15/2021 3.0.4 is deprecated because it is no longer maintained.
3.0.3 3,649 9/13/2021 3.0.3 is deprecated because it is no longer maintained.
3.0.2 4,095 8/25/2021 3.0.2 is deprecated because it is no longer maintained.
3.0.1 913 8/25/2021 3.0.1 is deprecated because it is no longer maintained.
3.0.1-pre 1,799 8/8/2021 3.0.1-pre is deprecated because it is no longer maintained.
3.0.0 2,157 8/24/2021 3.0.0 is deprecated because it is no longer maintained.
3.0.0-pre 499 8/5/2021 3.0.0-pre is deprecated because it is no longer maintained.
2.4.9 2,161 7/18/2021 2.4.9 is deprecated because it is no longer maintained.
2.4.8 1,918 7/17/2021 2.4.8 is deprecated because it is no longer maintained.
2.4.7 1,051 7/15/2021 2.4.7 is deprecated because it is no longer maintained.
2.4.6 1,530 7/11/2021 2.4.6 is deprecated because it is no longer maintained.
2.4.5 2,605 7/7/2021 2.4.5 is deprecated because it is no longer maintained.
2.4.4 999 7/6/2021 2.4.4 is deprecated because it is no longer maintained.
2.4.3 1,003 7/5/2021 2.4.3 is deprecated because it is no longer maintained.
2.4.2 1,023 7/4/2021 2.4.2 is deprecated because it is no longer maintained.
2.4.1 1,060 7/3/2021 2.4.1 is deprecated because it is no longer maintained.
2.4.0 1,030 7/3/2021 2.4.0 is deprecated because it is no longer maintained.
2.3.9-pre 450 6/1/2021 2.3.9-pre is deprecated because it is no longer maintained.
2.3.9-dev 436 7/2/2021 2.3.9-dev is deprecated because it is no longer maintained.
2.3.8 1,519 5/30/2021 2.3.8 is deprecated because it is no longer maintained.
2.3.7 1,067 5/30/2021 2.3.7 is deprecated because it is no longer maintained.
2.3.6 1,060 5/30/2021 2.3.6 is deprecated because it is no longer maintained.
2.3.5 1,022 5/29/2021 2.3.5 is deprecated because it is no longer maintained.
2.3.5-dev 425 5/29/2021 2.3.5-dev is deprecated because it is no longer maintained.
2.3.4 981 5/28/2021 2.3.4 is deprecated because it is no longer maintained.
2.3.3 905 5/28/2021 2.3.3 is deprecated because it is no longer maintained.
2.3.1 969 5/27/2021 2.3.1 is deprecated because it is no longer maintained.