Trait

play.api.libs.ws

WSRequest

Related Doc: package ws

Permalink

trait WSRequest extends StandaloneWSRequest with WSBodyWritables

A WS Request builder.

Source
WSRequest.scala
Linear Supertypes
WSBodyWritables, XMLBodyWritables, JsonBodyWritables, DefaultBodyWritables, StandaloneWSRequest, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WSRequest
  2. WSBodyWritables
  3. XMLBodyWritables
  4. JsonBodyWritables
  5. DefaultBodyWritables
  6. StandaloneWSRequest
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type Response = WSResponse

    Permalink
    Definition Classes
    WSRequest → StandaloneWSRequest
  2. type Self = WSRequest

    Permalink
    Definition Classes
    WSRequest → StandaloneWSRequest

Abstract Value Members

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

    Permalink

    The authentication this request should use

    The authentication this request should use

    Definition Classes
    WSRequest → StandaloneWSRequest
  2. abstract def body: WSBody

    Permalink

    The body of this request

    The body of this request

    Definition Classes
    WSRequest → StandaloneWSRequest
  3. abstract def calc: Option[WSSignatureCalculator]

    Permalink

    A calculator of the signature for this request

    A calculator of the signature for this request

    Definition Classes
    WSRequest → StandaloneWSRequest
  4. abstract def contentType: Option[String]

    Permalink
    Definition Classes
    StandaloneWSRequest
  5. abstract def cookies: Seq[WSCookie]

    Permalink
    Definition Classes
    StandaloneWSRequest
  6. abstract def delete(): Future[Response]

    Permalink

    Perform a DELETE on the request asynchronously.

    Perform a DELETE on the request asynchronously.

    Definition Classes
    WSRequest → StandaloneWSRequest
  7. abstract def execute(): Future[Response]

    Permalink

    Execute this request

    Execute this request

    Definition Classes
    WSRequest → StandaloneWSRequest
  8. abstract def execute(method: String): Future[Response]

    Permalink

    Executes the given HTTP method.

    Executes the given HTTP method.

    method

    the HTTP method that will be executed

    returns

    a future with the response for this request

    Definition Classes
    WSRequest → StandaloneWSRequest
  9. abstract def followRedirects: Option[Boolean]

    Permalink

    Whether this request should follow redirects

    Whether this request should follow redirects

    Definition Classes
    WSRequest → StandaloneWSRequest
  10. abstract def get(): Future[Response]

    Permalink

    performs a get

    performs a get

    Definition Classes
    WSRequest → StandaloneWSRequest
  11. abstract def head(): Future[Response]

    Permalink

    Perform a HEAD on the request asynchronously.

    Perform a HEAD on the request asynchronously.

    Definition Classes
    WSRequest → StandaloneWSRequest
  12. abstract def headers: Map[String, Seq[String]]

    Permalink

    The headers for this request

    The headers for this request

    Definition Classes
    WSRequest → StandaloneWSRequest
  13. abstract def method: String

    Permalink

    The method for this request

    The method for this request

    Definition Classes
    WSRequest → StandaloneWSRequest
  14. abstract def options(): Future[Response]

    Permalink

    Perform a OPTIONS on the request asynchronously.

    Perform a OPTIONS on the request asynchronously.

    Definition Classes
    WSRequest → StandaloneWSRequest
  15. abstract def patch(body: Source[Part[Source[ByteString, _]], _]): Future[Response]

    Permalink

    Perform a PATCH on the request asynchronously.

  16. abstract def patch(body: File): Future[Response]

    Permalink

    Perform a PATCH on the request asynchronously.

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

  17. abstract def patch[T](body: T)(implicit arg0: BodyWritable[T]): Future[Response]

    Permalink

    Performs a PATCH request.

    Performs a PATCH request.

    body

    the payload wsBody submitted with this request

    returns

    a future with the response for the PATCH request

    Definition Classes
    WSRequest → StandaloneWSRequest
  18. abstract def post(body: Source[Part[Source[ByteString, _]], _]): Future[Response]

    Permalink

    Perform a POST on the request asynchronously.

  19. abstract def post(body: File): Future[Response]

    Permalink

    Perform a POST on the request asynchronously.

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

  20. abstract def post[T](body: T)(implicit arg0: BodyWritable[T]): Future[Response]

    Permalink

    Performs a POST request.

    Performs a POST request.

    body

    the payload wsBody submitted with this request

    returns

    a future with the response for the POST request

    Definition Classes
    WSRequest → StandaloneWSRequest
  21. abstract def proxyServer: Option[WSProxyServer]

    Permalink

    The proxy server this request will use

    The proxy server this request will use

    Definition Classes
    WSRequest → StandaloneWSRequest
  22. abstract def put(body: Source[Part[Source[ByteString, _]], _]): Future[Response]

    Permalink

    Perform a PUT on the request asynchronously.

  23. abstract def put(body: File): Future[Response]

    Permalink

    Perform a PUT on the request asynchronously.

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

  24. abstract def put[T](body: T)(implicit arg0: BodyWritable[T]): Future[Response]

    Permalink

    Performs a PUT request.

    Performs a PUT request.

    body

    the payload wsBody submitted with this request

    returns

    a future with the response for the PUT request

    Definition Classes
    WSRequest → StandaloneWSRequest
  25. abstract def queryString: Map[String, Seq[String]]

    Permalink

    The query string for this request

    The query string for this request

    Definition Classes
    WSRequest → StandaloneWSRequest
  26. abstract def requestTimeout: Option[Int]

    Permalink

    The timeout for the request

    The timeout for the request

    Definition Classes
    WSRequest → StandaloneWSRequest
  27. abstract def sign(calc: WSSignatureCalculator): Self

    Permalink

    sets the signature calculator for the request

    sets the signature calculator for the request

    Definition Classes
    WSRequest → StandaloneWSRequest
  28. abstract def stream(): Future[Response]

    Permalink
    Definition Classes
    StandaloneWSRequest
  29. abstract def uri: URI

    Permalink
    Definition Classes
    StandaloneWSRequest
  30. abstract def url: String

    Permalink
    Definition Classes
    StandaloneWSRequest
  31. abstract def virtualHost: Option[String]

    Permalink

    The virtual host this request will use

    The virtual host this request will use

    Definition Classes
    WSRequest → StandaloneWSRequest
  32. abstract def withAuth(username: String, password: String, scheme: WSAuthScheme): Self

    Permalink

    sets the authentication realm

    sets the authentication realm

    Definition Classes
    WSRequest → StandaloneWSRequest
  33. abstract def withBody[T](body: T)(implicit arg0: BodyWritable[T]): Self

    Permalink

    Sets the body for this request

    Sets the body for this request

    Definition Classes
    WSRequest → StandaloneWSRequest
  34. abstract def withCookies(cookie: WSCookie*): Self

    Permalink

    Returns this request with the given cookies, discarding the existing ones.

    Returns this request with the given cookies, discarding the existing ones.

    cookie

    the cookies to be used

    Definition Classes
    WSRequest → StandaloneWSRequest
  35. abstract def withFollowRedirects(follow: Boolean): Self

    Permalink

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

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

    Definition Classes
    WSRequest → StandaloneWSRequest
  36. abstract def withHttpHeaders(headers: (String, String)*): Self

    Permalink

    Returns this request with the given headers, discarding the existing ones.

    Returns this request with the given headers, discarding the existing ones.

    headers

    the headers to be used

    Definition Classes
    WSRequest → StandaloneWSRequest
  37. abstract def withMethod(method: String): Self

    Permalink

    Sets the method for this request

    Sets the method for this request

    Definition Classes
    WSRequest → StandaloneWSRequest
  38. abstract def withProxyServer(proxyServer: WSProxyServer): Self

    Permalink

    Sets the proxy server to use in this request

    Sets the proxy server to use in this request

    Definition Classes
    WSRequest → StandaloneWSRequest
  39. abstract def withQueryStringParameters(parameters: (String, String)*): Self

    Permalink

    Returns this request with the given query string parameters, discarding the existing ones.

    Returns this request with the given query string parameters, discarding the existing ones.

    parameters

    the query string parameters

    Definition Classes
    WSRequest → StandaloneWSRequest
  40. abstract def withRequestFilter(filter: WSRequestFilter): Self

    Permalink

    Adds a filter to the request that can transform the request for subsequent filters.

    Adds a filter to the request that can transform the request for subsequent filters.

    Definition Classes
    WSRequest → StandaloneWSRequest
  41. abstract def withRequestTimeout(timeout: Duration): Self

    Permalink

    Sets the maximum time you expect the request to take.

    Sets the maximum time you expect the request to take. Use Duration.Inf to set an infinite request timeout. Warning: a stream consumption will be interrupted when this time is reached unless Duration.Inf is set.

    Definition Classes
    WSRequest → StandaloneWSRequest
  42. abstract def withVirtualHost(vh: String): Self

    Permalink

    Sets the virtual host to use in this request

    Sets the virtual host to use in this request

    Definition Classes
    WSRequest → StandaloneWSRequest
  43. abstract def withHeaders(headers: (String, String)*): Self

    Permalink

    Returns this request with the given headers, adding to the existing ones.

    Returns this request with the given headers, adding to the existing ones.

    headers

    the headers to be used

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use withHttpHeaders or addHttpHeaders

  44. abstract def withQueryString(parameters: (String, String)*): Self

    Permalink

    Returns this request with the given query string parameters, adding to the existing ones.

    Returns this request with the given query string parameters, adding to the existing ones.

    parameters

    the query string parameters

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use addQueryStringParameters or withQueryStringParameters

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. def addCookies(cookies: WSCookie*): Self

    Permalink
    Definition Classes
    StandaloneWSRequest
  5. def addHttpHeaders(hdrs: (String, String)*): Self

    Permalink
    Definition Classes
    StandaloneWSRequest
  6. def addQueryStringParameters(parameters: (String, String)*): Self

    Permalink
    Definition Classes
    StandaloneWSRequest
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def body(objectMapper: ObjectMapper): BodyWritable[JsonNode]

    Permalink
    Definition Classes
    JsonBodyWritables
  9. implicit val bodyWritableOf_Multipart: BodyWritable[Source[Part[Source[ByteString, _]], _]]

    Permalink
    Definition Classes
    WSBodyWritables
  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

    Permalink
    Definition Classes
    StandaloneWSRequest
  17. def headerValues(name: String): Seq[String]

    Permalink
    Definition Classes
    StandaloneWSRequest
  18. final def isInstanceOf[T0]: Boolean

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

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

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

    Permalink
    Definition Classes
    AnyRef
  22. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. implicit val writableOf_File: BodyWritable[File]

    Permalink
    Definition Classes
    DefaultBodyWritables
  28. implicit val writableOf_InputStream: BodyWritable[Supplier[InputStream]]

    Permalink
    Definition Classes
    DefaultBodyWritables
  29. implicit val writableOf_Source: BodyWritable[Source[ByteString, _]]

    Permalink
    Definition Classes
    DefaultBodyWritables
  30. implicit val writeableOf_ByteArray: BodyWritable[Array[Byte]]

    Permalink
    Definition Classes
    DefaultBodyWritables
  31. implicit val writeableOf_ByteBuffer: BodyWritable[ByteBuffer]

    Permalink
    Definition Classes
    DefaultBodyWritables
  32. implicit val writeableOf_Bytes: BodyWritable[ByteString]

    Permalink
    Definition Classes
    DefaultBodyWritables
  33. implicit val writeableOf_Document: BodyWritable[Document]

    Permalink
    Definition Classes
    XMLBodyWritables
  34. implicit val writeableOf_JsValue: BodyWritable[JsValue]

    Permalink
    Definition Classes
    JsonBodyWritables
  35. implicit val writeableOf_NodeBuffer: BodyWritable[NodeBuffer]

    Permalink
    Definition Classes
    XMLBodyWritables
  36. implicit def writeableOf_NodeSeq[C <: NodeSeq]: BodyWritable[C]

    Permalink
    Definition Classes
    XMLBodyWritables
  37. implicit val writeableOf_String: BodyWritable[String]

    Permalink
    Definition Classes
    DefaultBodyWritables
  38. implicit val writeableOf_StringBuilder: BodyWritable[StringBuilder]

    Permalink
    Definition Classes
    DefaultBodyWritables
  39. implicit val writeableOf_WsBody: BodyWritable[WSBody]

    Permalink
    Definition Classes
    DefaultBodyWritables
  40. implicit val writeableOf_urlEncodedForm: BodyWritable[Map[String, Seq[String]]]

    Permalink
    Definition Classes
    DefaultBodyWritables
  41. implicit val writeableOf_urlEncodedSimpleForm: BodyWritable[Map[String, String]]

    Permalink
    Definition Classes
    DefaultBodyWritables

Inherited from WSBodyWritables

Inherited from XMLBodyWritables

Inherited from JsonBodyWritables

Inherited from DefaultBodyWritables

Inherited from StandaloneWSRequest

Inherited from AnyRef

Inherited from Any

Ungrouped