CliIntegration class

A plugin that lets clients close their session gracefully when the process is terminated.

Inheritance

Constructors

CliIntegration()

Properties

clientType RuntimeType<Nyxx>
The type of client this plugin requires.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
logger Logger
A logger that can be used to log messages from this plugin.
no setterinherited
name String
The name of this plugin.
no setteroverride
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

afterClose() FutureOr<void>
Called after each client this plugin is added to closes.
inherited
afterConnect(Nyxx client) → void
Called after each client this plugin is added to connects.
override
beforeClose(Nyxx client) → void
Called before each client this plugin is added to closes.
override
beforeConnect(ApiOptions apiOptions, ClientOptions clientOptions) FutureOr<void>
Called before each client this plugin is added to connects.
inherited
createState() FutureOr<NyxxPluginState<Nyxx, NyxxPlugin<Nyxx>>>
Called to create the state for this plugin.
inherited
doClose(Nyxx client, Future<void> close()) Future<void>
Perform the close operation.
inherited
doConnect(ApiOptions apiOptions, ClientOptions clientOptions, Future<Nyxx> connect()) Future<Nyxx>
Perform the connection operation.
inherited
interceptGatewayMessages(Shard shard, Stream<GatewayMessage> messages) Stream<GatewayMessage>
Intercept GatewayMessages by transforming the messages stream.
inherited
interceptRequest(Nyxx client, HttpRequest request, Future<HttpResponse> next(HttpRequest)) Future<HttpResponse>
Called whenever a request is made using a client's HttpHandler.
inherited
interceptShardMessages(Shard shard, Stream<ShardMessage> messages) Stream<ShardMessage>
Intercept ShardMessages by transforming the messages stream.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

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