INyxxWebsocket class abstract

Implemented types

• INyxxRest

Constructors

INyxxWebsocket()

Properties

app → IClientOAuth2Application

The bot"s OAuth2 app.

no setter, inherited

appId → Snowflake

Id of bots application

no setter, inherited

cacheOptions → CacheOptions

Options for cache handling in nyxx

no setter, inherited

channels → SnowflakeCache<IChannel>

All of the channels the bot can see.

no setter, inherited

eventsRest → IRestEventController

Reference of event controller

no setter, inherited

eventsWs → IWebsocketEventController

Event controller for websocket events

no setter

guilds → SnowflakeCache<IGuild>

All of the guilds the bot is in. Can be empty or can miss guilds on (READY_EVENT).

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

httpEndpoints → IHttpEndpoints

Returns handler for all available REST API action.

no setter, inherited

httpHandler → HttpHandler

Reference to HttpHandler

no setter, 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.

no setter, inherited

inviteLink → String

Gets an bot invite link with zero permissions

no setter, inherited

onReady → Stream<IReadyEvent>

Emitted when client is ready

no setter, inherited

options → ClientOptions

Can be used to edit options after client initialised. Used by Nyxx.interactions to enable raw events

no setter, inherited

plugins → Iterable<BasePlugin>

no setter, inherited

ready → bool

True if client is ready.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

self → IClientUser

The current bot user.

no setter, inherited

shardManager → IShardManager

Current client"s shard

no setter

shards → int

Returns number of shards

no setter

startTime → DateTime

Datetime when bot has started

no setter, inherited

token → String

Token of instance

no setter, inherited

users → SnowflakeCache<IUser>

All of the users the bot can see. Does not have offline users without forceFetchUsers enabled.

no setter, inherited

version → String

The current version of nyxx

no setter, inherited

Methods

connect({bool propagateReady = true}) → Future<void>

inherited

dispose() → Future<void>

Perform cleanup

inherited

fetchChannel<T extends IChannel>(Snowflake channelId) → Future<T>

Returns channel with specified id.

fetchGuild(Snowflake guildId) → Future<IGuild>

Returns guild with given guildId

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