Trait

net.katsstuff.ackcord

CommandsHelper

Related Doc: package ackcord

Permalink

trait CommandsHelper[F[_]] extends AnyRef

An object which manages a net.katsstuff.ackcord.commands.Commands instance.

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

Abstract Value Members

  1. abstract def commands: Commands[F]

    Permalink

    The commands object specific to this command helper.

  2. abstract def requests: RequestHelper

    Permalink

    The request helper to use when sending messages from this command helper.

Concrete 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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

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

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. def onRawCmd[G[_]](handler: (RawCmd[F]) ⇒ G[Unit])(implicit streamable: Streamable[G]): (UniqueKillSwitch, Future[Done])

    Permalink

    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.

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

    Permalink

    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.

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

    Permalink

    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.

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

    Permalink

    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.

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

    Permalink

    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.

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

    Permalink
    Definition Classes
    AnyRef
  21. def toString(): String

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped