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
no setter
- cacheOptions → CacheOptions
-
Options for cache handling in nyxx
no setter
- cdnHttpEndpoints → ICdnHttpEndpoints
-
Returns handler for all available CDN endpoints for Discord.
no setter
-
channels
→ SnowflakeCache<
IChannel> -
All of the channels the bot can see.
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
- hashCode → int
-
The hash code for this object.
no setterinherited
- httpEndpoints → IHttpEndpoints
-
Returns handler for all available REST API action.
no setter
- httpHandler → HttpHandler
-
Reference to HttpHandler
no setter
-
onReady
→ Stream<
IReadyEvent> -
Emitted when client is ready
no setter
- options → ClientOptions
-
Can be used to edit options after client initialised. Used by Nyxx.interactions to enable raw events
no setter
-
plugins
→ Iterable<
BasePlugin> -
no setterinherited
- ready → bool
-
True if client is ready.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- startTime → DateTime
-
Datetime when bot has started
no setter
- token → String
-
Token of instance
no setter
-
users
→ SnowflakeCache<
IUser> -
All of the users the bot can see. Does not have offline users
without
forceFetchUsersenabled.no setter
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