ClientOptions class

Optional client settings which can be used when creating new instance of client. It allows to tune up client to your needs.

Constructors

ClientOptions({AllowedMentions? allowedMentions, int? shardCount, int messageCacheSize = 100, int largeThreshold = 50, bool compressedGatewayPayloads = true, bool guildSubscriptions = true, PresenceBuilder? initialPresence, ShutdownHook? shutdownHook, ShutdownShardHook? shutdownShardHook, bool dispatchRawShardEvent = false}): Makes a new ClientOptions object.

allowedMentions ↔ AllowedMentions?: Whether or not to disable @everyone and @here mentions at a global level. It means client won't send any of these. It doesn't mean filtering guild messages.
getter/setter pair
compressedGatewayPayloads ↔ bool: Allows to receive compressed payloads from gateway
getter/setter pair
dispatchRawShardEvent ↔ bool: Allows to enable receiving raw gateway event
getter/setter pair
guildSubscriptions ↔ bool: Enables dispatching of guild subscription events (presence and typing events)
getter/setter pair
hashCode → int: The hash code for this object.
no setterinherited
initialPresence ↔ PresenceBuilder?: Initial bot presence
getter/setter pair
largeThreshold ↔ int: Maximum size of guild for which offline member will be sent
getter/setter pair
messageCacheSize ↔ int: The number of messages to cache for each channel.
getter/setter pair
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
shardCount ↔ int?: The total number of shards.
getter/setter pair
shutdownHook ↔ ShutdownHook?: Hook executed when disposing bots process.
getter/setter pair
shutdownShardHook ↔ ShutdownShardHook?: Hook executed when shard is disposing.
getter/setter pair

noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toString() → String: A string representation of this object.
inherited