Upgrade from 10.3.0 to 10.4.0

Note

DisCatSharp is now compiled with .NET 7.0.

Important

The namespaces were adjusted to fit the actual location.

What Is New In DisCatSharp?

🆕 Added DisCatSharp Analyzer to help you write better code

🆕 Support for the new Username System

🆕 Support for Linked Roles

🆕 Support for Application Subscriptions aka Premium Apps

🆕 Support for Voice Messages

🆕 Support for sending @silent messages

🧪 Partial support for role subscriptions

🧪 Partial support for burst reactions

🧪 Partial support for onboarding

🛠️ Fixed a bug where various flag enums were missing the [Flags] annotation.

What Changed?

DisCatSharp

DiscordClient

➕ Added GenerateInAppOauthFor to generate an oauth link for other apps.

➕ Added GetCurrentApplicationInfoAsync to get the current application info.

➕ Added the GuildAuditLogEntryCreated to the DiscordClient. The implementation is currently unstable.

➕ Added AutoModerationConfiguration and AutoModerationExecution to DiscordIntent. This is included in AllUnprivileged and All.

➕ Added TryGetPublishedListings to get the published premium sku listings for an application.

⚠️ Removed GuildBans from DiscordIntents and replaced it with GuildModeration.

DiscordConfiguration

⚠️ Deprecated UseCanary & UsePtb.

➕ Added ApiChannel.

UseCanary & UsePtb temporarily set ApiChannel internally:

/// <summary>
///     <para>Sets the proxy to use for HTTP and WebSocket connections to Discord.</para>
///     <para>Defaults to <see langword="null" />.</para>
/// </summary>
public IWebProxy? Proxy { internal get; set; } = null;

/// <summary>
///     <para>Sets the timeout for HTTP requests.</para>
///     <para>Set to <see cref="System.Threading.Timeout.InfiniteTimeSpan" /> to disable timeouts.</para>
///     <para>Defaults to 20 seconds.</para>

DiscordApplication

➕ Added ApproximateGuildCount to get the approximate guild count.

➕ Added InteractionsEndpointUrl to get the interactions endpoint url set in the developer portal.

➕ Added RedirectUris to get the redirect uris set in the developer portal.

➕ Added Guild to get the guild this application is linked to as support server.

➕ Added support for application subscriptions. See this for more information.

➕ Added enum DisCatSharp.Enums.ApplicationCommandContexts. This field isn't added for now.

DiscordInteraction

➕ Added the options AsSilentMessage and SuppressEmbeds to DiscordFollowupMessageBuilder, DiscordInteractionResponseBuilder and DiscordWebhookBuilder.

➕ Added Entitlements to get the entitlements for premium apps.

➕ Added InteractionResponseType InteractionRequireEntitlement.

DiscordRole

➕ Added IsLinkedRole to DiscordRole.Tags to check whether this role is a linked role.

➕ Added SubscriptionListingId to DiscordRole.Tags to get the subscription listing id.

➕ Added AvailableForPurchase to DiscordRole.Tags to check whether this role is available for purchase.

DiscordGuild

➕ Added SafetyAlertsChannel to get the safety alerts channel and the corresponding function ModifySafetyAlertsSettingsAsync to modify the safety alerts settings.

AutomodRule

➕ Added MentionRaidProtectionEnabled to AutomodTriggerMetadata.

➕ Added TriggerType EnforceServerRules. This is currently in alpha.

DiscordChannel

➕ Added scheduledEventId to DiscordChannel.OpenStageAsync to create a stage channel bound to a scheduled event.

➕ Added new ChannelFlags:

IsBroadcasting
IsRoleSubscriptionTemplatePreviewChannel
ApplicationShelfConsent
SummariesDisabled
IsMediaChannel
IsScheduledForDeletion
ClydeAi
IsGuildResourceChannel
IsSpam

⚠️ Removed privacyLevel from DiscordChannel.OpenStageAsync as it's no longer supported by discord.

DiscordThreadChannel

➕ Added LockAsync to lock a thread.

➕ Added UnlockAsync to unlock a thread.

➕ You can now pin posts in forum channels.

❕ Thread members are now paginated.

⚠️ Deprecated parameter locked from ArchiveAsync as it's no longer supported by discord.

DiscordMessage

➕ Added support for voice messages. Flag IsVoiceMessage is set to represented if the message is a voice message.

➕ Added new MessageTypes:

PrivateChannelIntegrationAdded
PrivateChannelIntegrationRemoved
PremiumReferral

DiscordAttachment

➕ Added DurationSecs to get the duration of a voice message.

➕ Added WaveForm to get the waveform of a voice message. This is a base64 encoded byte-array representing a sampled waveform.

