INyxxRest class abstract

Implemented types
Implementers

Constructors

INyxxRest()

Properties

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

Methods

connect({bool propagateReady = true}) → Future<void>
inherited
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