play.api

mvc

package mvc

Contains the Controller/Action/Result API to handle HTTP requests.

For example, a typical controller:

object Application extends Controller {

def index = Action {
  Ok("It works!")
}

}
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. mvc
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. trait AcceptExtractors extends AnyRef

    Define a set of extractors allowing to pattern match on the Accept HTTP header of a request

  2. case class Accepting(mimeType: String) extends Product with Serializable

    Convenient class to generate extractors checking if a given mime type matches the Accept header of a request.

  3. trait Action[A] extends EssentialAction

    An action is essentially a (Request[A] => Result) function that handles a request and generates a result to be sent to the client.

  4. trait ActionBuilder extends AnyRef

    Provides helpers for creating Action values.

  5. sealed trait AnyContent extends AnyRef

    A request body that adapts automatically according the request Content-Type.

  6. case class AnyContentAsFormUrlEncoded(data: Map[String, Seq[String]]) extends AnyContent with Product with Serializable

    AnyContent - Form url encoded body

  7. case class AnyContentAsJson(json: JsValue) extends AnyContent with Product with Serializable

    AnyContent - Json body

  8. case class AnyContentAsMultipartFormData(mdf: MultipartFormData[TemporaryFile]) extends AnyContent with Product with Serializable

    AnyContent - Multipart form data body

  9. case class AnyContentAsRaw(raw: RawBuffer) extends AnyContent with Product with Serializable

    AnyContent - Raw body (give access to the raw data as bytes).

  10. case class AnyContentAsText(txt: String) extends AnyContent with Product with Serializable

    AnyContent - Text body

  11. case class AnyContentAsXml(xml: NodeSeq) extends AnyContent with Product with Serializable

    AnyContent - XML body

  12. case class AsyncResult(result: Future[Result]) extends Result with WithHeaders[AsyncResult] with Product with Serializable

    An AsyncResult handles a Promise of result for cases where the result is not ready yet.

  13. trait BodyParser[+A] extends (RequestHeader) ⇒ Iteratee[Array[Byte], Either[Result, A]]

    A body parser parses the HTTP request body content.

  14. trait BodyParsers extends AnyRef

    Default body parsers.

  15. case class Call(method: String, url: String) extends mvc.Call with Product with Serializable

    Defines a Call, which describes an HTTP request and can be used to create links or fill redirect data.

  16. case class ChunkedResult[A](header: ResponseHeader, chunks: Function1[Iteratee[A, Unit], _])(implicit writeable: Writeable[A]) extends PlainResult with Product with Serializable

    A chunked result, which defines the response header and a chunks enumerator to send asynchronously to the client.

  17. case class Codec(charset: String)(encode: (String) ⇒ Array[Byte], decode: (Array[Byte]) ⇒ String) extends Product with Serializable

    A Codec handle the conversion of String to Byte arrays.

  18. trait Content extends AnyRef

    Generic type representing content to be sent over an HTTP response.

  19. trait Controller extends Results with BodyParsers with Status with HeaderNames with ContentTypes with RequestExtractors with Rendering

    Defines utility methods to generate Action and Results types.

  20. case class Cookie(name: String, value: String, maxAge: Option[Int] = scala.None, path: String = "/", domain: Option[String] = scala.None, secure: Boolean = false, httpOnly: Boolean = true) extends Product with Serializable

    An HTTP cookie.

  21. trait CookieBaker[T <: AnyRef] extends AnyRef

    Trait that should be extended by the Cookie helpers.

  22. trait Cookies extends AnyRef

    The HTTP cookies set.

  23. case class DiscardingCookie(name: String, path: String = "/", domain: Option[String] = scala.None, secure: Boolean = false) extends Product with Serializable

    A cookie to be discarded.

  24. trait EssentialAction extends (RequestHeader) ⇒ Iteratee[Array[Byte], Result] with Handler

  25. trait EssentialFilter extends AnyRef

    Implement this interface if you want to add a Filter to your application

  26. trait Filter extends EssentialFilter

  27. case class Flash(data: Map[String, String] = ...) extends Product with Serializable

    HTTP Flash scope.

  28. trait Handler extends AnyRef

    An Handler handles a request.

  29. class HandlerRef[T] extends mvc.HandlerRef

    Reference to an Handler.

  30. trait Headers extends AnyRef

    The HTTP headers set.

  31. trait JavascriptLitteral[A] extends AnyRef

    Transform a value to a Javascript literal.

  32. case class MaxSizeExceeded(length: Int) extends Product with Serializable

    Signal a max content size exceeded

  33. case class MultipartFormData[A](dataParts: Map[String, Seq[String]], files: Seq[FilePart[A]], badParts: Seq[BadPart], missingFileParts: Seq[MissingFilePart]) extends Product with Serializable

    Multipart form data body.

  34. trait PathBindable[A] extends AnyRef

    Binder for URL path parameters.

  35. trait PlainResult extends Result with WithHeaders[PlainResult]

    A plain HTTP result.

  36. trait QueryStringBindable[A] extends AnyRef

    Binder for query string parameters.

  37. case class RawBuffer(memoryThreshold: Int, initialData: Array[Byte] = ...) extends Product with Serializable

    Handle the request body a raw bytes data.

  38. trait Rendering extends AnyRef

  39. trait Request[+A] extends RequestHeader

    The complete HTTP request.

  40. trait RequestExtractors extends AcceptExtractors

  41. trait RequestHeader extends AnyRef

    The HTTP request header.

  42. trait RequestTaggingHandler extends Handler

    A handler that is able to tag requests

  43. trait Response extends AnyRef

    The HTTP response.

  44. case class ResponseHeader(status: Int, headers: Map[String, String] = ...) extends Product with Serializable

    A simple HTTP response header, used for standard responses.

  45. sealed trait Result extends NotNull with WithHeaders[Result]

    Any Action result.

  46. trait Results extends AnyRef

    Helper utilities to generate results.

  47. case class Session(data: Map[String, String] = ...) extends Product with Serializable

    HTTP Session.

  48. case class SimpleResult[A](header: ResponseHeader, body: Enumerator[A])(implicit writeable: Writeable[A]) extends PlainResult with Product with Serializable

    A simple result, which defines the response header and a body ready to send to the client.

  49. case class WebSocket[A](f: (RequestHeader) ⇒ (Enumerator[A], Iteratee[A, Unit]) ⇒ Unit)(implicit frameFormatter: FrameFormatter[A]) extends Handler with Product with Serializable

    A WebSocket handler.

  50. class WithFilters extends GlobalSettings

  51. sealed trait WithHeaders[+A <: Result] extends AnyRef

  52. class WrappedRequest[A] extends Request[A]

    Wrap an existing request.

Value Members

  1. object Action extends ActionBuilder

    Helper object to create Action values.

  2. object AnyContentAsEmpty extends AnyContent with Product with Serializable

    AnyContent - Empty request body

  3. object BodyParser

    Helper object to construct BodyParser values.

  4. object BodyParsers extends BodyParsers

    Defaults BodyParsers.

  5. object Codec extends Serializable

    Default Codec support.

  6. object Cookies

    Helper utilities to encode Cookies.

  7. object EssentialAction

  8. object Filter

  9. object FilterChain

    Compose the action and the Filters to create a new Action

  10. object Filters

    Compose the action and the Filters to create a new Action

  11. object Flash extends CookieBaker[Flash] with Serializable

    Helper utilities to manage the Flash cookie.

  12. object JavascriptLitteral

    Default JavaScript literals converters.

  13. object MultipartFormData extends Serializable

    Defines parts handled by Multipart form data.

  14. object PathBindable

    Default binders for URL path part.

  15. object PlainResult

    Helper utilities for Result values.

  16. object QueryStringBindable

    Default binders for Query String

  17. object Request

  18. object RequestHeader

  19. object Results extends Results

    Helper utilities to generate results.

  20. object Security

    Helpers to create secure actions.

  21. object Session extends CookieBaker[Session] with Serializable

    Helper utilities to manage the Session cookie.

  22. object Socket

    Alias types for Sockets

  23. object WebSocket extends Serializable

    Helper utilities to generate WebSocket results.

Inherited from AnyRef

Inherited from Any

Ungrouped