Class

play.api.libs.ws.ahc

AhcWSResponse

Related Doc: package ahc

Permalink

case class AhcWSResponse(underlying: StandaloneWSResponse) extends WSResponse with WSBodyReadables with Product with Serializable

A WS HTTP Response backed by an AsyncHttpClient response.

underlying

the underlying WS response

Source
AhcWSResponse.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, WSResponse, WSBodyReadables, XMLBodyReadables, JsonBodyReadables, DefaultBodyReadables, StandaloneWSResponse, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AhcWSResponse
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. WSResponse
  7. WSBodyReadables
  8. XMLBodyReadables
  9. JsonBodyReadables
  10. DefaultBodyReadables
  11. StandaloneWSResponse
  12. AnyRef
  13. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AhcWSResponse(ahcResponse: Response)

    Permalink
  2. new AhcWSResponse(underlying: StandaloneWSResponse)

    Permalink

    underlying

    the underlying WS response

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: String

    Permalink

    The response body as String.

    The response body as String.

    Definition Classes
    AhcWSResponseWSResponse → StandaloneWSResponse
  6. 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
  7. def bodyAsBytes: ByteString

    Permalink

    The response body as a byte string.

    The response body as a byte string.

    Definition Classes
    AhcWSResponseWSResponse → StandaloneWSResponse
  8. def bodyAsSource: Source[ByteString, _]

    Permalink
    Definition Classes
    AhcWSResponseWSResponse → StandaloneWSResponse
  9. def clone(): AnyRef

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

    Permalink
    Definition Classes
    WSResponse → StandaloneWSResponse
  11. 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
    AhcWSResponseWSResponse → StandaloneWSResponse
  12. def cookies: Seq[WSCookie]

    Permalink

    Get all the cookies.

    Get all the cookies.

    Definition Classes
    AhcWSResponseWSResponse → StandaloneWSResponse
  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. final def getClass(): Class[_]

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

    Permalink

    Get a response header.

    Get a response header.

    Definition Classes
    AhcWSResponseWSResponse → StandaloneWSResponse
  17. def headerValues(name: String): Seq[String]

    Permalink
    Definition Classes
    WSResponse → StandaloneWSResponse
  18. def headers: Map[String, Seq[String]]

    Permalink

    Return the current headers of the request being constructed

    Return the current headers of the request being constructed

    Definition Classes
    AhcWSResponseWSResponse → StandaloneWSResponse
  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. implicit val readableAsByteArray: BodyReadable[Array[Byte]]

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

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

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

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

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

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

    Permalink
    Definition Classes
    XMLBodyReadables
  30. def status: Int

    Permalink

    The response status code.

    The response status code.

    Definition Classes
    AhcWSResponseWSResponse → StandaloneWSResponse
  31. def statusText: String

    Permalink

    The response status message.

    The response status message.

    Definition Classes
    AhcWSResponseWSResponse → StandaloneWSResponse
  32. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  33. def underlying[T]: T

    Permalink

    Get the underlying response object, i.e.

    Get the underlying response object, i.e. play.shaded.ahc.org.asynchttpclient.Response

    val ahcResponse = response.underlying[play.shaded.ahc.org.asynchttpclient.Response]
    Definition Classes
    AhcWSResponseWSResponse → StandaloneWSResponse
  34. val underlying: StandaloneWSResponse

    Permalink

    the underlying WS response

  35. final def wait(): Unit

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

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

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

Deprecated Value Members

  1. def allHeaders: Map[String, Seq[String]]

    Permalink

    Return the current headers of the request being constructed

    Return the current headers of the request being constructed

    Definition Classes
    AhcWSResponseWSResponse
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Please use request.headers

  2. def json: JsValue

    Permalink

    The response body as Json.

    The response body as Json.

    Definition Classes
    AhcWSResponseWSResponse
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use response.body[JsValue]

  3. def xml: Elem

    Permalink

    The response body as Xml.

    The response body as Xml.

    Definition Classes
    AhcWSResponseWSResponse
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use response.body[Elem]

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from WSResponse

Inherited from WSBodyReadables

Inherited from XMLBodyReadables

Inherited from JsonBodyReadables

Inherited from DefaultBodyReadables

Inherited from StandaloneWSResponse

Inherited from AnyRef

Inherited from Any

Ungrouped