Config class

What a host needs to give the engine before it can connect. Every field but the nick has a default, so a host deserialising one only has to supply what it actually cares about. An empty username or realname is filled in from the nick.

Constructors

Config({required String nick, String? username, String? realname, String? password, SaslCredentials? sasl, int? retention, List<String>? alt_nicks})
const
Config.fromJson(Map<String, dynamic> json)
factory

Properties

alt_nicks → List<String>?
Nicks to fall back through when the server says ours is taken during registration. Registration stalls forever if nobody answers a 433, so the engine walks this list and then starts appending underscores rather than leaving the connection hung.
final
hashCode → int
The hash code for this object.
no setterinherited
nick → String
The nick to register with.
final
password → String?
The server password, sent as PASS before anything else.
final
realname → String?
The realname sent in USER. Defaults to the nick.
final
retention → int?
How many messages each channel and conversation keeps.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sasl → SaslCredentials?
What to authenticate with, when the server offers sasl.
final
username → String?
The username sent in USER. Defaults to the nick.
final

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