BaseControllerHelpers

abstract def controllerComponents: ControllerComponents

The components needed to use the controller methods

final def !=(arg0: Any): Boolean

final def ##(): Int

object &

Convenient extractor allowing to apply two extractors.

request match {
  case Accepts.Json() & Accepts.Html() => "This request accepts both JSON and HTML"
}

final def ==(arg0: Any): Boolean

val ACCEPT: String

val ACCEPTED: Int

val ACCEPT_CHARSET: String

val ACCEPT_ENCODING: String

val ACCEPT_LANGUAGE: String

val ACCEPT_RANGES: String

val ACCESS_CONTROL_ALLOW_CREDENTIALS: String

val ACCESS_CONTROL_ALLOW_HEADERS: String

val ACCESS_CONTROL_ALLOW_METHODS: String

val ACCESS_CONTROL_ALLOW_ORIGIN: String

val ACCESS_CONTROL_EXPOSE_HEADERS: String

val ACCESS_CONTROL_MAX_AGE: String

val ACCESS_CONTROL_REQUEST_HEADERS: String

val ACCESS_CONTROL_REQUEST_METHOD: String

val AGE: String

val ALLOW: String

val AUTHORIZATION: String

val Accepted: Status

Generates a ‘202 ACCEPTED’ result.

object Accepts

Common extractors to check if a request accepts JSON, Html, etc.

request match {
  case Accepts.Json() => Ok(toJson(value))
  case _ => Ok(views.html.show(value))
}

val BAD_GATEWAY: Int

val BAD_REQUEST: Int

val BINARY: String

Content-Type of binary data.

val BadGateway: Status

Generates a ‘502 BAD_GATEWAY’ result.

val BadRequest: Status

Generates a ‘400 BAD_REQUEST’ result.

val CACHE_CONTROL: String

val CACHE_MANIFEST: String

Content-Type of application cache.

val CHUNKED: String

val CONFLICT: Int

val CONNECTION: String

val CONTENT_DISPOSITION: String

val CONTENT_ENCODING: String

val CONTENT_LANGUAGE: String

val CONTENT_LENGTH: String

val CONTENT_LOCATION: String

val CONTENT_MD5: String

val CONTENT_RANGE: String

val CONTENT_TRANSFER_ENCODING: String

val CONTENT_TYPE: String

val CONTINUE: Int

val COOKIE: String

val CREATED: Int

def CSS(implicit codec: Codec): String

Content-Type of css.

val Conflict: Status

Generates a ‘409 CONFLICT’ result.

val Continue: Result

Generates a ‘100 Continue’ result.

val Created: Status

Generates a ‘201 CREATED’ result.

val DATE: String

val ETAG: String

def EVENT_STREAM(implicit codec: Codec): String

Content-Type of server sent events.

val EXPECT: String

val EXPECTATION_FAILED: Int

val EXPIRES: String

val EntityTooLarge: Status

Generates a ‘413 REQUEST_ENTITY_TOO_LARGE’ result.

val ExpectationFailed: Status

Generates a ‘417 EXPECTATION_FAILED’ result.

val FAILED_DEPENDENCY: Int

val FORBIDDEN: Int

val FORM: String

Content-Type of form-urlencoded.

val FORWARDED: String

val FOUND: Int

val FROM: String

val FailedDependency: Status

Generates a ‘424 FAILED_DEPENDENCY’ result.

val Forbidden: Status

Generates a ‘403 FORBIDDEN’ result.

def Found(url: String): Result

Generates a ‘302 FOUND’ simple result.

val GATEWAY_TIMEOUT: Int

val GONE: Int

val GatewayTimeout: Status

Generates a ‘504 GATEWAY_TIMEOUT’ result.

val Gone: Status

Generates a ‘410 GONE’ result.

val HOST: String

def HTML(implicit codec: Codec): String

Content-Type of html.

val HTTP_1_0: String

val HTTP_1_1: String

val HTTP_VERSION_NOT_SUPPORTED: Int

