INyxxWebsocket class Null safety

Implemented types




app IClientOAuth2Application
The bot"s OAuth2 app.
read-only, inherited
appId Snowflake
Id of bots application
read-only, inherited
cacheOptions CacheOptions
Options for cache handling in nyxx
read-only, inherited
channels SnowflakeCache<IChannel>
All of the channels the bot can see.
read-only, inherited
eventsRest IRestEventController
Reference of event controller
read-only, inherited
eventsWs IWebsocketEventController
Event controller for websocket events
guilds SnowflakeCache<IGuild>
All of the guilds the bot is in. Can be empty or can miss guilds on (READY_EVENT).
read-only, inherited
hashCode int
The hash code for this object.
read-only, inherited
httpEndpoints IHttpEndpoints
Returns handler for all available REST API action.
read-only, inherited
httpHandler → HttpHandler
Reference to HttpHandler
read-only, inherited
intents int
When identifying to the gateway, you have to specify an intents parameter which allows you to conditionally subscribe to pre-defined "intents", groups of events defined by Discord. If you do not specify a certain intent, you will not receive any of the gateway events that are batched into that group. Since api v8 its required upon connecting to gateway.
read-only, inherited
Gets an bot invite link with zero permissions
read-only, inherited
onReady Stream<IReadyEvent>
Emitted when client is ready
read-only, inherited
options ClientOptions
Can be used to edit options after client initialised. Used by Nyxx.interactions to enable raw events
read-only, inherited
plugins Iterable<BasePlugin>
read-only, inherited
ready bool
True if client is ready.
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
self IClientUser
The current bot user.
read-only, inherited
shardManager IShardManager
Current client"s shard
shards int
Returns number of shards
startTime DateTime
Datetime when bot has started
read-only, inherited
token String
Token of instance
read-only, inherited
users SnowflakeCache<IUser>
All of the users the bot can see. Does not have offline users without forceFetchUsers enabled.
read-only, inherited
version String
The current version of nyxx
read-only, inherited


connect({bool propagateReady = true}) Future<void>
createGuild(GuildBuilder builder) Future<IGuild>
Creates a guild.
dispose() Future<void>
Perform cleanup
fetchChannel<T extends IChannel>(Snowflake channelId) Future<T>
Returns channel with specified id.
fetchGuild(Snowflake guildId, {bool? withCounts = true}) Future<IGuild>
Returns guild with given guildId If withCounts is set to true, then guild will have IGuild.approximateMemberCount and IGuild.approximatePresenceCount present.
fetchGuildPreview(Snowflake guildId) Future<IGuildPreview>
This endpoint is only for public guilds if bot is not int the guild.
fetchUser(Snowflake userId) Future<IUser>
Get user instance with specified id.
fetchWebhook(Snowflake id, {String token = ""}) Future<IWebhook>
Gets a webhook by its id and/or token. If token is supplied authentication is not needed.
getInvite(String code) Future<IInvite>
Gets an Invite object with given code. If the code is in cache - it will be taken from it, otherwise API will be called.
getSticker(Snowflake id) Future<IStandardSticker>
Gets standard sticker with given id
joinThread(Snowflake channelId) Future<void>
Join ThreadChannel with given channelId
listNitroStickerPacks() Stream<IStickerPack>
List all nitro stickers packs
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
registerPlugin<T extends BasePlugin>(T pluginInstance) → void
setPresence(PresenceBuilder presenceBuilder) → void
Sets presence for bot.
toString() String
A string representation of this object.


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