c

ackcord

ClientSettings

case class ClientSettings(token: String, largeThreshold: Int = 50, shardNum: Int = 0, shardTotal: Int = 1, idleSince: Option[Instant] = None, activities: Option[Seq[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.

activities

Send one or more activities 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.

Source
ClientSettings.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ClientSettings
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ClientSettings(token: String, largeThreshold: Int = 50, shardNum: Int = 0, shardTotal: Int = 1, idleSince: Option[Instant] = None, activities: Option[Seq[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.

    activities

    Send one or more activities 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

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val activities: Option[Seq[RawActivity]]
  5. val afk: Boolean
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val cacheSettings: CacheSettings
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  9. val compress: Compress
  10. def createClient(): Future[DiscordClient]

    Create a DiscordClient from these settings.

  11. def createClientAutoShards(): Future[DiscordClient]

    Create a DiscordClient from these settings while letting Discord set the shard amount.

  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. implicit val executionContext: ExecutionContext
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. val gatewaySettings: GatewaySettings
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. val guildSubscriptions: Boolean
  18. val idleSince: Option[Instant]
  19. val intents: GatewayIntents
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. val largeThreshold: Int
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. def productElementNames: Iterator[String]
    Definition Classes
    Product
  26. val requestSettings: RequestSettings
  27. val shardNum: Int
  28. val shardTotal: Int
  29. val status: PresenceStatus
  30. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  31. val system: ActorSystem[Nothing]
  32. val token: String
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped