Table of Contents

Class DiscordRestApiClient

Namespace
DSharpPlus.Net
Assembly
DSharpPlus.dll
public sealed class DiscordRestApiClient
Inheritance
object
DiscordRestApiClient

Constructors

DiscordRestApiClient(RestClient)

Methods

AddGroupDmRecipientAsync(ulong, ulong, string, string)
AddGuildMemberAsync(ulong, ulong, string, bool?, bool?, string?, IEnumerable<ulong>?)
AddGuildMemberRoleAsync(ulong, ulong, ulong, string?)
AddThreadMemberAsync(ulong, ulong)
BatchEditApplicationCommandPermissionsAsync(ulong, ulong, IEnumerable<DiscordGuildApplicationCommandPermissions>)
BecomeStageInstanceSpeakerAsync(ulong, ulong, ulong?, DateTime?, bool?)
BeginGuildPruneAsync(ulong, int, bool, IEnumerable<ulong>?, string?)
BulkOverwriteGlobalApplicationCommandsAsync(ulong, IEnumerable<DiscordApplicationCommand>)
BulkOverwriteGuildApplicationCommandsAsync(ulong, ulong, IEnumerable<DiscordApplicationCommand>)
ConsumeEntitlementAsync(ulong, ulong)

For One-Time Purchase consumable SKUs, marks a given entitlement for the user as consumed.

CreateApplicationEmojiAsync(ulong, string, string)
CreateChannelInviteAsync(ulong, int, int, bool, bool, string, DiscordInviteTargetType?, ulong?, ulong?)
CreateDmAsync(ulong)
CreateFollowupMessageAsync(ulong, string, DiscordFollowupMessageBuilder)
CreateForumPostAsync(ulong, string, DiscordMessageBuilder, DiscordAutoArchiveDuration?, int?, IEnumerable<ulong>?)
CreateGlobalApplicationCommandAsync(ulong, DiscordApplicationCommand)
CreateGroupDmAsync(IEnumerable<string>, IDictionary<ulong, string>)
CreateGuildApplicationCommandAsync(ulong, ulong, DiscordApplicationCommand)
CreateGuildAsync(string, string, Optional<string>, DiscordVerificationLevel?, DiscordDefaultMessageNotifications?, DiscordSystemChannelFlags?)
CreateGuildAutoModerationRuleAsync(ulong, string, DiscordRuleEventType, DiscordRuleTriggerType, DiscordRuleTriggerMetadata, IReadOnlyList<DiscordAutoModerationAction>, Optional<bool>, Optional<IReadOnlyList<DiscordRole>>, Optional<IReadOnlyList<DiscordChannel>>, string?)

Internal method to create an auto-moderation rule in a guild.

CreateGuildBanAsync(ulong, ulong, int, string?)
CreateGuildBulkBanAsync(ulong, IEnumerable<ulong>, int?, string?)
CreateGuildChannelAsync(ulong, string, DiscordChannelType, ulong?, Optional<string>, int?, int?, IEnumerable<DiscordOverwriteBuilder>?, bool?, Optional<int?>, DiscordVideoQualityMode?, int?, string, DiscordAutoArchiveDuration?, DefaultReaction?, IEnumerable<DiscordForumTagBuilder>?, DiscordDefaultSortOrder?)
CreateGuildEmojiAsync(ulong, string, string, IEnumerable<ulong>?, string?)
CreateGuildFromTemplateAsync(string, string, Optional<string>)
CreateGuildIntegrationAsync(ulong, string, ulong)
CreateGuildRoleAsync(ulong, string, DiscordPermissions?, int?, bool?, bool?, Stream?, string?, string?)
CreateGuildStickerAsync(ulong, string, string, string, DiscordMessageFile, string?)
CreateGuildTemplateAsync(ulong, string, string)
CreateInteractionResponseAsync(ulong, string, DiscordInteractionResponseType, DiscordInteractionResponseBuilder?)
CreateMessageAsync(ulong, DiscordMessageBuilder)
CreateMessageAsync(ulong, string?, IEnumerable<DiscordEmbed>?, ulong?, bool, bool, bool)
CreateReactionAsync(ulong, ulong, string)
CreateScheduledGuildEventAsync(ulong, string, string, DateTimeOffset, DiscordScheduledGuildEventType, DiscordScheduledGuildEventPrivacyLevel, DiscordScheduledGuildEventMetadata?, DateTimeOffset?, ulong?, Stream?, string?)
CreateStageInstanceAsync(ulong, string, DiscordStagePrivacyLevel?, string?)
CreateTestEntitlementAsync(ulong, ulong, ulong, DiscordTestEntitlementOwnerType)

Create a test entitlement which can be granted to a user or a guild

CreateThreadAsync(ulong, string, DiscordAutoArchiveDuration, DiscordChannelType, string?)
CreateThreadFromMessageAsync(ulong, ulong, string, DiscordAutoArchiveDuration, string?)
CreateWebhookAsync(ulong, string, Optional<string>, string?)
CrosspostMessageAsync(ulong, ulong)
DeleteAllReactionsAsync(ulong, ulong, string?)
DeleteApplicationEmojiAsync(ulong, ulong)
DeleteChannelAsync(ulong, string)
DeleteChannelPermissionAsync(ulong, ulong, string)
DeleteGlobalApplicationCommandAsync(ulong, ulong)
DeleteGuildApplicationCommandAsync(ulong, ulong, ulong)
DeleteGuildAsync(ulong)
DeleteGuildAutoModerationRuleAsync(ulong, ulong, string?)

Internal method to delete an auto-moderation rule in a guild.

DeleteGuildEmojiAsync(ulong, ulong, string?)
DeleteGuildIntegrationAsync(ulong, ulong, string?)
DeleteGuildTemplateAsync(ulong, string)
DeleteInviteAsync(string, string?)
DeleteMessageAsync(ulong, ulong, string?)
DeleteMessagesAsync(ulong, IEnumerable<ulong>, string)
DeleteOriginalInteractionResponseAsync(ulong, string)
DeleteOwnReactionAsync(ulong, ulong, string)
DeleteReactionsEmojiAsync(ulong, ulong, string)
DeleteRoleAsync(ulong, ulong, string?)
DeleteScheduledGuildEventAsync(ulong, ulong, string?)
DeleteStageInstanceAsync(ulong, string?)
DeleteStickerAsync(ulong, ulong, string?)
DeleteTestEntitlementAsync(ulong, ulong)

Deletes a test entitlement

DeleteUserReactionAsync(ulong, ulong, ulong, string, string?)
DeleteWebhookAsync(ulong, string?)
DeleteWebhookAsync(ulong, string, string?)
DeleteWebhookMessageAsync(ulong, string, ulong)
EditApplicationCommandPermissionsAsync(ulong, ulong, ulong, IEnumerable<DiscordApplicationCommandPermission>)
EditChannelPermissionsAsync(ulong, ulong, DiscordPermissions, DiscordPermissions, string, string?)
EditGlobalApplicationCommandAsync(ulong, ulong, Optional<string>, Optional<string>, Optional<IReadOnlyList<DiscordApplicationCommandOption>>, Optional<bool?>, Optional<bool?>, IReadOnlyDictionary<string, string>?, IReadOnlyDictionary<string, string>?, Optional<bool>, Optional<DiscordPermissions?>, Optional<IEnumerable<DiscordInteractionContextType>>, Optional<IEnumerable<DiscordApplicationIntegrationType>>)
EditGuildApplicationCommandAsync(ulong, ulong, ulong, Optional<string>, Optional<string>, Optional<IReadOnlyList<DiscordApplicationCommandOption>>, Optional<bool?>, Optional<bool?>, IReadOnlyDictionary<string, string>?, IReadOnlyDictionary<string, string>?, Optional<bool>, Optional<DiscordPermissions?>, Optional<IEnumerable<DiscordInteractionContextType>>, Optional<IEnumerable<DiscordApplicationIntegrationType>>)
EditMessageAsync(ulong, ulong, Optional<string>, Optional<IEnumerable<DiscordEmbed>>, Optional<IEnumerable<IMention>>, IReadOnlyList<DiscordComponent>?, IReadOnlyList<DiscordMessageFile>?, DiscordMessageFlags?, IEnumerable<DiscordAttachment>?)
EditOriginalInteractionResponseAsync(ulong, string, DiscordWebhookBuilder, IEnumerable<DiscordAttachment>)
EditWebhookMessageAsync(ulong, string, ulong, DiscordWebhookBuilder, IEnumerable<DiscordAttachment>?)
EndPollAsync(ulong, ulong)
ExecuteWebhookAsync(ulong, string, DiscordWebhookBuilder)
ExecuteWebhookGithubAsync(ulong, string, string)
ExecuteWebhookSlackAsync(ulong, string, string)
FollowChannelAsync(ulong, ulong)
ForwardMessageAsync(ulong, ulong, ulong)
GetApplicationAssetsAsync(DiscordApplication)
GetApplicationCommandPermissionsAsync(ulong, ulong, ulong)
GetApplicationEmojiAsync(ulong, ulong)
GetApplicationEmojisAsync(ulong)
GetAuditLogsAsync(DiscordGuild, int, ulong?, ulong?, ulong?, DiscordAuditLogActionType?, CancellationToken)
GetChannelAsync(ulong)
GetChannelInvitesAsync(ulong)
GetChannelMessageAsync(ulong, ulong)
GetChannelMessagesAsync(ulong, int, ulong?, ulong?, ulong?)
GetChannelWebhooksAsync(ulong)
GetCurrentUserGuildMemberAsync(ulong)
GetCurrentUserGuildsAsync(int, ulong?, ulong?)
GetCurrentUserVoiceStateAsync(ulong)
GetGatewayInfoAsync()
GetGlobalApplicationCommandAsync(ulong, ulong)
GetGlobalApplicationCommandsAsync(ulong, bool)
GetGuildApplicationCommandAsync(ulong, ulong, ulong)
GetGuildApplicationCommandPermissionsAsync(ulong, ulong)
GetGuildApplicationCommandsAsync(ulong, ulong, bool)
GetGuildAsync(ulong, bool?)
GetGuildAutoModerationRuleAsync(ulong, ulong)

Internal method to get an auto-moderation rule in a guild.

GetGuildAutoModerationRulesAsync(ulong)

Internal method to get all auto-moderation rules in a guild.

GetGuildBanAsync(ulong, ulong)
GetGuildBansAsync(ulong, int?, ulong?, ulong?)
GetGuildChannelsAsync(ulong)
GetGuildEmojiAsync(ulong, ulong)
GetGuildEmojisAsync(ulong)
GetGuildIntegrationsAsync(ulong)
GetGuildInvitesAsync(ulong)
GetGuildMemberAsync(ulong, ulong)
GetGuildMembershipScreeningFormAsync(ulong)
GetGuildPreviewAsync(ulong)
GetGuildPruneCountAsync(ulong, int, IEnumerable<ulong>?)
GetGuildRoleAsync(ulong, ulong)
GetGuildRolesAsync(ulong)
GetGuildStickerAsync(ulong, ulong)
GetGuildStickersAsync(ulong)
GetGuildTemplatesAsync(ulong)
GetGuildVanityUrlAsync(ulong)
GetGuildVoiceRegionsAsync(ulong)
GetGuildWebhooksAsync(ulong)
GetGuildWelcomeScreenAsync(ulong)
GetGuildWidgetAsync(ulong)
GetGuildWidgetSettingsAsync(ulong)
GetGuildsAsync(int?, ulong?, ulong?, bool?)
GetInviteAsync(string, bool?, bool?)
GetMessageAsync(ulong, ulong)
GetOriginalInteractionResponseAsync(ulong, string)
GetPinnedMessagesAsync(ulong)
GetPollAnswerVotersAsync(ulong, ulong, int, ulong?, int?)
GetReactionsAsync(ulong, ulong, string, ulong?, int)
GetScheduledGuildEventAsync(ulong, ulong)
GetScheduledGuildEventUsersAsync(ulong, ulong, bool, int, ulong?, ulong?)
GetScheduledGuildEventsAsync(ulong, bool)
GetStageInstanceAsync(ulong)
GetStickerAsync(ulong)
GetStickerPacksAsync()
GetTemplateAsync(string)
GetThreadMemberAsync(ulong, ulong)
GetUserAsync(string)
GetUserVoiceStateAsync(ulong, ulong)
GetUsersConnectionsAsync()
GetWebhookAsync(ulong)
GetWebhookMessageAsync(ulong, string, ulong)
GetWebhookWithTokenAsync(ulong, string)
JoinThreadAsync(ulong)
LeaveGuildAsync(ulong)
LeaveThreadAsync(ulong)
ListActiveThreadsAsync(ulong)
ListEntitlementsAsync(ulong, ulong?, IEnumerable<ulong>?, ulong?, ulong?, ulong?, bool?, int?)

Returns all entitlements for a given app.

ListGuildMembersAsync(ulong, int?, ulong?)
ListJoinedPrivateArchivedThreadsAsync(ulong, ulong, int, ulong?)
ListPrivateArchivedThreadsAsync(ulong, ulong, int, string?)
ListPublicArchivedThreadsAsync(ulong, ulong, string, int)
ListStockKeepingUnitsAsync(ulong)

Internal method to get all SKUs belonging to a specific application

ListThreadMembersAsync(ulong)
ListVoiceRegionsAsync()
ModifyApplicationEmojiAsync(ulong, ulong, string)
ModifyChannelAsync(ulong, string, int?, Optional<string>, bool?, Optional<ulong?>, int?, int?, Optional<int?>, Optional<string>, DiscordVideoQualityMode?, Optional<DiscordChannelType>, IEnumerable<DiscordOverwriteBuilder>?, Optional<DiscordChannelFlags>, IEnumerable<DiscordForumTagBuilder>?, Optional<DiscordAutoArchiveDuration?>, Optional<DefaultReaction?>, Optional<int>, Optional<DiscordDefaultSortOrder?>, Optional<DiscordDefaultForumLayout>, string?)
ModifyCurrentMemberAsync(ulong, string, string?)
ModifyCurrentUserAsync(string, Optional<string>, Optional<string>)
ModifyGuildAsync(ulong, Optional<string>, Optional<string>, Optional<DiscordVerificationLevel>, Optional<DiscordDefaultMessageNotifications>, Optional<DiscordMfaLevel>, Optional<DiscordExplicitContentFilter>, Optional<ulong?>, Optional<int>, Optional<string>, Optional<ulong>, Optional<string>, Optional<ulong?>, Optional<string>, Optional<string>, Optional<string>, Optional<IEnumerable<string>>, Optional<string>, Optional<ulong?>, Optional<ulong?>, Optional<DiscordSystemChannelFlags>, string?)
ModifyGuildAutoModerationRuleAsync(ulong, ulong, Optional<string>, Optional<DiscordRuleEventType>, Optional<DiscordRuleTriggerMetadata>, Optional<IReadOnlyList<DiscordAutoModerationAction>>, Optional<bool>, Optional<IReadOnlyList<DiscordRole>>, Optional<IReadOnlyList<DiscordChannel>>, string?)

Internal method to modify an auto-moderation rule in a guild.

ModifyGuildChannelPositionAsync(ulong, IEnumerable<DiscordChannelPosition>, string?)
ModifyGuildEmojiAsync(ulong, ulong, string?, IEnumerable<ulong>?, string?)
ModifyGuildIntegrationAsync(ulong, ulong, int, int, bool)
ModifyGuildMemberAsync(ulong, ulong, Optional<string>, Optional<IEnumerable<ulong>>, Optional<bool>, Optional<bool>, Optional<ulong?>, Optional<DateTimeOffset?>, Optional<DiscordMemberFlags>, string?)
ModifyGuildMembershipScreeningFormAsync(ulong, Optional<bool>, Optional<DiscordGuildMembershipScreeningField[]>, Optional<string>)
ModifyGuildRoleAsync(ulong, ulong, string?, DiscordPermissions?, int?, bool?, bool?, Stream?, string?, string?)
ModifyGuildRolePositionsAsync(ulong, IEnumerable<DiscordRolePosition>, string?)
ModifyGuildTemplateAsync(ulong, string, string?, string?)
ModifyGuildWelcomeScreenAsync(ulong, Optional<bool>, Optional<IEnumerable<DiscordGuildWelcomeScreenChannel>>, Optional<string>, string?)
ModifyGuildWidgetSettingsAsync(ulong, bool?, ulong?, string?)
ModifyScheduledGuildEventAsync(ulong, ulong, Optional<string>, Optional<string>, Optional<ulong?>, Optional<DateTimeOffset>, Optional<DateTimeOffset>, Optional<DiscordScheduledGuildEventType>, Optional<DiscordScheduledGuildEventPrivacyLevel>, Optional<DiscordScheduledGuildEventMetadata>, Optional<DiscordScheduledGuildEventStatus>, Optional<Stream>, string?)
ModifyStageInstanceAsync(ulong, Optional<string>, Optional<DiscordStagePrivacyLevel>, string?)
ModifyStickerAsync(ulong, ulong, Optional<string>, Optional<string>, Optional<string>, string?)
ModifyThreadChannelAsync(ulong, string, int?, Optional<string>, bool?, Optional<ulong?>, int?, int?, Optional<int?>, Optional<string>, DiscordVideoQualityMode?, Optional<DiscordChannelType>, IEnumerable<DiscordOverwriteBuilder>?, bool?, DiscordAutoArchiveDuration?, bool?, IEnumerable<ulong>?, bool?, string?)
ModifyWebhookAsync(ulong, string, string?, string?, string?)
ModifyWebhookAsync(ulong, ulong, string?, Optional<string>, string?)
PinMessageAsync(ulong, ulong)
RemoveGroupDmRecipientAsync(ulong, ulong)
RemoveGuildBanAsync(ulong, ulong, string?)
RemoveGuildMemberAsync(ulong, ulong, string?)
RemoveGuildMemberRoleAsync(ulong, ulong, ulong, string)
RemoveThreadMemberAsync(ulong, ulong)
SearchMembersAsync(ulong, string, int?)
SyncGuildIntegrationAsync(ulong, ulong)
SyncGuildTemplateAsync(ulong, string)
TriggerTypingAsync(ulong)
UnpinMessageAsync(ulong, ulong)
UpdateUserVoiceStateAsync(ulong, ulong, ulong, bool?)
Edit this page