c

ackcord

ClientSettings

case class ClientSettings(token: String, largeThreshold: Int = 50, shardNum: Int = 0, shardTotal: Int = 1, idleSince: Option[Instant] = None, activities: Seq[RawActivity] = Nil, status: PresenceStatus = PresenceStatus.Online, afk: Boolean = false, compress: Compress = Compress.ZLibStreamCompress, eventDecoders: EventDecoders = GatewayProtocol.ackcordEventDecoders, 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.

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: Seq[RawActivity] = Nil, status: PresenceStatus = PresenceStatus.Online, afk: Boolean = false, compress: Compress = Compress.ZLibStreamCompress, eventDecoders: EventDecoders = GatewayProtocol.ackcordEventDecoders, 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.

    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. val activities: Seq[RawActivity]
  2. val afk: Boolean
  3. val cacheSettings: CacheSettings
  4. val compress: Compress
  5. def createClient(): Future[DiscordClient]

    Create a DiscordClient from these settings.

  6. def createClientAutoShards(): Future[DiscordClient]

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

  7. val eventDecoders: EventDecoders
  8. implicit val executionContext: ExecutionContext
  9. val gatewaySettings: GatewaySettings
  10. val idleSince: Option[Instant]
  11. val intents: GatewayIntents
  12. val largeThreshold: Int
  13. def productElementNames: Iterator[String]
    Definition Classes
    Product
  14. val requestSettings: RequestSettings
  15. val shardNum: Int
  16. val shardTotal: Int
  17. val status: PresenceStatus
  18. val system: ActorSystem[Nothing]
  19. val token: String