root
API
Generated with
root/play/play.api/play.api.mvc/Result

Result

play.api.mvc.Result
See theResult companion object
case class Result(header: ResponseHeader, body: HttpEntity, newSession: Option[Session], newFlash: Option[Flash], newCookies: Seq[Cookie], attrs: TypedMap)

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

Value parameters

body

the response body

header

the response header, which contains status code and HTTP headers

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class Status

Members list

Value members

Concrete methods

def addAttr[A](key: TypedKey[A], value: A): Result

Create a new versions of this object with the given attribute attached to it.

Create a new versions of this object with the given attribute attached to it.

Type parameters

A

The type of value.

Value parameters

key

The new attribute key.

value

The attribute value.

Attributes

Returns

The new version of this object with the new attribute.

def addAttrs(e1: TypedEntry[_]): Result

Create a new versions of this object with the given attribute attached to it.

Create a new versions of this object with the given attribute attached to it.

Value parameters

e1

The new attribute.

Attributes

Returns

The new version of this object with the new attribute.

def addAttrs(e1: TypedEntry[_], e2: TypedEntry[_]): Result

Create a new versions of this object with the given attributes attached to it.

Create a new versions of this object with the given attributes attached to it.

Value parameters

e1

The first new attribute.

e2

The second new attribute.

Attributes

Returns

The new version of this object with the new attributes.

def addAttrs(e1: TypedEntry[_], e2: TypedEntry[_], e3: TypedEntry[_]): Result

Create a new versions of this object with the given attributes attached to it.

Create a new versions of this object with the given attributes attached to it.

Value parameters

e1

The first new attribute.

e2

The second new attribute.

e3

The third new attribute.

Attributes

Returns

The new version of this object with the new attributes.

def addAttrs(entries: TypedEntry[_]*): Result

Create a new versions of this object with the given attributes attached to it.

Create a new versions of this object with the given attributes attached to it.

Value parameters

entries

The new attributes.

Attributes

Returns

The new version of this object with the new attributes.

def addingToSession(values: (String, String)*)(implicit request: RequestHeader): Result

Example:

Example:

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

Value parameters

request

Current request

values

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

Attributes

Returns

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

def as(contentType: String): Result

Changes the result content type.

Changes the result content type.

For example:

Ok("<text>Hello world</text>").as("application/xml")

Value parameters

contentType

the new content type.

Attributes

Returns

the new result

def asJava: Result

Convert this result to a Java result.

Convert this result to a Java result.

Attributes

def bakeCookies(cookieHeaderEncoding: CookieHeaderEncoding, sessionBaker: CookieBaker[Session], flashBaker: CookieBaker[Flash], requestHasFlash: Boolean): Result

Encode the cookies into the Set-Cookie header. The session is always baked first, followed by the flash cookie, followed by all the other cookies in order.

Encode the cookies into the Set-Cookie header. The session is always baked first, followed by the flash cookie, followed by all the other cookies in order.

Attributes

def discardingCookies(cookies: DiscardingCookie*): Result

Discards cookies along this result.

Discards cookies along this result.

For example:

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

Value parameters

cookies

the cookies to discard along to this result

Attributes

Returns

the new result

def discardingHeader(name: String): Result

Discards headers to this result.

Discards headers to this result.

For example:

Ok("Hello world").discardingHeader(ETAG)

Value parameters

name

the header to discard from this result.

Attributes

Returns

the new result

def flashing(flash: Flash): Result

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!"))

Value parameters

flash

the flash scope to set with this result

Attributes

Returns

the new result

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

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!")

Value parameters

values

the flash values to set with this result

Attributes

Returns

the new result

def removeAttr(key: TypedKey[_]): Result

Create a new versions of this object with the given attribute removed.

Create a new versions of this object with the given attribute removed.

Value parameters

key

The key of the attribute to remove.

Attributes

Returns

The new version of this object with the attribute removed.

def removingFromSession(keys: String*)(implicit request: RequestHeader): Result

Example:

Example:

 Ok.removingFromSession("foo")

Value parameters

keys

Keys to remove from session

request

Current request

Attributes

Returns

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

def session(implicit request: RequestHeader): Session

Value parameters

request

Current request

Attributes

Returns

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

override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any
def withAttrs(newAttrs: TypedMap): Result

Create a new version of this object with the given attributes attached to it. This replaces any existing attributes.

Create a new version of this object with the given attributes attached to it. This replaces any existing attributes.

Value parameters

newAttrs

The new attributes to add.

Attributes

Returns

The new version of this object with the attributes attached.

def withCookies(cookies: Cookie*): Result

Adds cookies to this result. If the result already contains cookies then cookies with the same name in the new list will override existing ones.

Adds cookies to this result. If the result already contains cookies then cookies with the same name in the new list will override existing ones.

For example:

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

Value parameters

cookies

the cookies to add to this result

Attributes

Returns

the new result

def withDateHeaders(headers: (String, ZonedDateTime)*): Result

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

Value parameters

headers

the headers with a DateTime to add to this result.

Attributes

Returns

the new result.

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

Adds headers to this result.

Adds headers to this result.

For example:

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

Value parameters

headers

the headers to add to this result.

Attributes

Returns

the new result

def withNewSession: Result

Discards the existing session for this result.

Discards the existing session for this result.

For example:

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

Attributes

Returns

the new result

def withSession(session: Session): Result

Sets a new session for this result.

Sets a new session for this result.

For example:

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

Value parameters

session

the session to set with this result

Attributes

Returns

the new result

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

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")

Value parameters

session

the session to set with this result

Attributes

Returns

the new result

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
Generated with