play.api.mvc

ActionBuilder

trait ActionBuilder[R[_]] extends AnyRef

Provides helpers for creating Action values.

Self Type
ActionBuilder[R]
Source
Action.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ActionBuilder
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def invokeBlock[A](request: Request[A], block: (R[A]) ⇒ Future[SimpleResult]): Future[SimpleResult]

    Invoke the block.

    Invoke the block. This is the main method that an ActionBuilder has to implement, at this stage it can wrap it in any other actions, modify the request object or potentially use a different class to represent the request.

    request

    The request

    block

    The block of code to invoke

    returns

    A future of the result

    Attributes
    protected

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

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

    Definition Classes
    Any
  6. final def apply(block: ⇒ Result): Action[AnyContent]

    Constructs an Action with default content, and no request parameter.

    Constructs an Action with default content, and no request parameter.

    For example:

    val hello = Action {
    Ok("Hello!")
    }
    block

    the action code

    returns

    an action

  7. final def apply(block: (R[AnyContent]) ⇒ Result): Action[AnyContent]

    Constructs an Action with default content.

    Constructs an Action with default content.

    For example:

    val echo = Action { request =>
    Ok("Got request [" + request + "]")
    }
    block

    the action code

    returns

    an action

  8. final def apply[A](bodyParser: BodyParser[A])(block: (R[A]) ⇒ Result): Action[A]

    Constructs an Action.

    Constructs an Action.

    For example:

    val echo = Action(parse.anyContent) { request =>
    Ok("Got request [" + request + "]")
    }
    A

    the type of the request body

    bodyParser

    the BodyParser to use to parse the request body

    block

    the action code

    returns

    an action

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. final def async[A](bodyParser: BodyParser[A])(block: (R[A]) ⇒ Future[SimpleResult]): Action[A]

    Constructs an Action that returns a future of a result, with default content.

    Constructs an Action that returns a future of a result, with default content.

    For example:

    val hello = Action.async { request =>
    WS.url(request.getQueryString("url").get).get().map { r =>
      if (r.status == 200) Ok("The website is up") else NotFound("The website is down")
    }
    }
    block

    the action code

    returns

    an action

  11. final def async(block: (R[AnyContent]) ⇒ Future[SimpleResult]): Action[AnyContent]

    Constructs an Action that returns a future of a result, with default content.

    Constructs an Action that returns a future of a result, with default content.

    For example:

    val hello = Action.async { request =>
    WS.url(request.getQueryString("url").get).get().map { r =>
      if (r.status == 200) Ok("The website is up") else NotFound("The website is down")
    }
    }
    block

    the action code

    returns

    an action

  12. final def async(block: ⇒ Future[SimpleResult]): Action[AnyContent]

    Constructs an Action that returns a future of a result, with default content, and no request parameter.

    Constructs an Action that returns a future of a result, with default content, and no request parameter.

    For example:

    val hello = Action.async {
    WS.url("http://www.playframework.com").get().map { r =>
      if (r.status == 200) Ok("The website is up") else NotFound("The website is down")
    }
    }
    block

    the action code

    returns

    an action

  13. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  14. def composeAction[A](action: Action[A]): Action[A]

    Compose the action with other actions.

    Compose the action with other actions. This allows mixing in of various actions together.

    action

    The action to compose

    returns

    The composed action

    Attributes
    protected
  15. def composeParser[A](bodyParser: BodyParser[A]): BodyParser[A]

    Compose the parser.

    Compose the parser. This allows the action builder to potentially intercept requests before they are parsed.

    bodyParser

    The body parser to compose

    returns

    The composed body parser

    Attributes
    protected
  16. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  18. def executionContext: ExecutionContext

    Get the execution context to run the request in.

    Get the execution context to run the request in. Override this if you want a custom execution context

    returns

    The execution context

    Attributes
    protected
  19. def finalize(): Unit

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

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

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

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

    Definition Classes
    AnyRef
  24. final def notify(): Unit

    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  27. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped