play.api.libs.ws

WSRequestHolder

trait WSRequestHolder extends AnyRef

A WS Request builder.

Source
WS.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. WSRequestHolder
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

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

    The authentication this request should use

  2. abstract val body: WSBody

    The body of this request

  3. abstract val calc: Option[WSSignatureCalculator]

    A calculator of the signature for this request

  4. abstract def execute(): Future[WSResponse]

    Execute this request

  5. abstract val followRedirects: Option[Boolean]

    Whether this request should follow redirects

  6. abstract val headers: Map[String, Seq[String]]

    The headers for this request

  7. abstract val method: String

    The method for this request

  8. abstract val proxyServer: Option[WSProxyServer]

    The proxy server this request will use

  9. abstract val queryString: Map[String, Seq[String]]

    The query string for this request

  10. abstract val requestTimeout: Option[Int]

    The timeout for the request

  11. abstract def sign(calc: WSSignatureCalculator): WSRequestHolder

    sets the signature calculator for the request

    sets the signature calculator for the request

    calc

  12. abstract def stream(): Future[(WSResponseHeaders, Enumerator[Array[Byte]])]

    Execute this request and stream the response body in an enumerator

  13. abstract val url: String

    The URL for this request

  14. abstract val virtualHost: Option[String]

    The virtual host this request will use

  15. abstract def withAuth(username: String, password: String, scheme: WSAuthScheme): WSRequestHolder

    sets the authentication realm

  16. abstract def withBody(body: WSBody): WSRequestHolder

    Sets the body for this request

  17. abstract def withFollowRedirects(follow: Boolean): WSRequestHolder

    Sets whether redirects (301, 302) should be followed automatically

  18. abstract def withHeaders(hdrs: (String, String)*): WSRequestHolder

    adds any number of HTTP headers

    adds any number of HTTP headers

    hdrs

  19. abstract def withMethod(method: String): WSRequestHolder

    Sets the method for this request

  20. abstract def withProxyServer(proxyServer: WSProxyServer): WSRequestHolder

    Sets the proxy server to use in this request

  21. abstract def withQueryString(parameters: (String, String)*): WSRequestHolder

    adds any number of query string parameters to the

  22. abstract def withRequestTimeout(timeout: Int): WSRequestHolder

    Sets the maximum time in milliseconds you expect the request to take.

    Sets the maximum time in milliseconds you expect the request to take. Warning: a stream consumption will be interrupted when this time is reached.

  23. abstract def withVirtualHost(vh: String): WSRequestHolder

    Sets the virtual host to use in this request

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def delete(): Future[WSResponse]

    Perform a DELETE on the request asynchronously.

  9. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  11. def execute(method: String): Future[WSResponse]

  12. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. def get[A](consumer: (WSResponseHeaders) ⇒ Iteratee[Array[Byte], A])(implicit ec: ExecutionContext): Future[Iteratee[Array[Byte], A]]

    performs a get

    performs a get

    consumer

    that's handling the response

  14. def get(): Future[WSResponse]

    performs a get

  15. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  16. def getStream(): Future[(WSResponseHeaders, Enumerator[Array[Byte]])]

    performs a get

  17. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  18. def head(): Future[WSResponse]

    Perform a HEAD on the request asynchronously.

  19. final def isInstanceOf[T0]: Boolean

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

    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  23. def options(): Future[WSResponse]

    Perform a OPTIONS on the request asynchronously.

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

    Perform a PATCH on the request asynchronously.

    Perform a PATCH on the request asynchronously. Request body won't be chunked

  25. def patch[T](body: T)(implicit wrt: Writeable[T], ct: ContentTypeOf[T]): Future[WSResponse]

    Perform a PATCH on the request asynchronously.

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

    performs a POST with supplied body

    performs a POST with supplied body

    consumer

    that's handling the response

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

    Perform a POST on the request asynchronously.

    Perform a POST on the request asynchronously. Request body won't be chunked

  28. def post[T](body: T)(implicit wrt: Writeable[T], ct: ContentTypeOf[T]): Future[WSResponse]

    Perform a POST on the request asynchronously.

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

    performs a POST with supplied body

    performs a POST with supplied body

    consumer

    that's handling the response

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

    Perform a PUT on the request asynchronously.

    Perform a PUT on the request asynchronously. Request body won't be chunked

  31. def put[T](body: T)(implicit wrt: Writeable[T], ct: ContentTypeOf[T]): Future[WSResponse]

    Perform a PUT on the request asynchronously.

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

    performs a PUT with supplied body

    performs a PUT with supplied body

    consumer

    that's handling the response

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

    Definition Classes
    AnyRef
  34. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. def withBody[T](body: T)(implicit wrt: Writeable[T], ct: ContentTypeOf[T]): WSRequestHolder

    Sets the body for this request

Deprecated Value Members

  1. def withTimeout(timeout: Int): WSRequestHolder

    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) use withRequestTimeout instead

Inherited from AnyRef

Inherited from Any

Ungrouped