Class

play.api.mvc.Results

Status

Related Doc: package Results

Permalink

class Status extends Result

Generates default Result from a content type, headers and content.

Source
Results.scala
Linear Supertypes
Result, Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Status
  2. Result
  3. Serializable
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Status(status: Int)

    Permalink

    status

    the HTTP response status, e.g ‘200 OK’

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. def addingToSession(values: (String, String)*)(implicit request: RequestHeader): Result

    Permalink

    Example:

    Example:

    Ok.addingToSession("foo" -> "bar").addingToSession("baz" -> "bah")
    values

    (key -> value) pairs to add to this result’s session

    request

    Current request

    returns

    A copy of this result with values added to its session scope.

    Definition Classes
    Result
  5. def apply[C](content: C)(implicit writeable: Writeable[C]): Result

    Permalink

    Set the result's content.

    Set the result's content.

    content

    The content to send.

  6. def as(contentType: String): Result

    Permalink

    Changes the result content type.

    Changes the result content type.

    For example:

    Ok("Hello world").as("application/xml")
    contentType

    the new content type.

    returns

    the new result

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

    Permalink
    Definition Classes
    Any
  8. def asJava: mvc.Result

    Permalink

    Convert this result to a Java result.

    Convert this result to a Java result.

    Definition Classes
    Result
  9. val body: HttpEntity

    Permalink

    the response body

    the response body

    Definition Classes
    Result
  10. def chunked[C](content: Source[C, _])(implicit writeable: Writeable[C]): Result

    Permalink

    Feed the content as the response, using chunked transfer encoding.

    Feed the content as the response, using chunked transfer encoding.

    Chunked transfer encoding is only supported for HTTP 1.1 clients. If the client is an HTTP 1.0 client, Play will instead return a 505 error code.

    Chunked encoding allows the server to send a response where the content length is not known, or for potentially infinite streams, while still allowing the connection to be kept alive and reused for the next request.

    content

    Source providing the content to stream.

  11. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def discardingCookies(cookies: DiscardingCookie*): Result

    Permalink

    Discards cookies along this result.

    Discards cookies along this result.

    For example:

    Redirect(routes.Application.index()).discardingCookies("theme")
    cookies

    the cookies to discard along to this result

    returns

    the new result

    Definition Classes
    Result
  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def flashing(values: (String, String)*): Result

    Permalink

    Adds values to the flash scope for this result.

    Adds values to the flash scope for this result.

    For example:

    Redirect(routes.Application.index()).flashing("success" -> "Done!")
    values

    the flash values to set with this result

    returns

    the new result

    Definition Classes
    Result
  16. def flashing(flash: Flash): Result

    Permalink

    Adds values to the flash scope for this result.

    Adds values to the flash scope for this result.

    For example:

    Redirect(routes.Application.index()).flashing(flash + ("success" -> "Done!"))
    flash

    the flash scope to set with this result

    returns

    the new result

    Definition Classes
    Result
  17. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  18. val header: ResponseHeader

    Permalink

    the response header, which contains status code and HTTP headers

    the response header, which contains status code and HTTP headers

    Definition Classes
    Result
  19. final def isInstanceOf[T0]: Boolean

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

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

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

    Permalink
    Definition Classes
    AnyRef
  23. def removingFromSession(keys: String*)(implicit request: RequestHeader): Result

    Permalink

    Example:

    Example:

    Ok.removingFromSession("foo")
    keys

    Keys to remove from session

    request

    Current request

    returns

    A copy of this result with keys removed from its session scope.

    Definition Classes
    Result
  24. def sendEntity(entity: HttpEntity): Result

    Permalink

    Send an HTTP entity with this status.

  25. def sendFile(content: File, inline: Boolean = true, fileName: (File) ⇒ String = _.getName, onClose: () ⇒ Unit = () => ()): Result

    Permalink

    Send a file.

    Send a file.

    content

    The file to send.

    inline

    Use Content-Disposition inline or attachment.

    fileName

    Function to retrieve the file name. By default the name of the file is used.

  26. def sendPath(content: Path, inline: Boolean = true, fileName: (Path) ⇒ String = _.getFileName.toString, onClose: () ⇒ Unit = () => ()): Result

    Permalink

    Send a file.

    Send a file.

    content

    The file to send.

    inline

    Use Content-Disposition inline or attachment.

    fileName

    Function to retrieve the file name. By default the name of the file is used.

  27. def sendResource(resource: String, classLoader: ClassLoader = Results.getClass.getClassLoader, inline: Boolean = true): Result

    Permalink

    Send the given resource from the given classloader.

    Send the given resource from the given classloader.

    resource

    The path of the resource to load.

    classLoader

    The classloader to load it from, defaults to the classloader for this class.

    inline

    Whether it should be served as an inline file, or as an attachment.

  28. def session(implicit request: RequestHeader): Session

    Permalink

    request

    Current request

    returns

    The session carried by this result. Reads the request’s session if this result does not modify the session.

    Definition Classes
    Result
  29. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    Result → AnyRef → Any
  31. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. def withCookies(cookies: Cookie*): Result

    Permalink

    Adds cookies to this result.

    Adds cookies to this result. If the result already contains cookies then the new cookies will be merged with the old cookies.

    For example:

    Redirect(routes.Application.index()).withCookies(Cookie("theme", "blue"))
    cookies

    the cookies to add to this result

    returns

    the new result

    Definition Classes
    Result
  35. def withDateHeaders(headers: (String, DateTime)*): Result

    Permalink

    Add a header with a DateTime formatted using the default http date format

    Add a header with a DateTime formatted using the default http date format

    headers

    the headers with a DateTime to add to this result.

    returns

    the new result.

    Definition Classes
    Result
  36. def withHeaders(headers: (String, String)*): Result

    Permalink

    Adds headers to this result.

    Adds headers to this result.

    For example:

    Ok("Hello world").withHeaders(ETAG -> "0")
    headers

    the headers to add to this result.

    returns

    the new result

    Definition Classes
    Result
  37. def withNewSession: Result

    Permalink

    Discards the existing session for this result.

    Discards the existing session for this result.

    For example:

    Redirect(routes.Application.index()).withNewSession
    returns

    the new result

    Definition Classes
    Result
  38. def withSession(session: (String, String)*): Result

    Permalink

    Sets a new session for this result, discarding the existing session.

    Sets a new session for this result, discarding the existing session.

    For example:

    Redirect(routes.Application.index()).withSession("saidHello" -> "yes")
    session

    the session to set with this result

    returns

    the new result

    Definition Classes
    Result
  39. def withSession(session: Session): Result

    Permalink

    Sets a new session for this result.

    Sets a new session for this result.

    For example:

    Redirect(routes.Application.index()).withSession(session + ("saidHello" -> "true"))
    session

    the session to set with this result

    returns

    the new result

    Definition Classes
    Result

Deprecated Value Members

  1. def chunked[C](content: Enumerator[C])(implicit writeable: Writeable[C]): Result

    Permalink

    Feed the content as the response, using chunked transfer encoding.

    Feed the content as the response, using chunked transfer encoding.

    Chunked transfer encoding is only supported for HTTP 1.1 clients. If the client is an HTTP 1.0 client, Play will instead return a 505 error code.

    Chunked encoding allows the server to send a response where the content length is not known, or for potentially infinite streams, while still allowing the connection to be kept alive and reused for the next request.

    content

    Enumerator providing the content to stream.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.0) Use chunked with an Akka streams Source instead

  2. def feed[C](content: Enumerator[C])(implicit writeable: Writeable[C]): Result

    Permalink

    Feed the content as the response, closing the connection when done.

    Feed the content as the response, closing the connection when done.

    content

    Enumerator providing the content to stream.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.0) Use sendEntity with a Streamed entity instead

Inherited from Result

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped