INyxxWebsocket class abstract

Implemented types

Constructors

INyxxWebsocket()

Properties

app → IClientOAuth2Application
The bot"s OAuth2 app.
read-onlyinherited
appId → Snowflake
Id of bots application
read-onlyinherited
cacheOptions → CacheOptions
Options for cache handling in nyxx
read-onlyinherited
cdnHttpEndpoints → ICdnHttpEndpoints
Returns handler for all available CDN endpoints for Discord.
read-onlyinherited
channels → SnowflakeCache<IChannel>
All of the channels the bot can see.
read-onlyinherited
eventsRest → IRestEventController
Reference of event controller
read-onlyinherited
eventsWs → IWebsocketEventController
Event controller for websocket events
read-only
guilds → SnowflakeCache<IGuild>
All of the guilds the bot is in. Can be empty or can miss guilds on (READY_EVENT).
read-onlyinherited
hashCode → int
The hash code for this object.
read-onlyinherited
httpEndpoints → IHttpEndpoints
Returns handler for all available REST API action.
read-onlyinherited
httpHandler → HttpHandler
Reference to HttpHandler
read-onlyinherited
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-onlyinherited
Gets an bot invite link with zero permissions
read-onlyinherited
onReady → Stream<IReadyEvent>
Emitted when client is ready
read-onlyinherited
options → ClientOptions
Can be used to edit options after client initialised. Used by Nyxx.interactions to enable raw events
read-onlyinherited
plugins → Iterable<BasePlugin>
read-onlyinherited
ready → bool
True if client is ready.
read-onlyinherited
runtimeType → Type
A representation of the runtime type of the object.
read-onlyinherited
self → IClientUser
The current bot user.
read-onlyinherited
shardManager → IShardManager
Current client"s shard
read-only
shards → int
Returns number of shards
read-only
startTime → DateTime
Datetime when bot has started
read-onlyinherited
token → String
Token of instance
read-onlyinherited
users → SnowflakeCache<IUser>
All of the users the bot can see. Does not have offline users without forceFetchUsers enabled.
read-onlyinherited
version → String
The current version of nyxx
read-onlyinherited

Methods

connect({bool propagateReady = true}) → Future<void>
inherited
createGuild(GuildBuilder builder) → Future<IGuild>
Creates a guild.
dispose() → Future<void>
Perform cleanup
inherited
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 nonexistent method or property is accessed.
inherited
registerPlugin<T extends BasePlugin>(T pluginInstance) → void
inherited
setPresence(PresenceBuilder presenceBuilder) → void
Sets presence for bot.
toString() → String
A string representation of this object.
inherited

Operators

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