DiscordClient

Abstract Value Members

abstract def cache: Cache

The cache used by the client
abstract def commands: Commands[F]

The global commands object used by the client
The global commands object used by the client

Definition Classes
DiscordClient → CommandsHelper
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.
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.
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.
abstract def requests: RequestHelper

The requests object used by the client
The requests object used by the client

Definition Classes
DiscordClient → CommandsHelper
abstract def shards: Seq[ActorRef]

The shards of this client
abstract val sourceRequesterRunner: RequestRunner[SourceRequest, F]

A stream requester runner.

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
implicit val executionContext: ExecutionContextExecutor
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
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.
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.
def loadTrack(playerManager: AudioPlayerManager, identifier: String): Future[AudioItem]

Load a track using LavaPlayer.
def login(): Future[Done]

Login the shards of this client.
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.
val musicManager: ActorRef
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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
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
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
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
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
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.
var shardShutdownManager: ActorRef
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.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
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

Related Doc: package ackcord

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

Abstract Value Members

abstract def cache: Cache

abstract def commands: Commands[F]

abstract def newCommandsHelper(settings: CommandSettings[F]): (UniqueKillSwitch, CommandsHelper[F])

abstract def onEvent[G[_]](handler: (APIMessage) ⇒ G[Unit])(implicit streamable: Streamable[G]): (UniqueKillSwitch, Future[Done])

abstract def registerHandler[G[_], A <: APIMessage](handler: EventHandler[F, G, A])(implicit classTag: ClassTag[A], streamable: Streamable[G]): (UniqueKillSwitch, Future[Done])

abstract def requests: RequestHelper

abstract def shards: Seq[ActorRef]

abstract val sourceRequesterRunner: RequestRunner[SourceRequest, F]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

implicit val executionContext: ExecutionContextExecutor

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def joinChannel(guildId: GuildId, channelId: ChannelId, createPlayer: ⇒ AudioPlayer, force: Boolean = false, timeoutDur: FiniteDuration = 30.seconds): Future[AudioPlayer]

def leaveChannel(guildId: GuildId, destroyPlayer: Boolean = false): Unit

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

def login(): Future[Done]

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

val musicManager: ActorRef

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def onRawCmd[G[_]](handler: (RawCmd[F]) ⇒ G[Unit])(implicit streamable: Streamable[G]): (UniqueKillSwitch, Future[Done])

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])

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])

def registerHandler[G[_]](handler: RawCommandHandler[F, G])(implicit streamable: Streamable[G]): (UniqueKillSwitch, Future[Done])

def setPlaying(guildId: GuildId, playing: Boolean): Unit

var shardShutdownManager: ActorRef

def shutdown(timeout: FiniteDuration = 1.minute): Future[Terminated]

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withCache[G[_], ContainsCache](handler: (CacheSnapshot[F]) ⇒ (ContainsCache) ⇒ G[Unit])(implicit hasCache: HasCache[F, ContainsCache]): (ContainsCache) ⇒ G[Unit]

Inherited from CommandsHelper[F]

Inherited from AnyRef

Inherited from Any

Ungrouped