NodeOptions class
Class containing all node options needed to establish and mantain a connection with lavalink server
Constructors
- NodeOptions({String host = "localhost", int port = 2333, bool ssl = false, String password = "youshallnotpass", int shards = 1, int maxConnectAttempts = 5, Duration delayBetweenReconnections = const Duration(seconds: 5), String clientName = "nyxx_lavalink"})
- Constructor to build a new node builder
-
NodeOptions.fromJson(Map<
String, dynamic> json)
Properties
- clientId ↔ Snowflake
-
Client id
latefinal
- clientName ↔ String
-
latefinal
- delayBetweenReconnections ↔ Duration
-
How much time should the node wait before trying to reconnect
to lavalink server again
latefinal
- hashCode → int
-
The hash code for this object.
read-onlyinherited
- host ↔ String
-
Host where lavalink is running
latefinal
- maxConnectAttempts ↔ int
-
Max connect attempts before shutting down a node
latefinal
- nodeId ↔ int
-
Node id, you must not set this yourself
latefinal
- password ↔ String
-
Password to connect to the server
latefinal
- port ↔ int
-
Port used by lavalink rest & socket
latefinal
- runtimeType → Type
-
A representation of the runtime type of the object.
read-onlyinherited
-
Shards the bot is operating on
latefinal
- ssl ↔ bool
-
Whether to use a tls connection or not
latefinal
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited