Trait

play.api.libs.ws

WSResponse

Related Doc: package ws

Permalink

trait WSResponse extends StandaloneWSResponse with WSBodyReadables

A WS Response that can use Play specific classes.

Source
WSResponse.scala
Linear Supertypes
WSBodyReadables, XMLBodyReadables, JsonBodyReadables, DefaultBodyReadables, StandaloneWSResponse, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WSResponse
  2. WSBodyReadables
  3. XMLBodyReadables
  4. JsonBodyReadables
  5. DefaultBodyReadables
  6. StandaloneWSResponse
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def body: String

    Permalink

    The response body as String.

    The response body as String.

    Definition Classes
    WSResponse → StandaloneWSResponse
  2. abstract def bodyAsBytes: ByteString

    Permalink

    The response body as a byte string.

    The response body as a byte string.

    Definition Classes
    WSResponse → StandaloneWSResponse
  3. abstract def bodyAsSource: Source[ByteString, _]

    Permalink
    Definition Classes
    WSResponse → StandaloneWSResponse
  4. abstract def cookie(name: String): Option[WSCookie]

    Permalink

    Get only one cookie, using the cookie name.

    Get only one cookie, using the cookie name.

    Definition Classes
    WSResponse → StandaloneWSResponse
  5. abstract def cookies: Seq[WSCookie]

    Permalink

    Get all the cookies.

    Get all the cookies.

    Definition Classes
    WSResponse → StandaloneWSResponse
  6. abstract def headers: Map[String, Seq[String]]

    Permalink

    Return the current headers for this response.

    Return the current headers for this response.

    Definition Classes
    WSResponse → StandaloneWSResponse
  7. abstract def json: JsValue

    Permalink
  8. abstract def status: Int

    Permalink

    The response status code.

    The response status code.

    Definition Classes
    WSResponse → StandaloneWSResponse
  9. abstract def statusText: String

    Permalink

    The response status message.

    The response status message.

    Definition Classes
    WSResponse → StandaloneWSResponse
  10. abstract def underlying[T]: T

    Permalink

    Get the underlying response object.

    Get the underlying response object.

    Definition Classes
    WSResponse → StandaloneWSResponse
  11. abstract def xml: Elem

    Permalink
  12. abstract def allHeaders: Map[String, Seq[String]]

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use response.headers

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

    Permalink
    Definition Classes
    Any
  5. def body[T](implicit arg0: BodyReadable[T]): T

    Permalink

    The response body as the given type.

    The response body as the given type. This renders as the given type. You must have a BodyReadable in implicit scope, which is done with

    class MyClass extends play.api.libs.ws.WSBodyReadables {
      // JSON and XML body readables
    }

    The simplest use case is

    val responseBodyAsString: String = response.getBody[String]

    But you can also render as JSON

    val responseBodyAsJson: JsValue = response.getBody[JsValue]

    or as XML:

    val xml: Elem = response.getBody[Elem]
    Definition Classes
    WSResponse → StandaloneWSResponse
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def contentType: String

    Permalink
    Definition Classes
    WSResponse → StandaloneWSResponse
  8. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  13. def header(name: String): Option[String]

    Permalink
    Definition Classes
    WSResponse → StandaloneWSResponse
  14. def headerValues(name: String): Seq[String]

    Permalink
    Definition Classes
    WSResponse → StandaloneWSResponse
  15. final def isInstanceOf[T0]: Boolean

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

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

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

    Permalink
    Definition Classes
    AnyRef
  19. implicit val readableAsByteArray: BodyReadable[Array[Byte]]

    Permalink
    Definition Classes
    DefaultBodyReadables
  20. implicit val readableAsByteBuffer: BodyReadable[ByteBuffer]

    Permalink
    Definition Classes
    DefaultBodyReadables
  21. implicit val readableAsByteString: BodyReadable[ByteString]

    Permalink
    Definition Classes
    DefaultBodyReadables
  22. implicit val readableAsJson: BodyReadable[JsValue]

    Permalink
    Definition Classes
    JsonBodyReadables
  23. implicit val readableAsSource: BodyReadable[Source[ByteString, _]]

    Permalink
    Definition Classes
    DefaultBodyReadables
  24. implicit val readableAsString: BodyReadable[String]

    Permalink
    Definition Classes
    DefaultBodyReadables
  25. implicit val readableAsXml: BodyReadable[Elem]

    Permalink
    Definition Classes
    XMLBodyReadables
  26. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from WSBodyReadables

Inherited from XMLBodyReadables

Inherited from JsonBodyReadables

Inherited from DefaultBodyReadables

Inherited from StandaloneWSResponse

Inherited from AnyRef

Inherited from Any

Ungrouped