case class ClientSettings(token: String, largeThreshold: Int = 50, shardNum: Int = 0, shardTotal: Int = 1, idleSince: Option[Instant] = None, activity: Option[RawActivity] = None, status: PresenceStatus = PresenceStatus.Online, afk: Boolean = false, guildSubscriptions: Boolean = true, compress: Compress = Compress.ZLibStreamCompress, intents: GatewayIntents = GatewayIntents.AllNonPrivileged, system: ActorSystem[Nothing] = ActorSystem(Behaviors.ignore, "AckCord"), requestSettings: RequestSettings = RequestSettings(), cacheSettings: CacheSettings = CacheSettings()) extends Product with Serializable
Settings used when connecting to Discord.
- token
The token for the bot.
- largeThreshold
The large threshold.
- shardNum
The shard index of this shard.
- shardTotal
The amount of shards.
- idleSince
If the bot has been idle, set the time since.
- activity
Send an activity when connecting.
- status
The status to use when connecting.
- afk
If the bot should be afk when connecting.
- guildSubscriptions
If Discord should sent events about user to your guilds.
- compress
What sort of compression the gateway should use.
- intents
Fine grained control over which events Discord should sent to your bot.
- system
The actor system to use.
- requestSettings
The request settings to use.
- cacheSettings
Settings the cache will use.
- Alphabetic
- By Inheritance
- ClientSettings
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ClientSettings(token: String, largeThreshold: Int = 50, shardNum: Int = 0, shardTotal: Int = 1, idleSince: Option[Instant] = None, activity: Option[RawActivity] = None, status: PresenceStatus = PresenceStatus.Online, afk: Boolean = false, guildSubscriptions: Boolean = true, compress: Compress = Compress.ZLibStreamCompress, intents: GatewayIntents = GatewayIntents.AllNonPrivileged, system: ActorSystem[Nothing] = ActorSystem(Behaviors.ignore, "AckCord"), requestSettings: RequestSettings = RequestSettings(), cacheSettings: CacheSettings = CacheSettings())
- token
The token for the bot.
- largeThreshold
The large threshold.
- shardNum
The shard index of this shard.
- shardTotal
The amount of shards.
- idleSince
If the bot has been idle, set the time since.
- activity
Send an activity when connecting.
- status
The status to use when connecting.
- afk
If the bot should be afk when connecting.
- guildSubscriptions
If Discord should sent events about user to your guilds.
- compress
What sort of compression the gateway should use.
- intents
Fine grained control over which events Discord should sent to your bot.
- system
The actor system to use.
- requestSettings
The request settings to use.
- cacheSettings
Settings the cache will use.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val activity: Option[RawActivity]
- val afk: Boolean
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val cacheSettings: CacheSettings
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- val compress: Compress
- def createClient(): Future[DiscordClient]
Create a DiscordClient from these settings.
- def createClientAutoShards(): Future[DiscordClient]
Create a DiscordClient from these settings while letting Discord set the shard amount.
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- implicit val executionContext: ExecutionContext
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- val gatewaySettings: GatewaySettings
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- val guildSubscriptions: Boolean
- val idleSince: Option[Instant]
- val intents: GatewayIntents
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val largeThreshold: Int
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val requestSettings: RequestSettings
- val shardNum: Int
- val shardTotal: Int
- val status: PresenceStatus
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val system: ActorSystem[Nothing]
- val token: String
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()