Table of Contents

Namespace NetCord.Hosting.Gateway

Classes

GatewayClientHostBuilderExtensions
GatewayClientOptions
GatewayClientServiceCollectionExtensions
GatewayEvent
GatewayEvent<T>
GatewayHandlerHostExtensions
GatewayHandlerServiceCollectionExtensions
ShardedGatewayClientHostBuilderExtensions
ShardedGatewayClientOptions
ShardedGatewayClientServiceCollectionExtensions

Interfaces

IApplicationCommandPermissionsUpdateGatewayHandler

Sent when an application command's permissions are updated. The inner payload is an ApplicationCommandPermission object.

IApplicationCommandPermissionsUpdateShardedGatewayHandler

Sent when an application command's permissions are updated. The inner payload is an ApplicationCommandPermission object.

IAutoModerationActionExecutionGatewayHandler

Sent when a rule is triggered and an action is executed (e.g. when a message is blocked).

IAutoModerationActionExecutionShardedGatewayHandler

Sent when a rule is triggered and an action is executed (e.g. when a message is blocked).

IAutoModerationRuleCreateGatewayHandler

Sent when a rule is created. The inner payload is an AutoModerationRule object.

IAutoModerationRuleCreateShardedGatewayHandler

Sent when a rule is created. The inner payload is an AutoModerationRule object.

IAutoModerationRuleDeleteGatewayHandler

Sent when a rule is deleted. The inner payload is an AutoModerationRule object.

IAutoModerationRuleDeleteShardedGatewayHandler

Sent when a rule is deleted. The inner payload is an AutoModerationRule object.

IAutoModerationRuleUpdateGatewayHandler

Sent when a rule is updated. The inner payload is an AutoModerationRule object.

IAutoModerationRuleUpdateShardedGatewayHandler

Sent when a rule is updated. The inner payload is an AutoModerationRule object.

IChannelPinsUpdateGatewayHandler

Sent when a message is pinned or unpinned in a text channel. This is not sent when a pinned message is deleted.

IChannelPinsUpdateShardedGatewayHandler

Sent when a message is pinned or unpinned in a text channel. This is not sent when a pinned message is deleted.

ICloseGatewayHandler
ICloseShardedGatewayHandler
IConnectGatewayHandler
IConnectShardedGatewayHandler
IConnectingGatewayHandler
IConnectingShardedGatewayHandler
ICurrentUserUpdateGatewayHandler

Sent when properties about the current bot's user change. Inner payload is a CurrentUser object.

ICurrentUserUpdateShardedGatewayHandler

Sent when properties about the current bot's user change. Inner payload is a CurrentUser object.

IDisconnectGatewayHandler
IDisconnectShardedGatewayHandler
IEntitlementCreateGatewayHandler

Sent when an entitlement is created. The inner payload is an Entitlement object.

IEntitlementCreateShardedGatewayHandler

Sent when an entitlement is created. The inner payload is an Entitlement object.

IEntitlementDeleteGatewayHandler

Sent when an entitlement is deleted. Entitlements are not deleted when they expire. The inner payload is an Entitlement object.

IEntitlementDeleteShardedGatewayHandler

Sent when an entitlement is deleted. Entitlements are not deleted when they expire. The inner payload is an Entitlement object.

IEntitlementUpdateGatewayHandler

Sent when an entitlement is updated. When an entitlement for a subscription is renewed, the EndsAt field may have an updated value with the new expiration date. The inner payload is an Entitlement object.

IEntitlementUpdateShardedGatewayHandler

Sent when an entitlement is updated. When an entitlement for a subscription is renewed, the EndsAt field may have an updated value with the new expiration date. The inner payload is an Entitlement object.

IGatewayHandler
IGuildAuditLogEntryCreateGatewayHandler

Sent when a guild audit log entry is created. The inner payload is an AuditLogEntry object. This event is only sent to bots with the ViewAuditLog permission.

IGuildAuditLogEntryCreateShardedGatewayHandler

Sent when a guild audit log entry is created. The inner payload is an AuditLogEntry object. This event is only sent to bots with the ViewAuditLog permission.

IGuildBanAddGatewayHandler

Sent when a user is banned from a guild.

IGuildBanAddShardedGatewayHandler

Sent when a user is banned from a guild.

IGuildBanRemoveGatewayHandler

Sent when a user is unbanned from a guild.

IGuildBanRemoveShardedGatewayHandler

Sent when a user is unbanned from a guild.

IGuildChannelCreateGatewayHandler

Sent when a new guild channel is created, relevant to the bot. The inner payload is an IGuildChannel object.

IGuildChannelCreateShardedGatewayHandler

Sent when a new guild channel is created, relevant to the bot. The inner payload is an IGuildChannel object.

IGuildChannelDeleteGatewayHandler

Sent when a channel relevant to the bot is deleted. The inner payload is an IGuildChannel object.

IGuildChannelDeleteShardedGatewayHandler

Sent when a channel relevant to the bot is deleted. The inner payload is an IGuildChannel object.

IGuildChannelUpdateGatewayHandler

Sent when a channel is updated. This is not sent with new messages, those are tracked by MessageCreate and GuildThreadCreate. This event may reference roles or guild members that no longer exist in the guild. The inner payload is an IGuildChannel object.

IGuildChannelUpdateShardedGatewayHandler

Sent when a channel is updated. This is not sent with new messages, those are tracked by MessageCreate and GuildThreadCreate. This event may reference roles or guild members that no longer exist in the guild. The inner payload is an IGuildChannel object.

IGuildCreateGatewayHandler

This event can be sent in three different scenarios (During an outage, the Guild object in scenarios 1 and 3 may be marked as unavailable):

  • To lazily load and backfill information for all unavailable guilds sent in the Ready event. Guilds unavailable due to an outage will send a GuildDelete event.
  • When a guild becomes available again to the client.
  • When the current user joins a new guild.
IGuildCreateShardedGatewayHandler

This event can be sent in three different scenarios (During an outage, the Guild object in scenarios 1 and 3 may be marked as unavailable):

  • To lazily load and backfill information for all unavailable guilds sent in the Ready event. Guilds unavailable due to an outage will send a GuildDelete event.
  • When a guild becomes available again to the client.
  • When the current user joins a new guild.
IGuildDeleteGatewayHandler

Sent when a guild becomes or was already unavailable due to an outage, or when the bot leaves / is removed from a guild.

IGuildDeleteShardedGatewayHandler

Sent when a guild becomes or was already unavailable due to an outage, or when the bot leaves / is removed from a guild.

IGuildEmojisUpdateGatewayHandler

Sent when a guild's emojis have been updated.

IGuildEmojisUpdateShardedGatewayHandler

Sent when a guild's emojis have been updated.

IGuildIntegrationCreateGatewayHandler

Sent when an integration is created. The inner payload is an integration object with a set GuildId.

IGuildIntegrationCreateShardedGatewayHandler

Sent when an integration is created. The inner payload is an integration object with a set GuildId.

IGuildIntegrationDeleteGatewayHandler

Sent when an integration is deleted.

IGuildIntegrationDeleteShardedGatewayHandler

Sent when an integration is deleted.

IGuildIntegrationUpdateGatewayHandler

Sent when an integration is updated. The inner payload is an integration object with a set GuildId.

IGuildIntegrationUpdateShardedGatewayHandler

Sent when an integration is updated. The inner payload is an integration object with a set GuildId.

IGuildIntegrationsUpdateGatewayHandler

Sent when guild integrations are updated.

IGuildIntegrationsUpdateShardedGatewayHandler

Sent when guild integrations are updated.

IGuildJoinRequestDeleteGatewayHandler

Not documented by Discord.

IGuildJoinRequestDeleteShardedGatewayHandler

Not documented by Discord.

IGuildJoinRequestUpdateGatewayHandler

Not documented by Discord.

IGuildJoinRequestUpdateShardedGatewayHandler

Not documented by Discord.

IGuildScheduledEventCreateGatewayHandler

Sent when a guild scheduled event is created. The inner payload is a GuildScheduledEvent object.

IGuildScheduledEventCreateShardedGatewayHandler

Sent when a guild scheduled event is created. The inner payload is a GuildScheduledEvent object.

IGuildScheduledEventDeleteGatewayHandler

Sent when a guild scheduled event is deleted. The inner payload is a GuildScheduledEvent object.

IGuildScheduledEventDeleteShardedGatewayHandler

Sent when a guild scheduled event is deleted. The inner payload is a GuildScheduledEvent object.

IGuildScheduledEventUpdateGatewayHandler

Sent when a guild scheduled event is updated. The inner payload is a GuildScheduledEvent object.

IGuildScheduledEventUpdateShardedGatewayHandler

Sent when a guild scheduled event is updated. The inner payload is a GuildScheduledEvent object.

IGuildScheduledEventUserAddGatewayHandler

Sent when a user has subscribed to a guild scheduled event.

IGuildScheduledEventUserAddShardedGatewayHandler

Sent when a user has subscribed to a guild scheduled event.

IGuildScheduledEventUserRemoveGatewayHandler

Sent when a user has unsubscribed from a guild scheduled event.

IGuildScheduledEventUserRemoveShardedGatewayHandler

Sent when a user has unsubscribed from a guild scheduled event.

IGuildStickersUpdateGatewayHandler

Sent when a guild's stickers have been updated.

IGuildStickersUpdateShardedGatewayHandler

Sent when a guild's stickers have been updated.

IGuildThreadCreateGatewayHandler

Sent when a thread is created, relevant to the bot, or when the current user is added to a thread. The inner payload is an IGuildChannel object.

IGuildThreadCreateShardedGatewayHandler

Sent when a thread is created, relevant to the bot, or when the current user is added to a thread. The inner payload is an IGuildChannel object.

IGuildThreadDeleteGatewayHandler

Sent when a thread relevant to the bot is deleted. The inner payload is a subset of an IGuildChannel object.

IGuildThreadDeleteShardedGatewayHandler

Sent when a thread relevant to the bot is deleted. The inner payload is a subset of an IGuildChannel object.

IGuildThreadListSyncGatewayHandler

Sent when the current user gains access to a channel.

IGuildThreadListSyncShardedGatewayHandler

Sent when the current user gains access to a channel.

IGuildThreadUpdateGatewayHandler

Sent when a thread is updated. This is not sent with new messages, those are tracked by MessageCreate. The inner payload is an IGuildChannel object.

IGuildThreadUpdateShardedGatewayHandler

Sent when a thread is updated. This is not sent with new messages, those are tracked by MessageCreate. The inner payload is an IGuildChannel object.

IGuildThreadUserUpdateGatewayHandler

Sent when the GuildThreadUser object for the bot is updated. This event is largely just a signal that you are a member of the thread. The inner payload is a GuildThreadUserUpdateEventArgs object with a set GuildId.

IGuildThreadUserUpdateShardedGatewayHandler

Sent when the GuildThreadUser object for the bot is updated. This event is largely just a signal that you are a member of the thread. The inner payload is a GuildThreadUserUpdateEventArgs object with a set GuildId.

IGuildThreadUsersUpdateGatewayHandler

Sent when anyone is added to or removed from a thread.

IGuildThreadUsersUpdateShardedGatewayHandler

Sent when anyone is added to or removed from a thread.

IGuildUpdateGatewayHandler

Sent when a guild is updated. The inner payload is a Guild object.

IGuildUpdateShardedGatewayHandler

Sent when a guild is updated. The inner payload is a Guild object.

IGuildUserAddGatewayHandler

Sent when a new user joins a guild. The inner payload is a GuildUser object with an extra guild_id key.

IGuildUserAddShardedGatewayHandler

Sent when a new user joins a guild. The inner payload is a GuildUser object with an extra guild_id key.

IGuildUserChunkGatewayHandler

Sent in response to RequestGuildUsersAsync(GuildUsersRequestProperties, WebSocketPayloadProperties?, CancellationToken). You can use the ChunkIndex and ChunkCount to calculate how many chunks are left for your request.

IGuildUserChunkShardedGatewayHandler

Sent in response to RequestGuildUsersAsync(GuildUsersRequestProperties, WebSocketPayloadProperties?, CancellationToken). You can use the ChunkIndex and ChunkCount to calculate how many chunks are left for your request.

IGuildUserRemoveGatewayHandler

Sent when a user is removed from a guild (leave/kick/ban).

IGuildUserRemoveShardedGatewayHandler

Sent when a user is removed from a guild (leave/kick/ban).

IGuildUserUpdateGatewayHandler

Sent when a guild user is updated. This will also fire when the GuildUser object of a guild user changes.

IGuildUserUpdateShardedGatewayHandler

Sent when a guild user is updated. This will also fire when the GuildUser object of a guild user changes.

IInteractionCreateGatewayHandler

Sent when a user uses an interaction. Inner payload is an Interaction.

IInteractionCreateShardedGatewayHandler

Sent when a user uses an interaction. Inner payload is an Interaction.

IInviteCreateGatewayHandler

Sent when a new invite to a channel is created. Only sent if the bot has the ManageChannels permission for the relevant channel.

IInviteCreateShardedGatewayHandler

Sent when a new invite to a channel is created. Only sent if the bot has the ManageChannels permission for the relevant channel.

IInviteDeleteGatewayHandler

Sent when an invite is deleted. Only sent if the bot has the ManageChannels permission for the relevant channel.

IInviteDeleteShardedGatewayHandler

Sent when an invite is deleted. Only sent if the bot has the ManageChannels permission for the relevant channel.

ILatencyUpdateGatewayHandler
ILatencyUpdateShardedGatewayHandler
IMessageCreateGatewayHandler

Sent when a message is created. The inner payload is a message object with set GuildId, and Author fields.

IMessageCreateShardedGatewayHandler

Sent when a message is created. The inner payload is a message object with set GuildId, and Author fields.

IMessageDeleteBulkGatewayHandler

Sent when multiple messages are deleted at once.

IMessageDeleteBulkShardedGatewayHandler

Sent when multiple messages are deleted at once.

IMessageDeleteGatewayHandler

Sent when a message is deleted.

IMessageDeleteShardedGatewayHandler

Sent when a message is deleted.

IMessagePollVoteAddGatewayHandler
IMessagePollVoteAddShardedGatewayHandler
IMessagePollVoteRemoveGatewayHandler
IMessagePollVoteRemoveShardedGatewayHandler
IMessageReactionAddGatewayHandler

Sent when a user adds a reaction to a message.

IMessageReactionAddShardedGatewayHandler

Sent when a user adds a reaction to a message.

IMessageReactionRemoveAllGatewayHandler

Sent when a user explicitly removes all reactions from a message.

IMessageReactionRemoveAllShardedGatewayHandler

Sent when a user explicitly removes all reactions from a message.

IMessageReactionRemoveEmojiGatewayHandler

Sent when a user removes all instances of a given emoji from the reactions of a message.

IMessageReactionRemoveEmojiShardedGatewayHandler

Sent when a user removes all instances of a given emoji from the reactions of a message.

IMessageReactionRemoveGatewayHandler

Sent when a user removes a reaction from a message.

IMessageReactionRemoveShardedGatewayHandler

Sent when a user removes a reaction from a message.

IMessageUpdateGatewayHandler

Sent when a message is updated. The inner payload is a message object with set GuildId, and Author fields.

IMessageUpdateShardedGatewayHandler

Sent when a message is updated. The inner payload is a message object with set GuildId, and Author fields.

IPresenceUpdateGatewayHandler

Sent when a user's presence or info, such as their name or avatar, is updated. Requires the GuildPresences intent. The user object within this event can be partial, with the ID being the only required field, everything else is optional. Along with this limitation, no fields are required, and the types of the fields are not validated. You should expect any combination of fields and types within this event.

IPresenceUpdateShardedGatewayHandler

Sent when a user's presence or info, such as their name or avatar, is updated. Requires the GuildPresences intent. The user object within this event can be partial, with the ID being the only required field, everything else is optional. Along with this limitation, no fields are required, and the types of the fields are not validated. You should expect any combination of fields and types within this event.

IReadyGatewayHandler

The ready event is dispatched when a client has completed the initial handshake with the Gateway (for new sessions). The ready event contains all the state required for a client to begin interacting with the rest of the platform.

