DiscordClient class

Constructors

DiscordClient(String _token, {List<Intent>? intents, ConnectionProperties connectionProperties = const ConnectionProperties(), int largeThreshold = 250, List<int> numShards = const [0, 1], bool guildSubscriptions = false})

Properties

appId ↔ String

late, final

application → ApplicationAPI

late, final

auditLog → AuditLogAPI

late, final

channel → ChannelAPI

late, final

clientIndex ↔ int

late, final

emoji → EmojiAPI

late, final

eventHandlers → Map<String, Future? Function(DiscordClient, dynamic)>

late, final, inherited

guilds → GuildsAPI

late, final

handlers → Map<int, dynamic Function(dynamic)>

late, final

hashCode → int

The hash code for this object.

no setter, inherited

interactions → InteractionsAPI

late, final

invite → InviteAPI

late, final

onApplicationCommandCreate ↔ Future Function(DiscordClient client, ApplicationCommand event)?

getter/setter pair, inherited

onApplicationCommandDelete ↔ Future Function(DiscordClient client, ApplicationCommand event)?

getter/setter pair, inherited

onApplicationCommandUpdate ↔ Future Function(DiscordClient client, ApplicationCommand event)?

getter/setter pair, inherited

onChannelCreate ↔ Future Function(DiscordClient client, Channel event)?

Handles CHANNEL_CREATE gateway events

getter/setter pair, inherited

onChannelDelete ↔ Future Function(DiscordClient client, Channel event)?

Handles CHANNEL_DELETE gateway events

getter/setter pair, inherited

onChannelPinsUpdate ↔ Future Function(DiscordClient client, ChannelPinsUpdateEvent event)?

Handles ON_CHANNEL_PINS_UPDATE gateway events

getter/setter pair, inherited

onChannelUpdate ↔ Future Function(DiscordClient client, Channel event)?

Handles CHANNEL_UPDATE gateway events

getter/setter pair, inherited

onEvent ↔ Future Function(DiscordClient client, String type, dynamic event)?

Gets called on any gateway event
Where type is a string with the event type and event a dictionary

getter/setter pair, inherited

onGuildBanAdd ↔ Future Function(DiscordClient client, GuildBanAddEvent event)?

getter/setter pair, inherited

onGuildBanRemove ↔ Future Function(DiscordClient client, GuildBanRemoveEvent event)?

getter/setter pair, inherited

onGuildCreate ↔ Future Function(DiscordClient client, Guild event)?

Handles GUILD_CREATE gateway events

getter/setter pair, inherited

onGuildDelete ↔ Future Function(DiscordClient client, Guild event)?

getter/setter pair, inherited

onGuildEmojiUpdate ↔ Future Function(DiscordClient client, GuildEmojiUpdateEvent event)?

getter/setter pair, inherited

onGuildIntegrationsUpdate ↔ Future Function(DiscordClient client, GuildIntegrationsUpdateEvent event)?

getter/setter pair, inherited

onGuildMemberAdd ↔ Future Function(DiscordClient client, Member event)?

getter/setter pair, inherited

onGuildMemberRemove ↔ Future Function(DiscordClient client, GuildMemberRemoveEvent event)?

getter/setter pair, inherited

onGuildMembersChunk ↔ Future Function(DiscordClient client, GuildMembersChunkEvent event)?

getter/setter pair, inherited

onGuildMemberUpdate ↔ Future Function(DiscordClient client, GuildMemberUpdateEvent event)?

getter/setter pair, inherited

onGuildRoleCreate ↔ Future Function(DiscordClient client, GuildRoleCreateEvent event)?

getter/setter pair, inherited

onGuildRoleDelete ↔ Future Function(DiscordClient client, GuildRoleDeleteEvent event)?

getter/setter pair, inherited

onGuildRoleUpdate ↔ Future Function(DiscordClient client, GuildRoleUpdateEvent event)?

getter/setter pair, inherited

onGuildUpdate ↔ Future Function(DiscordClient client, Guild event)?

getter/setter pair, inherited

onInteractionCreate ↔ Future Function(DiscordClient client, Interaction event)?

getter/setter pair, inherited

onInviteCreate ↔ Future Function(DiscordClient client, InviteCreateEvent event)?

getter/setter pair, inherited

onInviteDelete ↔ Future Function(DiscordClient client, InviteDeleteEvent event)?

getter/setter pair, inherited

onMessageCreate ↔ Future Function(DiscordClient client, Message event)?

Handles MESSAGE_CREATE gateway events

getter/setter pair, inherited

onMessageDelete ↔ Future Function(DiscordClient client, MessageDeleteEvent event)?

getter/setter pair, inherited

onMessageDeleteBulk ↔ Future Function(DiscordClient client, MessageDeleteBulkEvent event)?

getter/setter pair, inherited

onMessageReactionAdd ↔ Future Function(DiscordClient client, MessageReactionAddEvent event)?

getter/setter pair, inherited

onMessageReactionRemove ↔ Future Function(DiscordClient client, MessageReactionRemoveEvent event)?

getter/setter pair, inherited

onMessageReactionRemoveAll ↔ Future Function(DiscordClient client, MessageReactionRemoveAllEvent event)?

getter/setter pair, inherited

onMessageReactionRemoveEmoji ↔ Future Function(DiscordClient client, MessageReactionRemoveEmojiEvent event)?

getter/setter pair, inherited

onPresenceUpdate ↔ Future Function(DiscordClient client, PresenceUpdateEvent event)?

getter/setter pair, inherited

onReady ↔ Future Function(DiscordClient client, Ready event)?

Handles READY gateway events

getter/setter pair, inherited

onTypingStart ↔ Future Function(DiscordClient client, TypingStartEvent event)?

getter/setter pair, inherited

onUserUpdate ↔ Future Function(DiscordClient client, User event)?

getter/setter pair, inherited

onVoiceServerUpdate ↔ Future Function(DiscordClient client, VoiceServerUpdateEvent event)?

getter/setter pair, inherited

onVoiceStateUpdate ↔ Future Function(DiscordClient client, VoiceState event)?

getter/setter pair, inherited

onWebhookUpdate ↔ Future Function(DiscordClient client, WebhookUpdateEvent event)?

getter/setter pair, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

template → TemplateAPI

late, final

user → UserAPI

late, final

voice → VoiceAPI

late, final

webhook → WebhookAPI

late, final

Methods

close() → void

Call this method if you're not going to use this client anymore

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

run() → Future<BotGateway>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Properties

log → Logger

final

Constants

encoding → const String