trait ActionBuilder[+R[_], B] extends ActionFunction[Request, R]
Provides helpers for creating Action values.
- Self Type
- ActionBuilder[R, B]
- Source
- Action.scala
- Alphabetic
- By Inheritance
- ActionBuilder
- ActionFunction
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def invokeBlock[A](request: Request[A], block: (R[A]) => Future[Result]): Future[Result]
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
- Definition Classes
- ActionFunction
- abstract def parser: BodyParser[B]
- returns
The BodyParser to be used by this ActionBuilder if no other is specified
Concrete Value Members
- def andThen[Q[_]](other: ActionFunction[R, Q]): ActionBuilder[Q, B]
Compose this ActionFunction with another, with this one applied first.
Compose this ActionFunction with another, with this one applied first.
- other
ActionFunction with which to compose
- returns
The new ActionFunction
- Definition Classes
- ActionBuilder → ActionFunction
- 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
- final def apply(block: (R[B]) => Result): Action[B]
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
- final def apply[A](bodyParser: BodyParser[A]): ActionBuilder[R, A]
Constructs an ActionBuilder with the given BodyParser.
Constructs an ActionBuilder with the given BodyParser. The result can then be applied directly to a block.
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- returns
an action
- final def async[A](bodyParser: BodyParser[A])(block: (R[A]) => Future[Result]): Action[A]
Constructs an
Action
with the given BodyParser that returns a future of a result.Constructs an
Action
with the given BodyParser that returns a future of a result.For example:
val hello = Action.async(parse.anyContent) { 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
- final def async(block: (R[B]) => Future[Result]): Action[B]
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
- final def async(block: => Future[Result]): 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
- def compose[B](other: ActionBuilder[Request, B]): ActionBuilder[R, B]
- Definition Classes
- ActionFunction
- def compose[Q[_]](other: ActionFunction[Q, Request]): ActionFunction[Q, R]
Compose another ActionFunction with this one, with this one applied last.
Compose another ActionFunction with this one, with this one applied last.
- other
ActionFunction with which to compose
- returns
The new ActionFunction
- Definition Classes
- ActionFunction