c

ackcord.commands

NamedDescribedCommandBuilder

case class NamedDescribedCommandBuilder[+M[_], A](requests: requests.Requests, defaultMustMention: Boolean, defaultMentionOrPrefix: Boolean, prefixParser: StructuredPrefixParser, description: CommandDescription, parser: MessageParser[A], actionFunction: ActionFunction[CommandMessage, M, CommandError]) extends ActionBuilder[CommandMessage, M, CommandError, A] with Product with Serializable

A CommandFunction from a command message to an output. Used for creating commands.

M

The command message type used by the command.

A

The argument type of this command builder.

defaultMustMention

Set the default value for must mention when creating a named command.

defaultMentionOrPrefix

Set the default value for mention or prefix when creating a named command.

prefixParser

The prefix parser to use for commands created from this builder.

description

The description to use for commands created from this builder.

parser

The parser used for parsing the arguments this command takes.

Source
commandBuilder.scala
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NamedDescribedCommandBuilder
  2. Serializable
  3. Product
  4. Equals
  5. ActionBuilder
  6. ActionFunction
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new NamedDescribedCommandBuilder(builder: NamedCommandBuilder[M, A], description: CommandDescription)
  2. new NamedDescribedCommandBuilder(requests: requests.Requests, defaultMustMention: Boolean, defaultMentionOrPrefix: Boolean, prefixParser: StructuredPrefixParser, description: CommandDescription, parser: MessageParser[A], actionFunction: ActionFunction[CommandMessage, M, CommandError])

    defaultMustMention

    Set the default value for must mention when creating a named command.

    defaultMentionOrPrefix

    Set the default value for mention or prefix when creating a named command.

    prefixParser

    The prefix parser to use for commands created from this builder.

    description

    The description to use for commands created from this builder.

    parser

    The parser used for parsing the arguments this command takes.

Type Members

  1. type Action[B, Mat] = NamedDescribedComplexCommand[B, Mat]

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. val actionFunction: ActionFunction[CommandMessage, M, CommandError]
  5. def andThen[M2[_]](f: CommandFunction[M, M2]): NamedDescribedCommandBuilder[M2, A]

    Chains first this function, and then another one.

    Chains first this function, and then another one.

    Definition Classes
    NamedDescribedCommandBuilderActionFunction
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def async(block: (M[A]) => Future[Unit]): Action[A, NotUsed]

    Creates an action that results in an async result

    Creates an action that results in an async result

    block

    The execution of the action.

    Definition Classes
    ActionBuilder
  8. def asyncOpt(block: (M[A]) => OptFuture[Unit]): Action[A, NotUsed]

    Creates an action that results in an partial async result

    Creates an action that results in an partial async result

    block

    The execution of the action.

    Definition Classes
    ActionBuilder
  9. def asyncOptRequest[G[_]](block: (M[A]) => OptFuture[Request[Any]]): Action[A, NotUsed]

    Creates an async action that might do a single request

    Creates an async action that might do a single request

    G

    The streamable result type.

    block

    The execution of the action.

    Definition Classes
    ActionBuilder
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  11. val defaultMentionOrPrefix: Boolean
  12. val defaultMustMention: Boolean
  13. val description: CommandDescription
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  16. def flow[C]: Flow[CommandMessage[C], Either[Option[CommandError], M[C]], NotUsed]

    A flow that represents this mapping.

    A flow that represents this mapping.

    Definition Classes
    NamedDescribedCommandBuilderActionFunction
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  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. val parser: MessageParser[A]
  23. def parsing[B](implicit newParser: MessageParser[B]): NamedDescribedCommandBuilder[M, B]

    Creates a new command builder parsing a specific type.

    Creates a new command builder parsing a specific type.

    B

    The type to parse

  24. val prefixParser: StructuredPrefixParser
  25. def productElementNames: Iterator[String]
    Definition Classes
    Product
  26. val requests: requests.Requests

    A request helper that belongs to this builder.

    A request helper that belongs to this builder.

    Definition Classes
    NamedDescribedCommandBuilderActionBuilder
  27. def streamed[G[_]](block: (M[A]) => G[Unit])(implicit streamable: util.Streamable[G]): Action[A, NotUsed]

    Creates an action that results in some streamable type G

    Creates an action that results in some streamable type G

    G

    The streamable result type.

    block

    The execution of the action.

    Definition Classes
    ActionBuilder
  28. def streamedOptRequest[G[_]](block: (M[A]) => OptionT[G, Request[Any]])(implicit streamable: util.Streamable[G]): Action[A, NotUsed]

    Creates an action that might do a single request, wrapped in an effect type G

    Creates an action that might do a single request, wrapped in an effect type G

    G

    The streamable result type.

    block

    The execution of the action.

    Definition Classes
    ActionBuilder
  29. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  30. def toSink[Mat](sinkBlock: Sink[M[A], Mat]): NamedDescribedComplexCommand[A, Mat]

    Creates an action from a sink.

    Creates an action from a sink.

    Mat

    The materialized result of running this action.

    sinkBlock

    The sink that will process this action.

    Definition Classes
    NamedDescribedCommandBuilderActionBuilder
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  34. def withRequest(block: (M[A]) => Request[Any]): Action[A, NotUsed]

    Creates an action that will do a single request

    Creates an action that will do a single request

    block

    The execution of the action.

    Definition Classes
    ActionBuilder
  35. def withRequestOpt(block: (M[A]) => Option[Request[Any]]): Action[A, NotUsed]

    Creates an action that might do a single request

    Creates an action that might do a single request

    block

    The execution of the action.

    Definition Classes
    ActionBuilder
  36. def withSideEffects(block: (M[A]) => Unit): Action[A, NotUsed]

    Creates an action that might execute unknown side effects.

    Creates an action that might execute unknown side effects.

    block

    The execution of the action.

    Definition Classes
    ActionBuilder

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped