Status

Instance Constructors

new Status(status: Int)

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

Value Members

final def !=(arg0: AnyRef): Boolean

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

Definition Classes
Any
final def ##(): Int

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

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

Definition Classes
Any
def apply[C](content: C)(implicit writeable: Writeable[C]): SimpleResult

Set the result's content.
Set the result's content.
content
The content to send.
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
SimpleResult → WithHeaders
final def asInstanceOf[T0]: T0

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

Definition Classes
SimpleResult
def chunked[C](content: Enumerator[C])(implicit writeable: Writeable[C]): SimpleResult

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.
def clearingLang(implicit app: Application): PlainResult

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
def clone(): AnyRef

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

Definition Classes
SimpleResult
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
SimpleResult → WithHeaders
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def feed[C](content: Enumerator[C])(implicit writeable: Writeable[C]): SimpleResult

Feed the content as the response.
Feed the content as the response.
The connection will be closed after the response is sent, regardless of whether there is a content length or transfer encoding defined.
content
Enumerator providing the content to stream.
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
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
SimpleResult → WithHeaders
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
SimpleResult → WithHeaders
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val header: ResponseHeader

The response header
The response header

Definition Classes
SimpleResult → PlainResult
final def isInstanceOf[T0]: Boolean

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def sendFile(content: File, inline: Boolean = false, fileName: (File) ⇒ String = _.getName, onClose: () ⇒ Unit = () => ()): SimpleResult

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 (only used for Content-Disposition attachment).
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
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
SimpleResult → WithHeaders
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
SimpleResult → WithHeaders
def withLang(lang: Lang)(implicit app: Application): PlainResult

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
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
SimpleResult → WithHeaders
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
SimpleResult → WithHeaders
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
SimpleResult → WithHeaders

Deprecated Value Members

def discardingCookies(name: String, names: String*): PlainResult

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.
def stream[C](content: (Iteratee[C, Unit]) ⇒ Unit)(implicit writeable: Writeable[C]): ChunkedResult[C]

Set the result's content as chunked.
Set the result's content as chunked.
content
A function that will give you the Iteratee to write in once ready.

Annotations
@deprecated
Deprecated
(Since version 2.2.0) Use stream(Enumerator) instead. Will be removed in Play 2.3.
def stream[C](content: Enumerator[C])(implicit writeable: Writeable[C]): SimpleResult

Stream the results content as chunked.
Stream the results content as chunked.
content
Enumerator providing the content to stream.

Annotations
@deprecated
Deprecated
(Since version 2.3.0) Use Status.chunked instead

class Status extends SimpleResult

Instance Constructors

new Status(status: Int)

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

def apply[C](content: C)(implicit writeable: Writeable[C]): SimpleResult

def as(contentType: String): SimpleResult

final def asInstanceOf[T0]: T0

val body: Enumerator[Array[Byte]]

def chunked[C](content: Enumerator[C])(implicit writeable: Writeable[C]): SimpleResult

def clearingLang(implicit app: Application): PlainResult

def clone(): AnyRef

val connection: Connection

def discardingCookies(cookies: DiscardingCookie*): SimpleResult

final def eq(arg0: AnyRef): Boolean

def feed[C](content: Enumerator[C])(implicit writeable: Writeable[C]): SimpleResult

def finalize(): Unit

def flashing(values: (String, String)*): SimpleResult

def flashing(flash: Flash): SimpleResult

final def getClass(): Class[_]

val header: ResponseHeader

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

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 withCookies(cookies: Cookie*): SimpleResult

def withHeaders(headers: (String, String)*): SimpleResult

def withLang(lang: Lang)(implicit app: Application): PlainResult

def withNewSession: SimpleResult

def withSession(session: (String, String)*): SimpleResult

def withSession(session: Session): SimpleResult

Deprecated Value Members

def discardingCookies(name: String, names: String*): PlainResult

def stream[C](content: (Iteratee[C, Unit]) ⇒ Unit)(implicit writeable: Writeable[C]): ChunkedResult[C]

def stream[C](content: Enumerator[C])(implicit writeable: Writeable[C]): SimpleResult

Inherited from SimpleResult

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from PlainResult

Inherited from Result

Inherited from WithHeaders[PlainResult]

Inherited from NotNull

Inherited from AnyRef

Inherited from Any

Ungrouped