val HttpVersionNotSupported: Status

Generates a ‘505 HTTP_VERSION_NOT_SUPPORTED’ result.

val IF_MATCH: String

val IF_MODIFIED_SINCE: String

val IF_NONE_MATCH: String

val IF_RANGE: String

val IF_UNMODIFIED_SINCE: String

val IM_A_TEAPOT: Int

val INSUFFICIENT_STORAGE: Int

val INTERNAL_SERVER_ERROR: Int

val ImATeapot: Status

Generates a ‘418 IM_A_TEAPOT’ result.

val InsufficientStorage: Status

Generates a ‘507 INSUFFICIENT_STORAGE’ result.

val InternalServerError: Status

Generates a ‘500 INTERNAL_SERVER_ERROR’ result.

def JAVASCRIPT(implicit codec: Codec): String

Content-Type of javascript.

val JSON: String

Content-Type of json.

val LAST_MODIFIED: String

val LENGTH_REQUIRED: Int

val LINK: String

val LOCATION: String

val LOCKED: Int

val Locked: Status

Generates a ‘423 LOCKED’ result.

val MAX_FORWARDS: String

val METHOD_NOT_ALLOWED: Int

val MOVED_PERMANENTLY: Int

val MULTIPLE_CHOICES: Int

val MULTI_STATUS: Int

val MethodNotAllowed: Status

Generates a ‘405 METHOD_NOT_ALLOWED’ result.

def MovedPermanently(url: String): Result

Generates a ‘301 MOVED_PERMANENTLY’ simple result.

val MultiStatus: Status

Generates a ‘207 MULTI_STATUS’ result.

val NON_AUTHORITATIVE_INFORMATION: Int

val NOT_ACCEPTABLE: Int

val NOT_FOUND: Int

val NOT_IMPLEMENTED: Int

val NOT_MODIFIED: Int

val NO_CONTENT: Int

val NoContent: Result

Generates a ‘204 NO_CONTENT’ result.

val NonAuthoritativeInformation: Status

Generates a ‘203 NON_AUTHORITATIVE_INFORMATION’ result.

val NotAcceptable: Status

Generates a ‘406 NOT_ACCEPTABLE’ result.

val NotFound: Status

Generates a ‘404 NOT_FOUND’ result.

val NotImplemented: Status

Generates a ‘501 NOT_IMPLEMENTED’ result.

val NotModified: Result

Generates a ‘304 NOT_MODIFIED’ result.

val OK: Int

val ORIGIN: String

val Ok: Status

Generates a ‘200 OK’ result.

val PARTIAL_CONTENT: Int

val PAYMENT_REQUIRED: Int

val PERMANENT_REDIRECT: Int

val PRAGMA: String

val PRECONDITION_FAILED: Int

val PROXY_AUTHENTICATE: String

val PROXY_AUTHENTICATION_REQUIRED: Int

val PROXY_AUTHORIZATION: String

val PartialContent: Status

Generates a ‘206 PARTIAL_CONTENT’ result.

val PaymentRequired: Status

Generates a ‘402 PAYMENT_REQUIRED’ result.

def PermanentRedirect(url: String): Result

Generates a ‘308 PERMANENT_REDIRECT’ simple result.

val PreconditionFailed: Status

Generates a ‘412 PRECONDITION_FAILED’ result.

val RANGE: String

val REFERER: String

val REQUESTED_RANGE_NOT_SATISFIABLE: Int

val REQUEST_ENTITY_TOO_LARGE: Int

final val REQUEST_HEADER_FIELDS_TOO_LARGE: Int(431)

val REQUEST_TIMEOUT: Int

val REQUEST_URI_TOO_LONG: Int

val RESET_CONTENT: Int

val RETRY_AFTER: String

def Redirect(call: Call, status: Int): Result

Generates a redirect simple result.

def Redirect(call: Call): Result

Generates a redirect simple result.

