uk.gov.hmrc.play.http.ws

# WSHttp

###
Related Doc: package ws

#### trait WSHttp extends WSGet with WSPut with WSDelete with WSPatch

Linear Supertypes
WSPatch, PatchHttpTransport, CorePatch, WSDelete, DeleteHttpTransport, CoreDelete, WSPut, PutHttpTransport, CorePut, WSGet, GetHttpTransport, CoreGet, WSRequest, AnyRef, Any
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. WSHttp
2. WSPatch
3. PatchHttpTransport
4. CorePatch
5. WSDelete
6. DeleteHttpTransport
7. CoreDelete
8. WSPut
9. PutHttpTransport
10. CorePut
11. WSGet
12. GetHttpTransport
13. CoreGet
14. WSRequest
15. AnyRef
16. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Abstract Value Members

1. #### abstract def DELETE[O](url: String)(implicit rds: HttpReads[O], hc: HeaderCarrier, ec: ExecutionContext): Future[O]

   Definition Classes
     CoreDelete

2. #### abstract def GET[A](url: String, queryParams: Seq[(String, String)])(implicit rds: HttpReads[A], hc: HeaderCarrier, ec: ExecutionContext): Future[A]

   Definition Classes
     CoreGet

3. #### abstract def GET[A](url: String)(implicit rds: HttpReads[A], hc: HeaderCarrier, ec: ExecutionContext): Future[A]

   Definition Classes
     CoreGet

4. #### abstract def PATCH[I, O](url: String, body: I)(implicit wts: Writes[I], rds: HttpReads[O], hc: HeaderCarrier, ec: ExecutionContext): Future[O]

   Definition Classes
     CorePatch

5. #### abstract def PUT[I, O](url: String, body: I)(implicit wts: Writes[I], rds: HttpReads[O], hc: HeaderCarrier, ec: ExecutionContext): Future[O]

   Definition Classes
     CorePut

6. #### abstract def PUTString[O](url: String, body: String, headers: Seq[(String, String)] = Seq.empty)(implicit rds: HttpReads[O], hc: HeaderCarrier, ec: ExecutionContext): Future[O]

   Definition Classes
     CorePut

7. #### abstract val auth: Option[(String, String, WSAuthScheme)]

   Definition Classes
     WSRequest

8. #### abstract val body: WSBody

   Definition Classes
     WSRequest

9. #### abstract val calc: Option[WSSignatureCalculator]

   Definition Classes
     WSRequest

10. #### abstract def execute(): Future[WSResponse]

    Definition Classes
      WSRequest

11. #### abstract val followRedirects: Option[Boolean]

    Definition Classes
      WSRequest

12. #### abstract val headers: Map[String, Seq[String]]

    Definition Classes
      WSRequest

13. #### abstract val method: String

    Definition Classes
      WSRequest

14. #### abstract val proxyServer: Option[WSProxyServer]

    Definition Classes
      WSRequest

15. #### abstract val queryString: Map[String, Seq[String]]

    Definition Classes
      WSRequest

16. #### abstract val requestTimeout: Option[Int]

    Definition Classes
      WSRequest

17. #### abstract def sign(calc: WSSignatureCalculator): WSRequest

    Definition Classes
      WSRequest

18. #### abstract def stream(): Future[StreamedResponse]

    Definition Classes
      WSRequest

19. #### abstract val url: String

    Definition Classes
      WSRequest

20. #### abstract val virtualHost: Option[String]

    Definition Classes
      WSRequest

21. #### abstract def withAuth(username: String, password: String, scheme: WSAuthScheme): WSRequest

    Definition Classes
      WSRequest

22. #### abstract def withBody(body: WSBody): WSRequest

    Definition Classes
      WSRequest

23. #### abstract def withFollowRedirects(follow: Boolean): WSRequest

    Definition Classes
      WSRequest

24. #### abstract def withHeaders(hdrs: (String, String)*): WSRequest

    Definition Classes
      WSRequest

25. #### abstract def withMethod(method: String): WSRequest

    Definition Classes
      WSRequest

26. #### abstract def withProxyServer(proxyServer: WSProxyServer): WSRequest

    Definition Classes
      WSRequest

27. #### abstract def withQueryString(parameters: (String, String)*): WSRequest

    Definition Classes
      WSRequest

28. #### abstract def withRequestFilter(filter: WSRequestFilter): WSRequest

    Definition Classes
      WSRequest

29. #### abstract def withRequestTimeout(timeout: Duration): WSRequest

    Definition Classes
      WSRequest

30. #### abstract def withVirtualHost(vh: String): WSRequest

    Definition Classes
      WSRequest

31. #### abstract def streamWithEnumerator(): Future[(WSResponseHeaders, Enumerator[Array[Byte]])]

    Definition Classes
      WSRequest
    Annotations
      @deprecated
    Deprecated

      (Since version 2.5.0) Use `WS.stream()` instead.

### Concrete Value Members

1. #### final def !=(arg0: Any): Boolean

   Definition Classes
     AnyRef → Any

2. #### final def ##(): Int

   Definition Classes
     AnyRef → Any

3. #### final def ==(arg0: Any): Boolean

   Definition Classes
     AnyRef → Any

4. #### final def asInstanceOf[T0]: T0

   Definition Classes
     Any

5. #### def clone(): AnyRef

   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @throws( ... )

6. #### def delete(): Future[WSResponse]

   Definition Classes
     WSRequest

7. #### def doDelete(url: String)(implicit hc: HeaderCarrier): Future[HttpResponse]

   Definition Classes
     WSDelete → DeleteHttpTransport

8. #### def doGet(url: String)(implicit hc: HeaderCarrier): Future[HttpResponse]

   Definition Classes
     WSGet → GetHttpTransport

