Trait

play.api.libs.ws

WSRequest

Related Doc: package ws

Permalink

trait WSRequest extends StandaloneWSRequest

A WS Request builder.

Source
WSRequest.scala
Linear Supertypes
StandaloneWSRequest, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WSRequest
  2. StandaloneWSRequest
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type Response <: WSResponse

    Permalink
    Definition Classes
    WSRequestStandaloneWSRequest
  2. abstract type Self <: WSRequest { type Self <: WSRequest.this.Self }

    Permalink
    Definition Classes
    WSRequestStandaloneWSRequest

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
    StandaloneWSRequest
  2. abstract def body: WSBody

    Permalink

    The body of this request

    The body of this request

    Definition Classes
    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
    StandaloneWSRequest
  4. abstract def contentType: Option[String]

    Permalink

    The content type for this request, if any is defined.

    The content type for this request, if any is defined.

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

    Permalink

    Perform a DELETE on the request asynchronously.

    Perform a DELETE on the request asynchronously.

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

    Permalink

    Execute this request

    Execute this request

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

    Permalink
    Definition Classes
    StandaloneWSRequest
  8. abstract def followRedirects: Option[Boolean]

    Permalink

    Whether this request should follow redirects

    Whether this request should follow redirects

    Definition Classes
    StandaloneWSRequest
  9. abstract def get(): Future[Response]

    Permalink

    Performs a GET.

    Performs a GET.

    Definition Classes
    StandaloneWSRequest
  10. abstract def head(): Future[Response]

    Permalink

    Perform a HEAD on the request asynchronously.

    Perform a HEAD on the request asynchronously.

    Definition Classes
    StandaloneWSRequest
  11. abstract def headers: Map[String, Seq[String]]

    Permalink

    The headers for this request

    The headers for this request

    Definition Classes
    StandaloneWSRequest
  12. abstract def method: String

    Permalink

    The method for this request

    The method for this request

    Definition Classes
    StandaloneWSRequest
  13. abstract def options(): Future[Response]

    Permalink

    Perform a OPTIONS on the request asynchronously.

    Perform a OPTIONS on the request asynchronously.

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

    Permalink

    Perform a PATCH on the request asynchronously.

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

    Permalink
    Definition Classes
    StandaloneWSRequest
  16. abstract def patch[T](body: T)(implicit arg0: BodyWritable[T]): Future[Response]

    Permalink

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

    Permalink

    Perform a POST on the request asynchronously.

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

    Permalink
    Definition Classes
    StandaloneWSRequest
  19. abstract def post[T](body: T)(implicit arg0: BodyWritable[T]): Future[Response]

    Permalink

    Definition Classes
    StandaloneWSRequest
  20. abstract def proxyServer: Option[WSProxyServer]

    Permalink

    The proxy server this request will use

    The proxy server this request will use

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

    Permalink

    Perform a PUT on the request asynchronously.

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

    Permalink
    Definition Classes
    StandaloneWSRequest
  23. abstract def put[T](body: T)(implicit arg0: BodyWritable[T]): Future[Response]

    Permalink

    Definition Classes
    StandaloneWSRequest
  24. abstract def queryString: Map[String, Seq[String]]

    Permalink

    The query string for this request

    The query string for this request

    Definition Classes
    StandaloneWSRequest
  25. abstract def requestTimeout: Option[Int]

    Permalink

    The timeout for the request

    The timeout for the request

    Definition Classes
    StandaloneWSRequest
  26. abstract def sign(calc: WSSignatureCalculator): Self

    Permalink

    sets the signature calculator for the request

    sets the signature calculator for the request

    Definition Classes
    StandaloneWSRequest
  27. abstract def stream(): Future[StreamedResponse]

    Permalink

    Execute this request and stream the response body.

    Execute this request and stream the response body.

    Definition Classes
    StandaloneWSRequest
  28. abstract def uri: URI

    Permalink

    The URI for this request

    The URI for this request

    Definition Classes
    StandaloneWSRequest
  29. abstract def url: String

    Permalink

    The base URL for this request

    The base URL for this request

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

    Permalink

    The virtual host this request will use

    The virtual host this request will use

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

    Permalink

    sets the authentication realm

    sets the authentication realm

    Definition Classes
    StandaloneWSRequest
  32. abstract def withBody(body: Source[Part[Source[ByteString, _]], _]): Self

    Permalink

    Sets a multipart body for this request

  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
    StandaloneWSRequest
  34. abstract def withBody(file: File): Self

    Permalink

    Sets the body for this request

    Sets the body for this request

    Definition Classes
    StandaloneWSRequest
  35. abstract def withBody(body: WSBody): Self

    Permalink

    Sets the body for this request

    Sets the body for this request

    Definition Classes
    StandaloneWSRequest
  36. 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
    StandaloneWSRequest
  37. abstract def withHeaders(hdrs: (String, String)*): Self

    Permalink

    adds any number of HTTP headers

    adds any number of HTTP headers

    Definition Classes
    StandaloneWSRequest
  38. abstract def withMethod(method: String): Self

    Permalink

    Sets the method for this request

    Sets the method for this request

    Definition Classes
    StandaloneWSRequest
  39. 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
    StandaloneWSRequest
  40. abstract def withQueryString(parameters: (String, String)*): Self

    Permalink

    adds any number of query string parameters to this request

    adds any number of query string parameters to this request

    Definition Classes
    StandaloneWSRequest
  41. 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
    StandaloneWSRequest
  42. 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
    StandaloneWSRequest
  43. 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
    StandaloneWSRequest

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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

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

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

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

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

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

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

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

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

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

Inherited from StandaloneWSRequest

Inherited from AnyRef

Inherited from Any

Ungrouped