INyxx class abstract

Generic interface for Nyxx. Represents basic functionality of Nyxx that are always available.

Implemented types
Implementers

Constructors

INyxx()

Properties

appId Snowflake
Id of bots application
read-only
cacheOptions CacheOptions
Options for cache handling in nyxx
read-only
cdnHttpEndpoints ICdnHttpEndpoints
Returns handler for all available CDN endpoints for Discord.
read-only
channels SnowflakeCache<IChannel>
All of the channels the bot can see.
read-only
guilds SnowflakeCache<IGuild>
All of the guilds the bot is in. Can be empty or can miss guilds on (READY_EVENT).
read-only
hashCode int
The hash code for this object.
read-onlyinherited
httpEndpoints IHttpEndpoints
Returns handler for all available REST API action.
read-only
httpHandler → HttpHandler
Reference to HttpHandler
read-only
onReady Stream<IReadyEvent>
Emitted when client is ready
read-only
options ClientOptions
Can be used to edit options after client initialised. Used by Nyxx.interactions to enable raw events
read-only
plugins Iterable<BasePlugin>
read-onlyinherited
ready bool
True if client is ready.
read-only
runtimeType Type
A representation of the runtime type of the object.
read-onlyinherited
startTime DateTime
Datetime when bot has started
read-only
token String
Token of instance
read-only
users SnowflakeCache<IUser>
All of the users the bot can see. Does not have offline users without forceFetchUsers enabled.
read-only

Methods

connect({bool propagateReady = true}) Future<void>
dispose() Future<void>
Perform cleanup
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerPlugin<T extends BasePlugin>(T pluginInstance) → void
inherited
toString() String
A string representation of this object.
inherited

Operators

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