Class

ackcord.commands

CmdInfo

Related Doc: package commands

Permalink

case class CmdInfo[F[_]](prefix: String, aliases: Seq[String], filters: Seq[CmdFilter] = Seq.empty, filterBehavior: FilterBehavior = FilterBehavior.SendAll)(implicit evidence$2: Monad[F]) extends AbstractCmdInfo[F] with Product with Serializable

A CmdRefiner that can be used when the prefix, aliases, and filters for a command are known in advance.

prefix

The prefix to use for the command.

aliases

The aliases to use for the command.

filters

The filters to use for the command.

Linear Supertypes
Serializable, Serializable, Product, Equals, AbstractCmdInfo[F], CmdRefiner[F], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CmdInfo
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AbstractCmdInfo
  7. CmdRefiner
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CmdInfo(prefix: String, aliases: Seq[String], filters: Seq[CmdFilter] = Seq.empty, filterBehavior: FilterBehavior = FilterBehavior.SendAll)(implicit arg0: Monad[F])

    Permalink

    prefix

    The prefix to use for the command.

    aliases

    The aliases to use for the command.

    filters

    The filters to use for the command.

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. def aliases(message: Message)(implicit c: CacheSnapshot[F]): F[Seq[String]]

    Permalink

    Get the valid aliases for the given message.

    Get the valid aliases for the given message.

    Definition Classes
    CmdInfo → AbstractCmdInfo

  5. val aliases: Seq[String]

    Permalink

    The aliases to use for the command.

  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. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  9. def filterBehavior(message: Message)(implicit c: CacheSnapshot[F]): F[FilterBehavior]

    Permalink
    Definition Classes
    CmdInfo → AbstractCmdInfo

  10. val filterBehavior: FilterBehavior

    Permalink

  11. def filters(message: Message)(implicit c: CacheSnapshot[F]): F[Seq[CmdFilter]]

    Permalink

    Get the filters to use for the given message.

    Get the filters to use for the given message.

    Definition Classes
    CmdInfo → AbstractCmdInfo

  12. val filters: Seq[CmdFilter]

    Permalink

    The filters to use for the command.

  13. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  19. def prefix(message: Message)(implicit c: CacheSnapshot[F]): F[String]

    Permalink

    Get the prefix to use for the given message.

    Get the prefix to use for the given message.

    Definition Classes
    CmdInfo → AbstractCmdInfo

  20. val prefix: String

    Permalink

    The prefix to use for the command.

  21. def refine(raw: RawCmd[F]): EitherT[F, Option[CmdMessage[F] with CmdError[F]], Cmd[F]]

    Permalink

    Refines the raw command object to a command object if a command should run, if it should not return, an error object may be returned instead.

    Refines the raw command object to a command object if a command should run, if it should not return, an error object may be returned instead.

    raw

    The raw command object.

    Definition Classes
    AbstractCmdInfo → CmdRefiner

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

    Permalink
    Definition Classes
    AnyRef

  23. final def wait(): Unit

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

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

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

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

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AbstractCmdInfo[F]

Inherited from CmdRefiner[F]

Inherited from AnyRef

Inherited from Any

Ungrouped