NyxxGateway class

A client that can make requests to the HTTP API, connects to the Gateway and is authenticated with a bot token.

Implemented types

Properties

apiOptions → GatewayApiOptions
The options this client will use when connecting to the API.
final
application → PartialApplication
The application associated with this client.
no setteroverride
applications → ApplicationManager
An ApplicationManager that manages applications for this client.
no setterinherited
channels → ChannelManager
A ChannelManager that manages channels for this client.
no setterinherited
commands → GlobalApplicationCommandManager
A GlobalApplicationCommandManager that manages global application commands.
no setterinherited
gateway ↔ Gateway
The Gateway used by this client to send and receive Gateway events.
latefinal
guilds → GuildManager
A GuildManager that manages guilds for this client.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
httpHandler → HttpHandler
The HttpHandler used by this client to make requests.
latefinal
interactions → InteractionManager
no setterinherited
invites → InviteManager
An InviteManager that manages invites for this client.
no setterinherited
logger → Logger
The logger for this client.
no setteroverride
onApplicationCommandAutocompleteInteraction → Stream<InteractionCreateEvent<ApplicationCommandAutocompleteInteraction>>
A Stream of ApplicationCommandAutocompleteInteractions received by this client.
no setterinherited
onApplicationCommandInteraction → Stream<InteractionCreateEvent<ApplicationCommandInteraction>>
A Stream of ApplicationCommandInteractions received by this client.
no setterinherited
onApplicationCommandPermissionsUpdate → Stream<ApplicationCommandPermissionsUpdateEvent>
A Stream of ApplicationCommandPermissionsUpdateEvents received by this client.
no setterinherited
onAutoModerationActionExecution → Stream<AutoModerationActionExecutionEvent>
A Stream of AutoModerationActionExecutionEvents received by this client.
no setterinherited
onAutoModerationRuleCreate → Stream<AutoModerationRuleCreateEvent>
A Stream of AutoModerationRuleCreateEvents received by this client.
no setterinherited
onAutoModerationRuleDelete → Stream<AutoModerationRuleDeleteEvent>
A Stream of AutoModerationRuleDeleteEvents received by this client.
no setterinherited
onAutoModerationRuleUpdate → Stream<AutoModerationRuleUpdateEvent>
A Stream of AutoModerationRuleUpdateEvents received by this client.
no setterinherited
onChannelCreate → Stream<ChannelCreateEvent>
A Stream of ChannelCreateEvents received by this client.
no setterinherited
onChannelDelete → Stream<ChannelDeleteEvent>
A Stream of ChannelDeleteEvents received by this client.
no setterinherited
onChannelPinsUpdate → Stream<ChannelPinsUpdateEvent>
A Stream of ChannelPinsUpdateEvents received by this client.
no setterinherited
onChannelUpdate → Stream<ChannelUpdateEvent>
A Stream of ChannelUpdateEvents received by this client.
no setterinherited
onEntitlementCreate → Stream<EntitlementCreateEvent>
A Stream of EntitlementCreateEvents received by this client.
no setterinherited
onEntitlementDelete → Stream<EntitlementDeleteEvent>
A Stream of EntitlementDeleteEvents received by this client.
no setterinherited
onEntitlementUpdate → Stream<EntitlementUpdateEvent>
A Stream of EntitlementUpdateEvents received by this client.
no setterinherited
onEvent → Stream<DispatchEvent>
A Stream of gateway dispatch events received by this client.
no setterinherited
onGuildAuditLogCreate → Stream<GuildAuditLogCreateEvent>
A Stream of GuildAuditLogCreateEvents received by this client.
no setterinherited
onGuildBanAdd → Stream<GuildBanAddEvent>
A Stream of GuildBanAddEvents received by this client.
no setterinherited
onGuildBanRemove → Stream<GuildBanRemoveEvent>
A Stream of GuildBanRemoveEvents received by this client.
no setterinherited
onGuildCreate → Stream<UnavailableGuildCreateEvent>
A Stream of UnavailableGuildCreateEvents received by this client.
no setterinherited
onGuildDelete → Stream<GuildDeleteEvent>
A Stream of GuildDeleteEvents received by this client.
no setterinherited
onGuildEmojisUpdate → Stream<GuildEmojisUpdateEvent>
A Stream of GuildEmojisUpdateEvents received by this client.
no setterinherited
onGuildIntegrationsUpdate → Stream<GuildIntegrationsUpdateEvent>
A Stream of GuildIntegrationsUpdateEvents received by this client.
no setterinherited
onGuildMemberAdd → Stream<GuildMemberAddEvent>
A Stream of GuildMemberAddEvents received by this client.
no setterinherited
onGuildMemberRemove → Stream<GuildMemberRemoveEvent>
A Stream of GuildMemberRemoveEvents received by this client.
no setterinherited
onGuildMembersChunk → Stream<GuildMembersChunkEvent>
A Stream of GuildMembersChunkEvents received by this client.
no setterinherited
onGuildMemberUpdate → Stream<GuildMemberUpdateEvent>
A Stream of GuildMemberUpdateEvents received by this client.
no setterinherited
onGuildRoleCreate → Stream<GuildRoleCreateEvent>
A Stream of GuildRoleCreateEvents received by this client.
no setterinherited
onGuildRoleDelete → Stream<GuildRoleDeleteEvent>
A Stream of GuildRoleDeleteEvents received by this client.
no setterinherited
onGuildRoleUpdate → Stream<GuildRoleUpdateEvent>
A Stream of GuildRoleUpdateEvents received by this client.
no setterinherited
onGuildScheduledEventCreate → Stream<GuildScheduledEventCreateEvent>
A Stream of GuildScheduledEventCreateEvents received by this client.
no setterinherited
onGuildScheduledEventDelete → Stream<GuildScheduledEventDeleteEvent>
A Stream of GuildScheduledEventDeleteEvents received by this client.
no setterinherited
onGuildScheduledEventUpdate → Stream<GuildScheduledEventUpdateEvent>
A Stream of GuildScheduledEventUpdateEvents received by this client.
no setterinherited
onGuildScheduledEventUserAdd → Stream<GuildScheduledEventUserAddEvent>
A Stream of GuildScheduledEventUserAddEvents received by this client.
no setterinherited
onGuildScheduledEventUserRemove → Stream<GuildScheduledEventUserRemoveEvent>
A Stream of GuildScheduledEventUserRemoveEvents received by this client.
no setterinherited
onGuildStickersUpdate → Stream<GuildStickersUpdateEvent>
A Stream of GuildStickersUpdateEvents received by this client.
no setterinherited
onGuildUpdate → Stream<GuildUpdateEvent>
A Stream of GuildUpdateEvents received by this client.
no setterinherited
onIntegrationCreate → Stream<IntegrationCreateEvent>
A Stream of IntegrationCreateEvents received by this client.
no setterinherited
onIntegrationDelete → Stream<IntegrationDeleteEvent>
A Stream of IntegrationDeleteEvents received by this client.
no setterinherited
onIntegrationUpdate → Stream<IntegrationUpdateEvent>
A Stream of IntegrationUpdateEvents received by this client.
no setterinherited
onInteractionCreate → Stream<InteractionCreateEvent<Interaction>>
A Stream of InteractionCreateEvents received by this client.
no setterinherited
onInviteCreate → Stream<InviteCreateEvent>
A Stream of InviteCreateEvents received by this client.
no setterinherited
onInviteDelete → Stream<InviteDeleteEvent>
A Stream of InviteDeleteEvents received by this client.
no setterinherited
onMessageBulkDelete → Stream<MessageBulkDeleteEvent>
A Stream of MessageBulkDeleteEvents received by this client.
no setterinherited
onMessageComponentInteraction → Stream<InteractionCreateEvent<MessageComponentInteraction>>
A Stream of MessageComponentInteractions received by this client.
no setterinherited
onMessageCreate → Stream<MessageCreateEvent>
A Stream of MessageCreateEvents received by this client.
no setterinherited
onMessageDelete → Stream<MessageDeleteEvent>
A Stream of MessageDeleteEvents received by this client.
no setterinherited
onMessageReactionAdd → Stream<MessageReactionAddEvent>
A Stream of MessageReactionAddEvents received by this client.
no setterinherited
onMessageReactionRemove → Stream<MessageReactionRemoveEvent>
A Stream of MessageReactionRemoveEvents received by this client.
no setterinherited
onMessageReactionRemoveAll → Stream<MessageReactionRemoveAllEvent>
A Stream of MessageReactionRemoveAllEvents received by this client.
no setterinherited
onMessageReactionRemoveEmoji → Stream<MessageReactionRemoveEmojiEvent>
A Stream of MessageReactionRemoveEmojiEvents received by this client.
no setterinherited
onMessageUpdate → Stream<MessageUpdateEvent>
A Stream of MessageUpdateEvents received by this client.
no setterinherited
onModalSubmitInteraction → Stream<InteractionCreateEvent<ModalSubmitInteraction>>
A Stream of ModalSubmitInteractions received by this client.
no setterinherited
onPingInteraction → Stream<InteractionCreateEvent<PingInteraction>>
A Stream of PingInteractions received by this client.
no setterinherited
onPresenceUpdate → Stream<PresenceUpdateEvent>
A Stream of PresenceUpdateEvents received by this client.
no setterinherited
onReady → Stream<ReadyEvent>
A Stream of ReadyEvents received by this client.
no setterinherited
onResumed → Stream<ResumedEvent>
A Stream of ResumedEvents received by this client.
no setterinherited
onStageInstanceCreate → Stream<StageInstanceCreateEvent>
A Stream of StageInstanceCreateEvents received by this client.
no setterinherited
onStageInstanceDelete → Stream<StageInstanceDeleteEvent>
A Stream of StageInstanceDeleteEvents received by this client.
no setterinherited
onStageInstanceUpdate → Stream<StageInstanceUpdateEvent>
A Stream of StageInstanceUpdateEvents received by this client.
no setterinherited
onThreadCreate → Stream<ThreadCreateEvent>
A Stream of ThreadCreateEvents received by this client.
no setterinherited
onThreadDelete → Stream<ThreadDeleteEvent>
A Stream of ThreadDeleteEvents received by this client.
no setterinherited
onThreadListSync → Stream<ThreadListSyncEvent>
A Stream of ThreadListSyncEvents received by this client.
no setterinherited
onThreadMembersUpdate → Stream<ThreadMembersUpdateEvent>
A Stream of ThreadMembersUpdateEvents received by this client.
no setterinherited
onThreadMemberUpdate → Stream<ThreadMemberUpdateEvent>
A Stream of ThreadMemberUpdateEvents received by this client.
no setterinherited
onThreadUpdate → Stream<ThreadUpdateEvent>
A Stream of ThreadUpdateEvents received by this client.
no setterinherited
onTypingStart → Stream<TypingStartEvent>
A Stream of TypingStartEvents received by this client.
no setterinherited
onUnknownEvent → Stream<UnknownDispatchEvent>
A Stream of DispatchEvents which are unknown to the current version of nyxx.
no setterinherited
onUserUpdate → Stream<UserUpdateEvent>
A Stream of UserUpdateEvents received by this client.
no setterinherited
onVoiceServerUpdate → Stream<VoiceServerUpdateEvent>
A Stream of VoiceServerUpdateEvents received by this client.
no setterinherited
onVoiceStateUpdate → Stream<VoiceStateUpdateEvent>
A Stream of VoiceStateUpdateEvents received by this client.
no setterinherited
onWebhooksUpdate → Stream<WebhooksUpdateEvent>
A Stream of WebhooksUpdateEvents received by this client.
no setterinherited
options → GatewayClientOptions
The options controlling the behavior of this client.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stickers → GlobalStickerManager
A GlobalStickerManager that manages global stickers.
no setterinherited
user → PartialUser
The user associated with this client.
no setteroverride
users → UserManager
A UserManager that manages users for this client.
no setterinherited
voice → VoiceManager
A VoiceManager that manages voice states for this client.
no setterinherited
webhooks → WebhookManager
A WebhookManager that manages webhooks for this client.
no setterinherited

Methods

close() → Future<void>
Close this client and any underlying resources.
override
joinThread(Snowflake id) → Future<void>
Add the current user to the thread with the ID id.
override
leaveThread(Snowflake id) → Future<void>
Remove the current user from the thread with the ID id.
override
listGuilds({Snowflake? before, Snowflake? after, int? limit}) → Future<List<UserGuild>>
List the guilds the current user is a member of.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
on<T extends DispatchEvent>(void onData(T event)) → StreamSubscription<T>
A helper function to listen to events of a specific type.
inherited
toString() → String
A string representation of this object.
inherited
updatePresence(PresenceBuilder builder) → void
Update the client's presence on all shards.
updateVoiceState(Snowflake guildId, GatewayVoiceStateBuilder builder) → void
Update the client's voice state in the guild with the ID guildId.

Operators

operator ==(Object other) → bool
The equality operator.
inherited