DiscordClientOption Enumeration Reference
DiscordClientOption
public enum DiscordClientOption : CustomStringConvertible, EquatableA enum representing a configuration option.
-
If passed this option, the client will not store presences on the guild.
Declaration
Swift
case discardPresences
-
This option causes the client to request all users for large guilds as soon as they are created.
Declaration
Swift
case fillLargeGuilds
-
If a presence comes in on a large guild, and we don’t have that user, setting this option will cause the client to query the API for that user.
Declaration
Swift
case fillUsers
-
The dispatch queue that events should be handled on. This is also the queue that properties should be read from.
Declaration
Swift
case handleQueue(DispatchQueue)
-
The log level for the logger.
Declaration
Swift
case log(DiscordLogLevel)
-
Used to set a custom logger.
Declaration
Swift
case logger(DiscordLogger)
-
If this option is given, the client will automatically unload users who go offline. This can save some memory. However this means that invsible users will also be pruned.
Declaration
Swift
case pruneUsers
-
A DiscordRateLimiter for this client. All REST calls will be put through this limiter.
Declaration
Swift
case rateLimiter(DiscordRateLimiterSpec)
-
Tells the client the number of shards to create. If not provided, one shard will be created.
Declaration
Swift
case shardingInfo(DiscordShardInformation)
-
The settings for voice engines. See
DiscordVoiceEngineConfigurationfor defaults.Declaration
Swift
case voiceConfiguration(DiscordVoiceEngineConfiguration)
-
Declaration
Swift
public var description: StringReturn Value
A description of this option
-
Compares two DiscordClientOption’s descriptions.
Declaration
Swift
public static func ==(lhs: DiscordClientOption, rhs: DiscordClientOption) -> BoolReturn Value
true if they are the same