Trait/Object

ackcord.commands

CmdFilter

Related Docs: object CmdFilter | package commands

Permalink

trait CmdFilter extends AnyRef

A command filter is something used to limit the scope in which a command can be used. A few filters are defined here, but creating a custom one is easy.

Linear Supertypes
AnyRef, Any
Known Subclasses
InContext, InDM, InGuild, InOneGuild, NeedPermission, NonBot
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CmdFilter
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def errorMessage[F[_]](msg: Message)(implicit c: CacheSnapshot[F], F: Monad[F]): OptionT[F, String]

    Permalink

    If the message could not be executed, get an error message to give the user.

  2. abstract def isAllowed[F[_]](msg: Message)(implicit c: CacheSnapshot[F], F: Monad[F]): F[Boolean]

    Permalink

    Check if the message can be executed.

  3. abstract def isAllowed[F[_]](userId: UserId, guildId: GuildId)(implicit c: CacheSnapshot[F], F: Monad[F]): F[Boolean]

    Permalink

    Check if a command can be used by a user.

    Check if a command can be used by a user. While this is not used directly in AckCord, it can be used when implementing help commands and similar. If it's not possible to determine if the command can be used, then this method should be optimistic.

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. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  17. final def wait(): Unit

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped