uk.gov.hmrc.play.http.ws

# WSPatch

###
Related Doc: package ws

#### trait WSPatch extends CorePatch with PatchHttpTransport with WSRequest

Linear Supertypes
WSRequest, PatchHttpTransport, CorePatch, AnyRef, Any
Known Subclasses
WSHttp
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. WSPatch
2. WSRequest
3. PatchHttpTransport
4. CorePatch
5. AnyRef
6. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Abstract Value Members

1. #### 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

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

   Definition Classes
     WSRequest

3. #### abstract val body: WSBody

   Definition Classes
     WSRequest

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

   Definition Classes
     WSRequest

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

   Definition Classes
     WSRequest

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

   Definition Classes
     WSRequest

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

   Definition Classes
     WSRequest

8. #### abstract val method: String

   Definition Classes
     WSRequest

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

   Definition Classes
     WSRequest

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

    Definition Classes
      WSRequest

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

    Definition Classes
      WSRequest

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

    Definition Classes
      WSRequest

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

    Definition Classes
      WSRequest

14. #### abstract val url: String

    Definition Classes
      WSRequest

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

    Definition Classes
      WSRequest

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

    Definition Classes
      WSRequest

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

    Definition Classes
      WSRequest

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

    Definition Classes
      WSRequest

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

    Definition Classes
      WSRequest

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

    Definition Classes
      WSRequest

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

    Definition Classes
      WSRequest

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

    Definition Classes
      WSRequest

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

    Definition Classes
      WSRequest

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

    Definition Classes
      WSRequest

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

    Definition Classes
      WSRequest

26. #### 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 doPatch[A](url: String, body: A)(implicit rds: Writes[A], hc: HeaderCarrier): Future[HttpResponse]

   Definition Classes
     WSPatch → PatchHttpTransport

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

   Definition Classes
     AnyRef

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

   Definition Classes
     AnyRef → Any

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

    Definition Classes
      WSRequest

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

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

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

    Definition Classes
      WSRequest

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

    Definition Classes
      AnyRef → Any

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

    Definition Classes
      AnyRef → Any

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

    Definition Classes
      WSRequest

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

    Definition Classes
      Any

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

    Definition Classes
      AnyRef

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

    Definition Classes
      AnyRef

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

    Definition Classes
      AnyRef

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

    Definition Classes
      WSRequest

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

    Definition Classes
      WSRequest

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

    Definition Classes
      WSRequest

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

    Definition Classes
      WSRequest

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

    Definition Classes
      WSRequest

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

    Definition Classes
      WSRequest

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

    Definition Classes
      WSRequest

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

    Definition Classes
      WSRequest

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

    Definition Classes
      WSRequest

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

    Definition Classes
      WSRequest

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

    Definition Classes
      AnyRef

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

    Definition Classes
      AnyRef → Any

32. #### lazy val uri: URI

    Definition Classes
      WSRequest

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

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

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

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

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

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

36. #### 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 WSRequest

### Inherited from PatchHttpTransport

### Inherited from CorePatch

### Inherited from AnyRef

### Inherited from Any

### Ungrouped