Nyxx class abstract
The base class for clients interacting with the Discord API.
- Implementers
Constructors
- Nyxx()
Properties
- apiOptions → ApiOptions
-
The options this client will use when connecting to the API.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- httpHandler → HttpHandler
-
The HttpHandler used by this client to make requests.
no setter
- logger → Logger
-
The logger for this client.
no setter
- options → ClientOptions
-
The options controlling the behavior of this client.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
close(
) → Future< void> - Close this client and any underlying resources.
-
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
Static Methods
-
connectGateway(
String token, Flags< GatewayIntents> intents, {GatewayClientOptions options = const GatewayClientOptions()}) → Future<NyxxGateway> -
Create an instance of
NyxxGatewaythat can perform requests to the HTTP API, connects to the gateway and is authenticated with a bot token. -
connectGatewayWithOptions(
GatewayApiOptions apiOptions, [GatewayClientOptions clientOptions = const GatewayClientOptions()]) → Future< NyxxGateway> -
Create an instance of
NyxxGatewayusing the provided options. -
connectOAuth2(
Credentials credentials, {RestClientOptions options = const RestClientOptions()}) → Future< NyxxOAuth2> -
Create an instance of
NyxxOAuth2that can perform requests to the HTTP API and is authenticated with OAuth2 Credentials. -
connectOAuth2WithOptions(
OAuth2ApiOptions apiOptions, [RestClientOptions clientOptions = const RestClientOptions()]) → Future< NyxxOAuth2> -
Create an instance of
NyxxOAuth2using the provided options. -
connectRest(
String token, {RestClientOptions options = const RestClientOptions()}) → Future< NyxxRest> -
Create an instance of
NyxxRestthat can perform requests to the HTTP API and is authenticated with a bot token. -
connectRestWithOptions(
RestApiOptions apiOptions, [RestClientOptions clientOptions = const RestClientOptions()]) → Future< NyxxRest> -
Create an instance of
NyxxRestusing the provided options.