Class DiscordClient

Namespace: DisCatSharp

Assembly: DisCatSharp.dll

A Discord API wrapper.

public sealed class DiscordClient : BaseDiscordClient, IDisposable

Inheritance: object

BaseDiscordClient

DiscordClient

Implements: IDisposable

Inherited Members: BaseDiscordClient.Logger

BaseDiscordClient.VersionString

BaseDiscordClient.BotLibrary

BaseDiscordClient.CurrentUser

BaseDiscordClient.CurrentApplication

BaseDiscordClient.RestClient

BaseDiscordClient.UserCache

BaseDiscordClient.VoiceRegions

BaseDiscordClient.GetCurrentApplicationAsync()

BaseDiscordClient.UpdateCurrentApplicationInfoAsync(Optional<string>, Optional<string>, Optional<string>, Optional<string>, Optional<List<string>>, Optional<Stream>, Optional<Stream>, Optional<ApplicationFlags>, Optional<DiscordApplicationInstallParams>)

BaseDiscordClient.EnableUserAppsAsync()

BaseDiscordClient.UpdateCurrentApplicationInfoAsync(Optional<string>, Optional<string>, Optional<string>, Optional<string>, Optional<List<string>>, Optional<Stream>, Optional<Stream>, Optional<ApplicationFlags>, Optional<DiscordIntegrationTypesConfig>)

BaseDiscordClient.ListVoiceRegionsAsync()

BaseDiscordClient.InitializeAsync()

BaseDiscordClient.GetGatewayInfoAsync(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

DiscordClient(DiscordConfiguration): Initializes a new instance of DiscordClient.

Properties

CommandCooldownBuckets: Gets the cooldown buckets for commands.

EmbeddedActivities: Gets the collection of presences held by this client.

GatewayInfo: Gets the gateway session information for this client.

GatewayUri: Gets the gateway URL.

GatewayVersion: Gets the gateway protocol version.

Guilds: Gets a dictionary of guilds that this client is in. The dictionary's key is the guild ID. Note that the guild objects in this dictionary will not be filled in if the specific guilds aren't available (the GuildAvailable or GuildDownloadCompleted events haven't been fired yet)

Intents: Gets the intents configured for this client.

Ping: Gets the websocket latency for this client.

Presences: Gets the collection of presences held by this client.

ShardCount: Gets the total number of shards the bot is connected to.

ShardId: Gets the currently connected shard ID.

Methods

AddExtension(BaseExtension): Registers an extension with this client.

BulkOverwriteGlobalApplicationCommandsAsync(IEnumerable<DiscordApplicationCommand>): Overwrites the existing global application commands. New commands are automatically created and missing commands are automatically deleted.

BulkOverwriteGuildApplicationCommandsAsync(ulong, IEnumerable<DiscordApplicationCommand>): Overwrites the existing application commands in a guild. New commands are automatically created and missing commands are automatically deleted.

ConnectAsync(DiscordActivity?, UserStatus?, DateTimeOffset?): Connects to the gateway.

CreateGlobalApplicationCommandAsync(DiscordApplicationCommand): Creates or overwrites a global application command.

CreateGuildApplicationCommandAsync(ulong, DiscordApplicationCommand): Creates or overwrites a guild application command.

CreateGuildAsync(string, string, Optional<Stream>, VerificationLevel?, DefaultMessageNotifications?, SystemChannelFlags?): Creates a guild. This requires the bot to be in less than 10 guilds total.

CreateGuildFromTemplateAsync(string, string, Optional<Stream>): Creates a guild from a template. This requires the bot to be in less than 10 guilds total.

CreateTestEntitlementsAsync(ulong, ulong, EntitlementOwnerType): Creates a test entitlement.

DeleteGlobalApplicationCommandAsync(ulong): Deletes a global application command.

DeleteGuildApplicationCommandAsync(ulong, ulong): Deletes a application command in a guild.

DeleteTestEntitlementsAsync(ulong): Deletes a test entitlement.

DisconnectAsync(): Disconnects from the gateway.

Dispose(): Disposes the client.

EditGlobalApplicationCommandAsync(ulong, Action<ApplicationCommandEditModel>): Edits a global application command.

EditGuildApplicationCommandAsync(ulong, ulong, Action<ApplicationCommandEditModel>): Edits a application command in a guild.

~DiscordClient(): Disposes the client.

GenerateInAppOauthFor(DiscordUser, Permissions, OAuthScopes, string?, bool, ulong?, string?, string?, string?, bool, string?): Generates an In-App OAuth Url for a specific bot.

GetChannelAsync(ulong, bool): Gets a channel.

GetConnectionsAsync(): Gets a list of user connections.

GetCurrentApplicationInfoAsync()

GetEntitlementsAsync(ulong?, ulong?): Gets the applications entitlements.

GetExtension<T>(): Retrieves a previously registered extension from this client.

GetGlobalApplicationCommandAsync(ulong): Gets a global application command by its id.

GetGlobalApplicationCommandsAsync(bool): Gets all the global application commands for this application.

GetGuildApplicationCommandAsync(ulong, ulong): Gets a application command in a guild by its id.

GetGuildApplicationCommandsAsync(ulong, bool): Gets all the application commands for a guild.

GetGuildAsync(ulong, bool?, bool)

Gets a guild.

Setting withCounts to true will make a REST request.

GetGuildPreviewAsync(ulong): Gets a guild preview.

GetGuildWidgetAsync(ulong): Gets a guild widget.

GetInAppOAuth(Permissions, OAuthScopes, string?, bool, ulong?, string?, string?, string?, bool, string?): Gets the In-App OAuth Url for the current application.

GetInviteByCodeAsync(string, bool?, bool?, ulong?): Gets an invite.

GetPublishedListingsAsync(ulong): Gets the published store sku listings (premium application subscription).

GetRoleConnectionMetadata(): Gets the applications role connection metadata.

GetRpcApplicationAsync(ulong): Gets a applications rpc information.

GetSkusAsync(): Gets the applications skus.

GetStickerAsync(ulong): Gets a sticker.

GetStickerPacksAsync(): Gets all nitro sticker packs.

GetTemplateAsync(string): Gets a guild template by the code.

GetThreadAsync(ulong, bool): Gets a thread.

GetUserAsync(ulong, bool): Gets a user.

GetWebhookAsync(ulong): Gets a webhook.

GetWebhookWithTokenAsync(ulong, string): Gets a webhook with a token.

ReconnectAsync(bool): Reconnects to the gateway.

RegisterEventHandler(object, bool): Registers all methods annotated with EventAttribute from the given object.

RegisterEventHandler(Type)

If abstract, registers all static methods of the type.

If non-abstract, tries to instantiate it, optionally using the provided ServiceProvider and registers all instance and static methods.

RegisterEventHandler<T>(): RegisterEventHandler(Type).

RegisterEventHandlers(Assembly): Registers all types associated with the provided assembly that have the EventHandler attribute.

RegisterStaticEventHandler(Type): Registers all static methods annotated with EventAttribute from the given type.

RegisterStaticEventHandler<T>(): RegisterStaticEventHandler(Type).

RemoveGlobalApplicationCommandsAsync(): Removes all global application commands.

RemoveGuildApplicationCommandsAsync(DiscordGuild): Removes all global application commands for a specific guild.

RemoveGuildApplicationCommandsAsync(ulong): Removes all global application commands for a specific guild id.

SendMessageAsync(DiscordChannel, DiscordEmbed): Sends a message with an embed.

SendMessageAsync(DiscordChannel, DiscordMessageBuilder): Sends a message with the DiscordMessageBuilder.

SendMessageAsync(DiscordChannel, Action<DiscordMessageBuilder>): Sends a message with an Action<T>.

SendMessageAsync(DiscordChannel, string): Sends a normal message.

SendMessageAsync(DiscordChannel, string, DiscordEmbed): Sends a message with content and an embed.

TryGetChannel(ulong, out DiscordChannel?, bool): Tries to get a channel.

TryGetGuild(ulong, out DiscordGuild?, bool?, bool)

Tries to get a guild.