DiscordReaction

Warning

Reactions are undergoing a rework which is not covered in this release.

🧪 Partial support for burst reactions.

DiscordUser

➕ Added CreateDmChannelAsync to create a dm channel with this user.

➕ Added SendMessageAsync to send a message to this user.

➕ Added Collaborator and RestrictedCollaborator to UserFlags to check whether this user is a collaborator.

➕ Added support for the new Username System. See this for more information.

➕ Added GlobalName to get the global name of this user.

➕ Added UsernameWithGlobalName to get the username with the global name of this user.

➕ Added IsMigrated to check whether this user is migrated to the new Username System.

🛠️ Fixed a bug causing Locale to be null.

⚠️ Deprecated UsernameWithDiscriminator.

⚠️ Deprecated Discriminator.

DiscordMember

➕ Added method VerifyAsync to verify a member. This skips the verification requirements when onboarding is enabled.

➕ Added method UnverifyAsync to unverify a member.

➕ Added new MemberFlags:

BypassesVerification
StartedOnboarding
CompletedOnboarding
IsGuest
StartedHomeActions
CompletedHomeActions
AutomodQuarantinedUsernameOrGuildNickname
AutomodQuarantinedBio

DiscordInvite

➕ Added new TargetTypes.

➕ Added new InviteFlags.

Permissions

➕ Added CreateGuildExpressions

➕ Added CreateEvents

➕ Added UseSoundboard

➕ Added UseExternalSounds

➕ Added SendVoiceMessages

⚠️ Renamed ManageExpressions to ManageGuildExpressions

⚠️ Removed ManageEmojisAndStickers

Formatter

🛠️ All methods are now extension methods.

➕ Added support for extended markdown.

DisCatSharp.ApplicationCommands

➕ You can now register guild commands via assembly. This doesn't support translations tho.

➕ Added Entitlements to BaseContext.

➕ Added support for application subscriptions.

➕ Added ApplicationCommandRequireEntitlementAttribute to require an entitlement to execute a command.

🛠️ Fixed a bug preventing you to set DmPermission for ContextMenu commands.

DisCatSharp.VoiceNext

🛠️ Fixed the ip discovery used to connect to discord voice servers.

Discord changed this suddenly without heads up.

Thanks to disgo for helping out.

Username System Change

Official resources:

Impact of Unique Usernames on Apps and Bots

Discord announced that Discord’s username system is changing. Discriminators are being removed and new, unique usernames (@name) and display names are being introduced. These changes will make it easier for users to connect with their friends and give more control over identity on Discord. You can visit https://discord.com/blog/usernames to hear from one of their founders about why usernames are changing, or read more details about how changes to the username system affects non-bot users at https://dis.gd/usernames.

More details for developers (including an FAQ) are in the Help Center article:

https://dis.gd/app-usernames

Below is an overview of how apps and bots will be affected by the username change. More details for developers, including exact dates, will be communicated soon.

Changes to bot users on Discord

They recently made a change to add bot users to all newly-created apps. During the username migration, all apps without a bot user created before April 14 will have a bot user automatically added. If your app doesn’t require a bot user, you can skip adding the bot scope during installation.
After migration, developers will no longer be able to directly set bot usernames or bot icons. The bot user’s icon will always be the same as the App Icon. Bot usernames will be determined differently for verified and unverified apps:

Verified apps: Bot usernames will be determined by the Application Name. When an unverified app goes through the verification process, a username created from the Application Name will be given to the bot user.
Unverified apps: Bot usernames will be randomized for new and existing unverified apps. This does not affect the Application Name.

Application Names (the Name field on the General Overview page within the app’s settings) will be used as the Display Name for an app’s bot user. This means developers cannot manually update the Display Name for a bot user without updating the Application Name. Server nicknames are unaffected by this change.
The Discord client will be updated to only display Application Names in most surfaces, including the bot profile and in the search interface. The client changes will allow all Discord apps, verified and unverified, to use their Application Name as the identity for their app (and bot) across Discord.

Migration of verified app usernames

Most verified apps with Application Names which can be automatically migrated to the new username system have been reserved. No user will be able to claim the reserved username, and during migration the reserved name will be automatically given to the app's bot user.

Verified apps that cannot be automatically migrated or wish to change their Application Name for another reason will be able to make a one-time change at the time of migration.

Identifying migrated users

To keep clients backwards-compatible, users that are migrated to the new username system will have a single zero (#0) discriminator. This will not appear in the client, but will be in payloads your app receives. After the migration to the new username system is complete, the 0 discriminator will be removed.

Preparing your app for username changes

Remove any logic that depends on discriminators for Discord users. Apps should continue using user IDs to uniquely identify Discord users in their code. Make sure to account for the temporary #0 discriminator that updated users will have when updating your code.
Be prepared for your username change. That includes in code, or anywhere else you may reference your bot username.
If your app is verified, stay tuned for details about migration dates and how to perform a one-time update for your Application Name/bot username.

Developer take on the username change for bots

Bots having Username#Discrim is pretty useless imo. Username#Discrims only purpose is to add friends, but you can't add bots as friends.

A single @username makes more sense for bots because it acts as a vanity identifier.

Now you could argue about the fact that non-verified bots usernames are randomized. That might be true, but users see the application name anyways in the UI, and this field is changeable. Upon verification you can choose your custom @username.

I think this helps fighting scams and impersionations even more.

Transition to global name

We've deprecated Discriminator & DiscriminatorInt on the DiscordUser & DiscordMember entities.

Due to global name not being rolled out yet, GlobalName is marked as experimental for now.

During the rollout we'll remove the experimental mark from GlobalName.

You should update to this new field as soon as possible when the rollout begins.

As an example how to handle both cases:

using DisCatSharp;
using DisCatSharp.ApplicationCommands;
using DisCatSharp.ApplicationCommands.Attributes;
using DisCatSharp.ApplicationCommands.Context;
namespace Bot.Commands;

internal class SlashCommand : ApplicationCommandsModule
{
    [SlashCommand("execute", "Execute command")]
    internal static async Task ExecuteCommandAsync(InteractionContext ctx)
    {
        var name = ctx.User.IsMigrated ? ctx.User.UsernameWithGlobalName : ctx.User.UsernameWithDiscriminator;
        await ctx.CreateResponseAsync(
            InteractionResponseType.ChannelMessageWithSource,
            new DiscordInteractionResponseBuilder().WithContent($"Your name: {name}")
        );
    }
}

New, changed and deprecated fields

These changes apply both for DiscordUser & DiscordMember.

Change Type	Field or Function	Type	Change Description
Deprecated	Discriminator	string
Deprecated	DiscriminatorInt	int
Deprecated	UsernameWithDiscriminator	string	This falls back to `UsernameWithGlobalName` for a while if a user is already migrated.
Added	UsernameWithGlobalName	string
Added	GlobalName	string
Added	IsMigrated	bool	Helper function to detect whether a user has is enrolled in the new system.
Changed	ToString()*	string	Function was updated to return the correct info based on `IsMigrated`

*This was also changed for DiscordTeamMember.ToString()

Automatic Mapping

To help you transition to this change, we automatically map the old username with discriminator to the new username with global name.

flowchart LR

A([UsernameWithDiscriminator]) --> B{IsMigrated}
B -->|True| C([Using UsernameWithGlobalName])
B -->|False| D([Using Username#Discriminator])

Application Subscription

We would like to announce that we have added partial support for Discord's Premium Apps feature. However, please note that this feature is currently in alpha and may not be fully supported by our library as library developers don't get access to the documentation for it.

Premium Apps allow developers to provide premium commands for which users can subscribe via in-app purchases. If a user is not subscribed, bots will respond with a message asking them to subscribe. If they are subscribed, the command payload from Discord to the bot will have a SKU ID set, indicating that the user or server is subscribed.

Although our library has implemented support for this feature, you might need to make adjustments to your code to fully utilize it. If you encounter any issues or require assistance, please inform us so that we can address the issue within the library.

DisCatSharp

We've added the field Entitlements to get the entitlements for premium apps. It is a list of sku ids.

InteractionResponseType was extended by type 10 called InteractionRequireEntitlement. This is used to tell Discord that the user is not entitled to use the command and requests the user to buy the premium subscription.

Additionally we've added the function TryGetPublishedListings to get the published premium sku listings for an application. You can use it to check dynamically for your sku ids.

DisCatSharp.ApplicationCommands

Application commands got a new Attribute called ApplicationCommandRequireEntitlementAttribute to require an entitlement to execute a command.

BaseContext now has the field Entitlements.

Pull Requests

Full Changes

Contributors

Special Thanks

This release special thanks go to:

snek for helping out with details about the premium apps implementation 😝
TopiSenpai for helping out with fixing the ip discovery
quinchs for advising a good change I (Lala) totally forgot about
JuliaJJ for helping out with design choice

Table of Contents

Upgrade from 10.3.0 to 10.4.0

Note

Important

What Is New In DisCatSharp?

What Changed?

DisCatSharp

Warning

DisCatSharp.ApplicationCommands

DisCatSharp.VoiceNext

Username System Change

Application Subscription

Pull Requests

Contributors

Special Thanks