c

ackcord

DiscordClientCore

class DiscordClientCore extends DiscordClient

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DiscordClientCore
  2. DiscordClient
  3. CommandsHelper
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new DiscordClientCore(cache: Cache, commands: Commands, requests: RequestHelper, actor: ActorRef[Command])

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val cache: Cache

    The cache used by the client

    The cache used by the client

    Definition Classes
    DiscordClientCoreDiscordClient
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. val commands: Commands

    The global commands object used by the client

    The global commands object used by the client

    Definition Classes
    DiscordClientCoreDiscordClientCommandsHelper
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. implicit val executionContext: ExecutionContextExecutor
    Definition Classes
    DiscordClient
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. def joinChannel(guildId: GuildId, channelId: ChannelId, createPlayer: => AudioPlayer, force: Boolean = false, timeoutDur: FiniteDuration = 30.seconds): Future[AudioPlayer]

    Join a voice channel.

    Join a voice channel.

    guildId

    The guildId of the voice channel.

    channelId

    The channelId of the voice channel.

    createPlayer

    A named argument to create a player if one doesn't already exist.

    force

    The the join should be force even if already connected to somewhere else (move channel).

    timeoutDur

    The timeout duration before giving up,

    returns

    A future containing the used player.

    Definition Classes
    DiscordClient
  16. def leaveChannel(guildId: GuildId, destroyPlayer: Boolean = false): Unit

    Leave a voice channel.

    Leave a voice channel.

    guildId

    The guildId to leave the voice channel in.

    destroyPlayer

    If the player used for this guild should be destroyed.

    Definition Classes
    DiscordClient
  17. def loadTrack(playerManager: AudioPlayerManager, identifier: String): Future[AudioItem]

    Load a track using LavaPlayer.

    Load a track using LavaPlayer.

    Definition Classes
    DiscordClient
  18. def login(): Unit

    Login the shards of this client.

    Login the shards of this client. Note that this method just sends the login signal. It does not block until a response is received.

    Definition Classes
    DiscordClientCoreDiscordClient
  19. def logout(timeout: FiniteDuration): Future[Boolean]

    Logout the shards of this client

    Logout the shards of this client

    timeout

    The amount of time to wait before forcing logout.

    Definition Classes
    DiscordClientCoreDiscordClient
  20. def musicManager: Future[ActorRef[Command]]
    Definition Classes
    DiscordClientCoreDiscordClient
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def newCommandsHelper(settings: CommandSettings): (UniqueKillSwitch, CommandsHelper)

    Creates a new commands object to handle commands if the global settings are unfitting.

    Creates a new commands object to handle commands if the global settings are unfitting.

    settings

    The settings to use for the commands object

    returns

    A killswitch to stop this command helper, together with the command helper.

    Definition Classes
    DiscordClientCoreDiscordClient
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. def onEvent[G[_]](handler: (APIMessage) => G[Unit])(implicit streamable: Streamable[G]): (UniqueKillSwitch, Future[Done])

    Runs a partial function whenever APIMessages are received.

    Runs a partial function whenever APIMessages are received.

    If you use IntelliJ you might have to specify the execution type. (Normally Id or SourceRequest)

    G

    The execution type

    handler

    The handler function

    streamable

    A way to convert your execution type to a stream.

    returns

    A kill switch to cancel this listener, and a future representing when it's done.

    Definition Classes
    DiscordClientCoreDiscordClient
  26. def onRawCmd[G[_]](handler: (RawCmd) => G[Unit])(implicit streamable: Streamable[G]): (UniqueKillSwitch, Future[Done])

    Runs a partial function whenever a raw command object is received.

    Runs a partial function whenever a raw command object is received.

    If you use IntelliJ you might have to specify the execution type. (Normally Id or SourceRequest)

    G

    The execution type

    handler

    The handler function.

    streamable

    A way to convert your execution type to a stream.

    returns

    A kill switch to cancel this listener, and a future representing when it's done.

    Definition Classes
    CommandsHelper
  27. def registerCmd[A, G[_]](refiner: CmdRefiner, description: Option[CmdDescription])(handler: (ParsedCmd[A]) => G[Unit])(implicit arg0: MessageParser[A], streamable: Streamable[G]): (UniqueKillSwitch, Future[Done])

    Register a command which runs some code.

    Register a command which runs some code.

    G

    The execution type

    handler

    The handler function.

    streamable

    A way to convert your execution type to a stream.

    returns

    A kill switch to cancel this listener, and a future representing when it's done.

    Definition Classes
    CommandsHelper
  28. def registerCmd[A, G[_]](prefix: String, aliases: Seq[String], filters: Seq[CmdFilter] = Nil, description: Option[CmdDescription] = None)(handler: (ParsedCmd[A]) => G[Unit])(implicit arg0: MessageParser[A], streamable: Streamable[G]): (UniqueKillSwitch, Future[Done])

    Register a command which runs some code.

    Register a command which runs some code.

    G

    The execution type

    handler

    The handler function.

    streamable

    A way to convert your execution type to a stream.

    returns

    A kill switch to cancel this listener, and a future representing when it's done.

    Definition Classes
    CommandsHelper
  29. def registerHandler[G[_], A <: APIMessage](handler: EventHandler[G, A])(implicit classTag: ClassTag[A], streamable: Streamable[G]): (UniqueKillSwitch, Future[Done])

    Registers an EventHandler that will be called when an event happens.

    Registers an EventHandler that will be called when an event happens.

    returns

    A kill switch to cancel this listener, and a future representing when it's done.

    Definition Classes
    DiscordClientCoreDiscordClient
  30. def registerHandler[G[_], A](handler: CommandHandler[G, A])(implicit arg0: MessageParser[A], streamableG: Streamable[G]): (UniqueKillSwitch, Future[Done])

    Registers an CommandHandler that will be called when that command is used.

    Registers an CommandHandler that will be called when that command is used.

    returns

    A kill switch to cancel this listener, and a future representing when it's done.

    Definition Classes
    CommandsHelper
  31. def registerHandler[G[_]](handler: RawCommandHandler[G])(implicit streamable: Streamable[G]): (UniqueKillSwitch, Future[Done])

    Registers an CommandHandler that will be called when that command is used.

    Registers an CommandHandler that will be called when that command is used.

    returns

    A kill switch to cancel this listener, and a future representing when it's done.

    Definition Classes
    CommandsHelper
  32. val requests: RequestHelper

    The requests object used by the client

    The requests object used by the client

    Definition Classes
    DiscordClientCoreDiscordClientCommandsHelper
  33. def setPlaying(guildId: GuildId, playing: Boolean): Unit

    Set a bot as speaking/playing in a channel.

    Set a bot as speaking/playing in a channel. This is required before sending any sound.

    Definition Classes
    DiscordClient
  34. def shards: Future[Seq[ActorRef[Command]]]

    The shards of this client

    The shards of this client

    Definition Classes
    DiscordClientCoreDiscordClient
  35. def shutdownAckCord(timeout: FiniteDuration = 1.minute): Future[Unit]

    Logs out the shards of this client, and then shuts down the actor system.

    Logs out the shards of this client, and then shuts down the actor system.

    timeout

    The amount of time to wait for logout to succeed before forcing shutdown.

    Definition Classes
    DiscordClient
  36. def shutdownJVM(timeout: FiniteDuration): Future[Unit]

    Logs out the shards of this client, and then shuts down the JVM.

    Logs out the shards of this client, and then shuts down the JVM.

    timeout

    The amount of time to wait for logout to succeed before forcing shutdown.

    Definition Classes
    DiscordClientCoreDiscordClient
  37. val sourceRequesterRunner: RequestRunner[[α$0$]Source[α$0$, NotUsed]]

    A stream requester runner.

    A stream requester runner.

    Definition Classes
    DiscordClientCoreDiscordClient
  38. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  39. def toString(): String
    Definition Classes
    AnyRef → Any
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  41. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  42. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  43. def withCache[G[_], ContainsCache](handler: (CacheSnapshot) => (ContainsCache) => G[Unit])(implicit hasCache: HasCache[ContainsCache]): (ContainsCache) => G[Unit]

    An utility function to extract a CacheSnapshot from a type in a function.

    An utility function to extract a CacheSnapshot from a type in a function.

    G

    The execution type

    ContainsCache

    The type of the value that contains the cache.

    handler

    The handler function with a cache parameter.

    hasCache

    A typeclass allowing you to extract the cache.

    returns

    A handler function

    Definition Classes
    DiscordClient

Inherited from DiscordClient

Inherited from CommandsHelper

Inherited from AnyRef

Inherited from Any

Ungrouped