Class/Object

net.katsstuff.ackcord

ClientSettings

Related Docs: object ClientSettings | package ackcord

Permalink

class ClientSettings extends GatewaySettings

Settings used when connecting to Discord.

Linear Supertypes
websocket.gateway.GatewaySettings, Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ClientSettings
  2. GatewaySettings
  3. Serializable
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. 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, system: ActorSystem = ActorSystem("AckCord"), commandSettings: AbstractCommandSettings[Id] = ..., requestSettings: RequestSettings = RequestSettings())

    Permalink

    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.

    system

    The actor system to use.

    commandSettings

    The command settings to use.

    requestSettings

    The request settings to use.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. val activity: Option[RawActivity]

    Permalink

    Send an activity when connecting.

    Send an activity when connecting.

    Definition Classes
    GatewaySettings

  5. val afk: Boolean

    Permalink

    If the bot should be afk when connecting.

    If the bot should be afk when connecting.

    Definition Classes
    GatewaySettings

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. val commandSettings: AbstractCommandSettings[Id]

    Permalink

    The command settings to use.

  9. def createClient(): Future[DiscordClient[Id]]

    Permalink

    Create a DiscordClient from these settings.

  10. def createClientAutoShards(): Future[DiscordClient[Id]]

    Permalink

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

  11. def createClientWithMaterializer()(implicit mat: ActorMaterializer): Future[DiscordClient[Id]]

    Permalink

    Create a DiscordClient from these settings and a custom materializer.

  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. implicit val executionContext: ExecutionContextExecutor

    Permalink

  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  15. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  16. val idleSince: Option[Instant]

    Permalink

    If the bot has been idle, set the time since.

    If the bot has been idle, set the time since.

    Definition Classes
    GatewaySettings

  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  18. val largeThreshold: Int

    Permalink

    The large threshold.

    The large threshold.

    Definition Classes
    GatewaySettings

  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. val requestSettings: RequestSettings

    Permalink

    The request settings to use.

  23. val shardNum: Int

    Permalink

    The shard index of this shard.

    The shard index of this shard.

    Definition Classes
    GatewaySettings

  24. val shardTotal: Int

    Permalink

    The amount of shards.

    The amount of shards.

    Definition Classes
    GatewaySettings

  25. val status: PresenceStatus

    Permalink

    The status to use when connecting.

    The status to use when connecting.

    Definition Classes
    GatewaySettings

  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  27. val system: ActorSystem

    Permalink

    The actor system to use.

  28. def toString(): String

    Permalink
    Definition Classes
    ClientSettings → GatewaySettings → AnyRef → Any

  29. val token: String

    Permalink

    The token for the bot.

    The token for the bot.

    Definition Classes
    GatewaySettings

  30. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  31. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  32. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from websocket.gateway.GatewaySettings

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped