INyxxRest class abstract

Implemented types
Implementers

Constructors

INyxxRest()

Properties

app IClientOAuth2Application
The bot"s OAuth2 app.
read-only
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-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-only
Gets an bot invite link with zero permissions
read-only
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-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-only

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