9. #### def doPatch[A](url: String, body: A)(implicit rds: Writes[A], hc: HeaderCarrier): Future[HttpResponse]

   Definition Classes
     WSPatch → PatchHttpTransport

10. #### def doPut[A](url: String, body: A)(implicit rds: Writes[A], hc: HeaderCarrier): Future[HttpResponse]

    Definition Classes
      WSPut → PutHttpTransport

11. #### def doPutString(url: String, body: String, headers: Seq[(String, String)])(implicit hc: HeaderCarrier): Future[HttpResponse]

    Definition Classes
      WSPut → PutHttpTransport

12. #### final def eq(arg0: AnyRef): Boolean

    Definition Classes
      AnyRef

13. #### def equals(arg0: Any): Boolean

    Definition Classes
      AnyRef → Any

14. #### def execute(method: String): Future[WSResponse]

    Definition Classes
      WSRequest

15. #### def finalize(): Unit

    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )

16. #### def get(): Future[WSResponse]

    Definition Classes
      WSRequest

17. #### final def getClass(): Class[_]

    Definition Classes
      AnyRef → Any

18. #### def hashCode(): Int

    Definition Classes
      AnyRef → Any

19. #### def head(): Future[WSResponse]

    Definition Classes
      WSRequest

20. #### final def isInstanceOf[T0]: Boolean

    Definition Classes
      Any

21. #### final def ne(arg0: AnyRef): Boolean

    Definition Classes
      AnyRef

22. #### final def notify(): Unit

    Definition Classes
      AnyRef

23. #### final def notifyAll(): Unit

    Definition Classes
      AnyRef

24. #### def options(): Future[WSResponse]

    Definition Classes
      WSRequest

25. #### def patch(body: Source[Part[Source[ByteString, _]], _]): Future[WSResponse]

    Definition Classes
      WSRequest

26. #### def patch(body: File): Future[WSResponse]

    Definition Classes
      WSRequest

27. #### def patch[T](body: T)(implicit wrt: Writeable[T]): Future[WSResponse]

    Definition Classes
      WSRequest

28. #### def post(body: Source[Part[Source[ByteString, _]], _]): Future[WSResponse]

    Definition Classes
      WSRequest

29. #### def post(body: File): Future[WSResponse]

    Definition Classes
      WSRequest

30. #### def post[T](body: T)(implicit wrt: Writeable[T]): Future[WSResponse]

    Definition Classes
      WSRequest

31. #### def put(body: Source[Part[Source[ByteString, _]], _]): Future[WSResponse]

    Definition Classes
      WSRequest

32. #### def put(body: File): Future[WSResponse]

    Definition Classes
      WSRequest

33. #### def put[T](body: T)(implicit wrt: Writeable[T]): Future[WSResponse]

    Definition Classes
      WSRequest

34. #### final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
      AnyRef

35. #### def toString(): String

    Definition Classes
      AnyRef → Any

36. #### lazy val uri: URI

    Definition Classes
      WSRequest

37. #### final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

38. #### final def wait(arg0: Long): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

39. #### final def wait(): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

40. #### def withBody[T](body: T)(implicit wrt: Writeable[T]): WSRequest

    Definition Classes
      WSRequest

### Deprecated Value Members

1. #### def get[A](consumer: (WSResponseHeaders) ⇒ Iteratee[Array[Byte], A])(implicit ec: ExecutionContext): Future[Iteratee[Array[Byte], A]]

   Definition Classes
     WSRequest
   Annotations
     @deprecated
   Deprecated

     (Since version 2.5.0) Use WS.withMethod("GET").stream()

2. #### def getStream(): Future[(WSResponseHeaders, Enumerator[Array[Byte]])]

   Definition Classes
     WSRequest
   Annotations
     @deprecated
   Deprecated

     (Since version 2.5.0) Use WS.withMethod("GET").stream()

3. #### def patchAndRetrieveStream[A, T](body: T)(consumer: (WSResponseHeaders) ⇒ Iteratee[Array[Byte], A])(implicit wrt: Writeable[T], ec: ExecutionContext): Future[Iteratee[Array[Byte], A]]

   Definition Classes
     WSRequest
   Annotations
     @deprecated
   Deprecated

     (Since version 2.5.0) Use WS.withMethod("PATCH").stream()

4. #### def postAndRetrieveStream[A, T](body: T)(consumer: (WSResponseHeaders) ⇒ Iteratee[Array[Byte], A])(implicit wrt: Writeable[T], ec: ExecutionContext): Future[Iteratee[Array[Byte], A]]

   Definition Classes
     WSRequest
   Annotations
     @deprecated
   Deprecated

     (Since version 2.5.0) Use WS.withMethod("POST").stream()

5. #### def putAndRetrieveStream[A, T](body: T)(consumer: (WSResponseHeaders) ⇒ Iteratee[Array[Byte], A])(implicit wrt: Writeable[T], ec: ExecutionContext): Future[Iteratee[Array[Byte], A]]

   Definition Classes
     WSRequest
   Annotations
     @deprecated
   Deprecated

     (Since version 2.5.0) Use WS.withMethod("PUT").stream()

### Inherited from WSPatch

### Inherited from PatchHttpTransport

### Inherited from CorePatch

### Inherited from WSDelete

### Inherited from DeleteHttpTransport

### Inherited from CoreDelete

### Inherited from WSPut

### Inherited from PutHttpTransport

### Inherited from CorePut

### Inherited from WSGet

### Inherited from GetHttpTransport

### Inherited from CoreGet

### Inherited from WSRequest

### Inherited from AnyRef

### Inherited from Any

### Ungrouped