t

net.katsstuff.ackcord

DiscordClient

trait DiscordClient[F[_]] extends CommandsHelper[F]

Trait used to interface with Discord stuff from high level.

Source
client.scala
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DiscordClient
  2. CommandsHelper
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def cache: Cache

    The cache used by the client

  2. abstract def commands: Commands[F]

    The global commands object used by the client

    The global commands object used by the client

    Definition Classes
    DiscordClientCommandsHelper
  3. abstract def newCommandsHelper(settings: CommandSettings[F]): (UniqueKillSwitch, CommandsHelper[F])

    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.

  4. abstract 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.

  5. abstract def registerHandler[G[_], A <: APIMessage](handler: EventHandler[F, 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.

  6. abstract def requests: RequestHelper

    The requests object used by the client

    The requests object used by the client

    Definition Classes
    DiscordClientCommandsHelper
  7. abstract def shards: Seq[ActorRef]

    The shards of this client

  8. abstract val sourceRequesterRunner: RequestRunner[SourceRequest, F]

    A stream requester runner.

  9. abstract def onEventDSLC(handler: (CacheSnapshot[F]) ⇒ PartialFunction[APIMessage, RequestDSL[Unit]]): (UniqueKillSwitch, Future[Done])

    Run a RequestDSL with a CacheSnapshot when an event happens.

    Run a RequestDSL with a CacheSnapshot when an event happens.

    returns

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

    Annotations
    @deprecated
    Deprecated

    (Since version 0.11) Use the handlers or the new onEvent instead

Concrete 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. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. implicit val executionContext: ExecutionContextExecutor
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. 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.

  14. 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.

  15. def loadTrack(playerManager: AudioPlayerManager, identifier: String): Future[AudioItem]

    Load a track using LavaPlayer.

  16. def login(): Future[Done]

    Login the shards of this client.

  17. def logout(timeout: FiniteDuration = 1.minute): Future[Boolean]

    Logout the shards of this client

    Logout the shards of this client

    timeout

    The amount of time to wait before forcing logout.

  18. val musicManager: ActorRef
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. def onRawCmd[G[_]](handler: (RawCmd[F]) ⇒ 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
  23. def registerCmd[A, G[_]](refiner: CmdRefiner[F], description: Option[CmdDescription])(handler: (ParsedCmd[F, A]) ⇒ G[Unit])(implicit arg0: MessageParser[A], F: Monad[F], streamableF: Streamable[F], 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
  24. def registerCmd[A, G[_]](prefix: String, aliases: Seq[String], filters: Seq[CmdFilter] = Nil, description: Option[CmdDescription] = None)(handler: (ParsedCmd[F, A]) ⇒ G[Unit])(implicit arg0: MessageParser[A], F: Monad[F], streamableF: Streamable[F], 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
  25. def registerHandler[G[_], A](handler: CommandHandler[F, G, A])(implicit arg0: MessageParser[A], streamableG: Streamable[G], F: Monad[F], streamableF: Streamable[F]): (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
  26. def registerHandler[G[_]](handler: RawCommandHandler[F, 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
  27. 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.

  28. val shardShutdownManager: ActorRef
  29. def shutdown(timeout: FiniteDuration = 1.minute): Future[Terminated]

    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 before forcing shutdown.

  30. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  35. def withCache[G[_], ContainsCache](handler: (CacheSnapshot[F]) ⇒ (ContainsCache) ⇒ G[Unit])(implicit hasCache: HasCache[F, 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

Deprecated Value Members

  1. def onEventC(handler: (CacheSnapshot[F]) ⇒ PartialFunction[APIMessage, Unit]): (UniqueKillSwitch, Future[Done])

    Run some code with a CacheSnapshot when an event happens.

    Run some code with a CacheSnapshot when an event happens.

    returns

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

    Annotations
    @deprecated
    Deprecated

    (Since version 0.11) Use the handlers or the new onEvent instead

  2. def onEventDSL(handler: PartialFunction[APIMessage, RequestDSL[Unit]]): (UniqueKillSwitch, Future[Done])

    Run a RequestDSL when an event happens.

    Run a RequestDSL when an event happens.

    returns

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

    Annotations
    @deprecated
    Deprecated

    (Since version 0.11) Use the handlers or the new onEvent instead

  3. def onRawCommand(handler: PartialFunction[RawCmd[F], Unit]): (UniqueKillSwitch, Future[Done])

    Run some code when raw command arrives.

    Run some code when raw command arrives.

    returns

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

    Definition Classes
    CommandsHelper
    Annotations
    @deprecated
    Deprecated

    (Since version 0.11) Use the handlers or the new onRawCmd instead

  4. def onRawCommandC(handler: (CacheSnapshot[F]) ⇒ PartialFunction[RawCmd[F], Unit]): (UniqueKillSwitch, Future[Done])

    Run some code with a CacheSnapshot when raw command arrives.

    Run some code with a CacheSnapshot when raw command arrives.

    returns

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

    Definition Classes
    CommandsHelper
    Annotations
    @deprecated
    Deprecated

    (Since version 0.11) Use the handlers or the new onRawCmd instead

  5. def onRawCommandDSL(handler: PartialFunction[RawCmd[F], RequestDSL[Unit]]): (UniqueKillSwitch, Future[Done])

    Run a RequestDSL when raw command arrives.

    Run a RequestDSL when raw command arrives.

    returns

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

    Definition Classes
    CommandsHelper
    Annotations
    @deprecated
    Deprecated

    (Since version 0.11) Use the handlers or the new onRawCmd instead

  6. def onRawCommandDSLC(handler: (CacheSnapshot[F]) ⇒ PartialFunction[RawCmd[F], RequestDSL[Unit]]): (UniqueKillSwitch, Future[Done])

    Run a RequestDSL with a CacheSnapshot when raw command arrives.

    Run a RequestDSL with a CacheSnapshot when raw command arrives.

    returns

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

    Definition Classes
    CommandsHelper
    Annotations
    @deprecated
    Deprecated

    (Since version 0.11) Use the handlers or the new onRawCmd instead

  7. def registerCommand[A](category: CmdCategory, aliases: Seq[String], filters: Seq[CmdFilter] = Nil, description: Option[CmdDescription] = None)(handler: (ParsedCmd[F, A]) ⇒ Unit)(implicit arg0: MessageParser[A], F: Monad[F], streamable: Streamable[F]): (UniqueKillSwitch, Future[Done])

    Register a command which runs some code.

    Register a command which runs some code.

    returns

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

    Definition Classes
    CommandsHelper
    Annotations
    @deprecated
    Deprecated

    (Since version 0.11) Use the handlers the new registerCmd instead

  8. def registerCommandC[A](category: CmdCategory, aliases: Seq[String], filters: Seq[CmdFilter] = Nil, description: Option[CmdDescription] = None)(handler: (CacheSnapshot[F]) ⇒ (ParsedCmd[F, A]) ⇒ Unit)(implicit arg0: MessageParser[A], F: Monad[F], streamable: Streamable[F]): (UniqueKillSwitch, Future[Done])

    Register a command which runs some code with a CacheSnapshot.

    Register a command which runs some code with a CacheSnapshot.

    returns

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

    Definition Classes
    CommandsHelper
    Annotations
    @deprecated
    Deprecated

    (Since version 0.11) Use the handlers the new registerCmd instead

  9. def registerCommandDSL[A](category: CmdCategory, aliases: Seq[String], filters: Seq[CmdFilter] = Nil, description: Option[CmdDescription] = None)(handler: (ParsedCmd[F, A]) ⇒ RequestDSL[Unit])(implicit arg0: MessageParser[A], F: Monad[F], streamable: Streamable[F]): (UniqueKillSwitch, Future[Done])

    Register a command which runs a RequestDSL.

    Register a command which runs a RequestDSL.

    returns

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

    Definition Classes
    CommandsHelper
    Annotations
    @deprecated
    Deprecated

    (Since version 0.11) Use the handlers the new registerCmd instead

  10. def registerCommandDSLC[A](category: CmdCategory, aliases: Seq[String], filters: Seq[CmdFilter] = Nil, description: Option[CmdDescription] = None)(handler: (CacheSnapshot[F]) ⇒ (ParsedCmd[F, A]) ⇒ RequestDSL[Unit])(implicit arg0: MessageParser[A], F: Monad[F], streamable: Streamable[F]): (UniqueKillSwitch, Future[Done])

    Register a command which runs a RequestDSL with a CacheSnapshot.

    Register a command which runs a RequestDSL with a CacheSnapshot.

    returns

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

    Definition Classes
    CommandsHelper
    Annotations
    @deprecated
    Deprecated

    (Since version 0.11) Use the handlers or the new registerCmd instead

  11. def registerHandler[A <: APIMessage](handler: EventHandlerDSL[A])(implicit classTag: ClassTag[A], F: Monad[F], streamable: Streamable[F]): (UniqueKillSwitch, Future[Done])

    Registers an EventHandlerDSL that will be run when an event happens.

    Registers an EventHandlerDSL that will be run when an event happens.

    returns

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

    Annotations
    @deprecated
    Deprecated

    (Since version 0.11) RequestDSL is deprecated. Use the handlers instead

  12. def registerHandler[A](handler: CommandHandlerDSL[A])(implicit arg0: MessageParser[A], F: Monad[F], streamable: Streamable[F]): (UniqueKillSwitch, Future[Done])

    Registers an CommandHandlerDSL that will be run when that command is used.

    Registers an CommandHandlerDSL that will be run when that command is used.

    returns

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

    Definition Classes
    CommandsHelper
    Annotations
    @deprecated
    Deprecated

    (Since version 0.11) Use the handlers the new registerCmd instead

  13. def runDSL[A](dsl: RequestDSL[A]): Future[A]

    Runs a RequestDSL once, and returns the result.

    Runs a RequestDSL once, and returns the result.

    Annotations
    @deprecated
    Deprecated

    (Since version 0.11) Use requesterRunner instead

  14. def runDSL(source: Source[RequestDSL[Unit], NotUsed]): (UniqueKillSwitch, Future[Done])
    Attributes
    protected
    Annotations
    @deprecated
    Deprecated

    (Since version 0.11) RequestDSL is deprecated

Inherited from CommandsHelper[F]

Inherited from AnyRef

Inherited from Any

Ungrouped