IReadyShardedGatewayHandler

The ready event is dispatched when a client has completed the initial handshake with the Gateway (for new sessions). The ready event contains all the state required for a client to begin interacting with the rest of the platform.

IResumeGatewayHandler
IResumeShardedGatewayHandler
IRoleCreateGatewayHandler

Sent when a guild role is created.

IRoleCreateShardedGatewayHandler

Sent when a guild role is created.

IRoleDeleteGatewayHandler

Sent when a guild role is deleted.

IRoleDeleteShardedGatewayHandler

Sent when a guild role is deleted.

IRoleUpdateGatewayHandler

Sent when a guild role is updated.

IRoleUpdateShardedGatewayHandler

Sent when a guild role is updated.

IShardedGatewayHandler
IStageInstanceCreateGatewayHandler

Sent when a StageInstance is created (i.e. the Stage is now 'live'). Inner payload is a StageInstance.

IStageInstanceCreateShardedGatewayHandler

Sent when a StageInstance is created (i.e. the Stage is now 'live'). Inner payload is a StageInstance.

IStageInstanceDeleteGatewayHandler

Sent when a StageInstance is deleted (i.e. the Stage has been closed). Inner payload is a StageInstance.

IStageInstanceDeleteShardedGatewayHandler

Sent when a StageInstance is deleted (i.e. the Stage has been closed). Inner payload is a StageInstance.

IStageInstanceUpdateGatewayHandler

Sent when a StageInstance is updated. Inner payload is a StageInstance.

IStageInstanceUpdateShardedGatewayHandler

Sent when a StageInstance is updated. Inner payload is a StageInstance.

ISubscriptionCreateGatewayHandler

Sent when a Subscription for a Premium App is created. Inner payload is a Subscription object.

ISubscriptionCreateShardedGatewayHandler

Sent when a Subscription for a Premium App is created. Inner payload is a Subscription object.

ISubscriptionDeleteGatewayHandler

Sent when a Subscription for a Premium App has been deleted. Inner payload is a Subscription object.

ISubscriptionDeleteShardedGatewayHandler

Sent when a Subscription for a Premium App has been deleted. Inner payload is a Subscription object.

ISubscriptionUpdateGatewayHandler

Sent when a subscription for a Premium App has been updated. Inner payload is a Subscription object.

ISubscriptionUpdateShardedGatewayHandler

Sent when a subscription for a Premium App has been updated. Inner payload is a Subscription object.

ITypingStartGatewayHandler

Sent when a user starts typing in a channel, and fires again every 10 seconds while they continue typing.

ITypingStartShardedGatewayHandler

Sent when a user starts typing in a channel, and fires again every 10 seconds while they continue typing.

IUnknownEventGatewayHandler

An unknown event.

IUnknownEventShardedGatewayHandler

An unknown event.

IVoiceChannelEffectSendGatewayHandler

Sent when someone sends an effect, such as an emoji reaction or a soundboard sound, in a voice channel the current user is connected to. Inner payload is a VoiceChannelEffectSendEventArgs object.

IVoiceChannelEffectSendShardedGatewayHandler

Sent when someone sends an effect, such as an emoji reaction or a soundboard sound, in a voice channel the current user is connected to. Inner payload is a VoiceChannelEffectSendEventArgs object.

IVoiceServerUpdateGatewayHandler

Sent when a guild's voice server is updated. This is sent when initially connecting to voice, and when the current voice instance fails over to a new server.

IVoiceServerUpdateShardedGatewayHandler

Sent when a guild's voice server is updated. This is sent when initially connecting to voice, and when the current voice instance fails over to a new server.

IVoiceStateUpdateGatewayHandler

Sent when someone joins/leaves/moves voice channels. Inner payload is a VoiceState object.

IVoiceStateUpdateShardedGatewayHandler

Sent when someone joins/leaves/moves voice channels. Inner payload is a VoiceState object.

IWebhooksUpdateGatewayHandler

Sent when a guild channel's webhook is created, updated, or deleted.

IWebhooksUpdateShardedGatewayHandler

Sent when a guild channel's webhook is created, updated, or deleted.