Trait/Object

play.api.mvc

Request

Related Docs: object Request | package mvc

Permalink

trait Request[+A] extends RequestHeader

The complete HTTP request.

A

the body content type.

Self Type
Request[A]
Annotations
@implicitNotFound( "Cannot find any HTTP Request here" )
Source
Http.scala
Linear Supertypes
RequestHeader, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Request
  2. RequestHeader
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def body: A

    Permalink

    The body content.

  2. abstract def clientCertificateChain: Option[Seq[X509Certificate]]

    Permalink

    The X509 certificate chain presented by a client during SSL requests.

    The X509 certificate chain presented by a client during SSL requests.

    Definition Classes
    RequestHeader
  3. abstract def headers: Headers

    Permalink

    The HTTP headers.

    The HTTP headers.

    Definition Classes
    RequestHeader
  4. abstract def id: Long

    Permalink

    The request ID.

    The request ID.

    Definition Classes
    RequestHeader
  5. abstract def method: String

    Permalink

    The HTTP method.

    The HTTP method.

    Definition Classes
    RequestHeader
  6. abstract def path: String

    Permalink

    The URI path.

    The URI path.

    Definition Classes
    RequestHeader
  7. abstract def queryString: Map[String, Seq[String]]

    Permalink

    The parsed query string.

    The parsed query string.

    Definition Classes
    RequestHeader
  8. abstract def remoteAddress: String

    Permalink

    The client IP address.

    The client IP address.

    retrieves the last untrusted proxy from the Forwarded-Headers or the X-Forwarded-*-Headers.

    Definition Classes
    RequestHeader
  9. abstract def secure: Boolean

    Permalink

    Is the client using SSL?

    Is the client using SSL?

    Definition Classes
    RequestHeader
  10. abstract def tags: Map[String, String]

    Permalink

    The request Tags.

    The request Tags.

    Definition Classes
    RequestHeader
  11. abstract def uri: String

    Permalink

    The complete request URI, containing both path and query string.

    The complete request URI, containing both path and query string. The URI is what was on the status line after the request method. E.g. in "GET /foo/bar?q=s HTTP/1.1" the URI should be /foo/bar?q=s. It could be absolute, some clients send absolute URLs, especially proxies.

    Definition Classes
    RequestHeader
  12. abstract def version: String

    Permalink

    The HTTP version.

    The HTTP version.

    Definition Classes
    RequestHeader

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. lazy val acceptLanguages: Seq[Lang]

    Permalink

    The Request Langs extracted from the Accept-Language header and sorted by preference (preferred first).

    The Request Langs extracted from the Accept-Language header and sorted by preference (preferred first).

    Definition Classes
    RequestHeader
  5. lazy val acceptedTypes: Seq[MediaRange]

    Permalink

    returns

    The media types list of the request’s Accept header, sorted by preference (preferred first).

    Definition Classes
    RequestHeader
  6. def accepts(mimeType: String): Boolean

    Permalink

    Check if this request accepts a given media type.

    Check if this request accepts a given media type.

    returns

    true if mimeType matches the Accept header, otherwise false

    Definition Classes
    RequestHeader
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. lazy val charset: Option[String]

    Permalink

    Returns the charset of the request for text-based body

    Returns the charset of the request for text-based body

    Definition Classes
    RequestHeader
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. lazy val contentType: Option[String]

    Permalink

    Returns the value of the Content-Type header (without the parameters (eg charset))

    Returns the value of the Content-Type header (without the parameters (eg charset))

    Definition Classes
    RequestHeader
  11. lazy val cookies: Cookies

    Permalink

    The HTTP cookies.

    The HTTP cookies.

    Definition Classes
    RequestHeader
  12. def copy(id: Long = this.id, tags: Map[String, String] = this.tags, uri: String = this.uri, path: String = this.path, method: String = this.method, version: String = this.version, queryString: Map[String, Seq[String]] = this.queryString, headers: Headers = this.headers, remoteAddress: ⇒ String = this.remoteAddress, secure: ⇒ Boolean = this.secure, clientCertificateChain: Option[Seq[X509Certificate]] = this.clientCertificateChain): RequestHeader

    Permalink

    Copy the request.

    Copy the request.

    Definition Classes
    RequestHeader
  13. lazy val domain: String

    Permalink

    The HTTP domain

    The HTTP domain

    Definition Classes
    RequestHeader
  14. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. lazy val flash: Flash

    Permalink

    Parses the Flash cookie and returns the Flash data.

    Parses the Flash cookie and returns the Flash data.

    Definition Classes
    RequestHeader
  18. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  19. def getQueryString(key: String): Option[String]

    Permalink

    Helper method to access a queryString parameter.

    Helper method to access a queryString parameter.

    Definition Classes
    RequestHeader
  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  21. lazy val host: String

    Permalink

    The HTTP host (domain, optionally port)

    The HTTP host (domain, optionally port)

    Definition Classes
    RequestHeader
  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  23. def map[B](f: (A) ⇒ B): Request[B]

    Permalink

    Transform the request body.

  24. lazy val mediaType: Option[MediaType]

    Permalink

    The media type of this request.

    The media type of this request. Same as contentType, except returns a fully parsed media type with parameters.

    Definition Classes
    RequestHeader
  25. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  26. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  27. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  28. lazy val rawQueryString: String

    Permalink

    Returns the raw query string.

    Returns the raw query string.

    Definition Classes
    RequestHeader
  29. lazy val session: Session

    Permalink

    Parses the Session cookie and returns the Session data.

    Parses the Session cookie and returns the Session data.

    Definition Classes
    RequestHeader
  30. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  31. def toString(): String

    Permalink
    Definition Classes
    RequestHeader → AnyRef → Any
  32. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. def withTag(tagName: String, tagValue: String): RequestHeader

    Permalink

    Convenience method for adding a single tag to this request

    Convenience method for adding a single tag to this request

    returns

    the tagged request

    Definition Classes
    RequestHeader

Inherited from RequestHeader

Inherited from AnyRef

Inherited from Any

Ungrouped