play.api.mvc

SimpleResult

case class SimpleResult(header: ResponseHeader, body: Enumerator[Array[Byte]], connection: Connection = HttpConnection.KeepAlive) extends PlainResult with WithHeaders[SimpleResult] with Product with Serializable

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

header

the response header, which contains status code and HTTP headers

body

the response body

connection

the connection semantics to use

Source
Results.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, PlainResult, Result, WithHeaders[SimpleResult], NotNull, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SimpleResult
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. PlainResult
  7. Result
  8. WithHeaders
  9. NotNull
  10. AnyRef
  11. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SimpleResult(header: ResponseHeader, body: Enumerator[Array[Byte]], connection: Connection = HttpConnection.KeepAlive)

    header

    the response header, which contains status code and HTTP headers

    body

    the response body

    connection

    the connection semantics to use

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def as(contentType: String): SimpleResult

    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
    SimpleResultWithHeaders
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. val body: Enumerator[Array[Byte]]

    the response body

  9. def clearingLang(implicit app: Application): SimpleResult

    Clears the user's language by discarding the language cookie set by withLang

    Clears the user's language by discarding the language cookie set by withLang

    For example:

    Ok(Messages("hello.world")).clearingLang
    returns

    the new result

    Definition Classes
    WithHeaders
  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. val connection: Connection

    the connection semantics to use

  12. def discardingCookies(cookies: DiscardingCookie*): SimpleResult

    Discards cookies along this result.

    Discards cookies along this result.

    For example:

    Ok("Hello world").discardingCookies("theme")
    cookies

    the cookies to discard along to this result

    returns

    the new result

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

    Definition Classes
    AnyRef
  14. def finalize(): Unit

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

    Adds values to the flash scope for this result.

    Adds values to the flash scope for this result.

    For example:

    Ok("Hello world").flashing("success" -> "Done!")
    values

    the flash values to set with this result

    returns

    the new result

    Definition Classes
    SimpleResultWithHeaders
  16. def flashing(flash: Flash): SimpleResult

    Adds values to the flash scope for this result.

    Adds values to the flash scope for this result.

    For example:

    Ok("Hello world").flashing(flash + ("success" -> "Done!"))
    flash

    the flash scope to set with this result

    returns

    the new result

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

    Definition Classes
    AnyRef → Any
  18. val header: ResponseHeader

    the response header, which contains status code and HTTP headers

    the response header, which contains status code and HTTP headers

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

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

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

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

    Definition Classes
    AnyRef
  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  24. def toString(): String

    Definition Classes
    SimpleResult → AnyRef → Any
  25. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. def withCookies(cookies: Cookie*): SimpleResult

    Adds cookies to this result.

    Adds cookies to this result.

    For example:

    Ok("Hello world").withCookies(Cookie("theme", "blue"))
    cookies

    the cookies to add to this result

    returns

    the new result

    Definition Classes
    SimpleResultWithHeaders
  29. def withHeaders(headers: (String, String)*): SimpleResult

    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
    SimpleResultWithHeaders
  30. def withLang(lang: Lang)(implicit app: Application): SimpleResult

    Sets the user's language permanently for future requests by storing it in a cookie.

    Sets the user's language permanently for future requests by storing it in a cookie.

    For example:

    implicit val lang = Lang("fr-FR")
    Ok(Messages("hello.world")).withLang(lang)
    lang

    the language to store for the user

    returns

    the new result

    Definition Classes
    WithHeaders
  31. def withNewSession: SimpleResult

    Discards the existing session for this result.

    Discards the existing session for this result.

    For example:

    Ok("Hello world").withNewSession
    returns

    the new result

    Definition Classes
    SimpleResultWithHeaders
  32. def withSession(session: (String, String)*): SimpleResult

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

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

    For example:

    Ok("Hello world").withSession("saidHello" -> "yes")
    session

    the session to set with this result

    returns

    the new result

    Definition Classes
    SimpleResultWithHeaders
  33. def withSession(session: Session): SimpleResult

    Sets a new session for this result.

    Sets a new session for this result.

    For example:

    Ok("Hello world").withSession(session + ("saidHello" -> "true"))
    session

    the session to set with this result

    returns

    the new result

    Definition Classes
    SimpleResultWithHeaders

Deprecated Value Members

  1. def discardingCookies(name: String, names: String*): SimpleResult

    Discards cookies along this result.

    Discards cookies along this result.

    For example:

    Ok("Hello world").discardingCookies("theme")
    names

    the names of the cookies to discard along to this result

    returns

    the new result

    Definition Classes
    WithHeaders
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1) This method can only discard cookies on the / path with no domain and without secure set. Use discardingCookies(DiscardingCookie*) instead.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from PlainResult

Inherited from Result

Inherited from WithHeaders[SimpleResult]

Inherited from NotNull

Inherited from AnyRef

Inherited from Any

Ungrouped