def Redirect(url: String, queryString: Map[String, Seq[String]] = Map.empty, status: Int = SEE_OTHER): Result

Generates a redirect simple result.

def Redirect(url: String, status: Int): Result

Generates a redirect simple result.

val RequestTimeout: Status

Generates a ‘408 REQUEST_TIMEOUT’ result.

val ResetContent: Result

Generates a ‘205 RESET_CONTENT’ result.

val SEE_OTHER: Int

val SERVER: String

val SERVICE_UNAVAILABLE: Int

val SET_COOKIE: String

val SET_COOKIE2: String

val STRICT_TRANSPORT_SECURITY: String

val SWITCHING_PROTOCOLS: Int

def SeeOther(url: String): Result

Generates a ‘303 SEE_OTHER’ simple result.

val ServiceUnavailable: Status

Generates a ‘503 SERVICE_UNAVAILABLE’ result.

def Status(code: Int): Status

Generates a simple result.

val SwitchingProtocols: Result

Generates a ‘101 Switching Protocols’ result.

val TE: String

val TEMPORARY_REDIRECT: Int

def TEXT(implicit codec: Codec): String

Content-Type of text.

lazy val TODO: Action[AnyContent]

Used to mark an action that is still not implemented, e.g.:

def action(query: String) = TODO

val TOO_MANY_REQUESTS: Int

val TRAILER: String

val TRANSFER_ENCODING: String

def TemporaryRedirect(url: String): Result

Generates a ‘307 TEMPORARY_REDIRECT’ simple result.

val TooManyRequests: Status

Generates a ‘429 TOO_MANY_REQUESTS’ result.

val UNAUTHORIZED: Int

val UNPROCESSABLE_ENTITY: Int

val UNSUPPORTED_MEDIA_TYPE: Int

val UPGRADE: String

val UPGRADE_REQUIRED: Int

val USER_AGENT: String

val USE_PROXY: Int

val Unauthorized: Status

Generates a ‘401 UNAUTHORIZED’ result.

val UnprocessableEntity: Status

Generates a ‘422 UNPROCESSABLE_ENTITY’ result.

val UnsupportedMediaType: Status

Generates a ‘415 UNSUPPORTED_MEDIA_TYPE’ result.

val UriTooLong: Status

Generates a ‘414 REQUEST_URI_TOO_LONG’ result.

val VARY: String

val VIA: String

val WARNING: String

val WWW_AUTHENTICATE: String

def XHTML(implicit codec: Codec): String

Content-Type of xhtml.

def XML(implicit codec: Codec): String

Content-Type of xml.

val X_FORWARDED_FOR: String

val X_FORWARDED_HOST: String

val X_FORWARDED_PORT: String

val X_FORWARDED_PROTO: String

val X_REQUESTED_WITH: String

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def defaultExecutionContext: ExecutionContext

The default execution context provided by Play.

implicit lazy val executionContext = defaultExecutionContext

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

implicit def fileMimeTypes: FileMimeTypes

The default FileMimeTypes provided by Play.

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

implicit def messagesApi: MessagesApi

The MessagesApi provided by Play.

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def parse: PlayBodyParsers

The default body parsers provided by Play.

def foo(query: String) = Action(parse.tolerantJson) { request =>
  Ok(request.body)
}

object render

implicit def request2flash(implicit request: RequestHeader): Flash

Retrieve the flash scope implicitly from the request.

def index(name:String) = Action { implicit request =>
  val message = request2flash("message")
  Ok("Got " + message)
}

implicit def request2session(implicit request: RequestHeader): Session

Retrieves the session implicitly from the request.

def index(name:String) = Action { implicit request =>
  val username = request2session("username")
  Ok("Hello " + username)
}

implicit def supportedLangs: Langs

The default Langs provided by Play.

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withCharset(mimeType: String)(implicit codec: Codec): String

val TOO_MANY_REQUEST: Int

val TooManyRequest: Status

Generates a ‘429 TOO_MANY_REQUEST’ result.