t

play.api.libs.ws

StandaloneWSRequest

trait StandaloneWSRequest extends AnyRef

A WS Request builder.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StandaloneWSRequest
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. abstract type Response <: StandaloneWSResponse
  2. abstract type Self <: StandaloneWSRequest { type Self = StandaloneWSRequest.this.Self }

Abstract Value Members

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

    The authentication this request should use

  2. abstract def body: WSBody

    The body of this request

  3. abstract def calc: Option[WSSignatureCalculator]

    A calculator of the signature for this request

  4. abstract def contentType: Option[String]

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

  5. abstract def cookies: Seq[WSCookie]

    The cookies for this request

  6. abstract def delete(): Future[Response]

    Perform a DELETE on the request asynchronously.

  7. abstract def execute(): Future[Response]

    Execute this request

  8. abstract def execute(method: String): Future[Response]

    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

  9. abstract def followRedirects: Option[Boolean]

    Whether this request should follow redirects

  10. abstract def get(): Future[Response]

    Performs a GET.

  11. abstract def head(): Future[Response]

    Perform a HEAD on the request asynchronously.

  12. abstract def headers: Map[String, Seq[String]]

    The headers for this request

  13. abstract def method: String

    The method for this request

  14. abstract def options(): Future[Response]

    Perform a OPTIONS on the request asynchronously.

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

    Performs a PATCH request.

    Performs a PATCH request.

    body

    the payload body submitted with this request

    returns

    a future with the response for the PATCH request

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

    Performs a POST request.

    Performs a POST request.

    body

    the payload body submitted with this request

    returns

    a future with the response for the POST request

  17. abstract def proxyServer: Option[WSProxyServer]

    The proxy server this request will use

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

    Performs a PUT request.

    Performs a PUT request.

    body

    the payload body submitted with this request

    returns

    a future with the response for the PUT request

  19. abstract def queryString: Map[String, Seq[String]]

    The query string for this request

  20. abstract def requestTimeout: Option[Duration]

    The timeout for the request

  21. abstract def sign(calc: WSSignatureCalculator): Self

    sets the signature calculator for the request

    sets the signature calculator for the request

    calc

    the signature calculator

  22. abstract def stream(): Future[Response]

    Execute this request and stream the response body.

  23. abstract def uri: URI

    The URI for this request

  24. abstract def url: String

    The base URL for this request

  25. abstract def virtualHost: Option[String]

    The virtual host this request will use

  26. abstract def withAuth(username: String, password: String, scheme: WSAuthScheme): Self

    sets the authentication realm

  27. abstract def withBody[T](body: T)(implicit arg0: BodyWritable[T]): Self

    Sets the body for this request.

  28. abstract def withCookies(cookies: WSCookie*): Self

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

    Returns this request with the given cookies, discarding the existing ones. In general, cookies set on a request are used only on that request and then discarded. But when play.ws.ahc.useCookieStore is enabled, there will be a global cookie store that keeps cookies between requests.

    cookies

    the cookies to be used

  29. abstract def withDisableUrlEncoding(disableUrlEncoding: Boolean): Self

    Sets whether url encoding should be disabled

  30. abstract def withFollowRedirects(follow: Boolean): Self

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

  31. abstract def withHttpHeaders(headers: (String, String)*): Self

    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

  32. abstract def withMethod(method: String): Self

    Sets the method for this request

  33. abstract def withProxyServer(proxyServer: WSProxyServer): Self

    Sets the proxy server to use in this request

  34. abstract def withQueryStringParameters(parameters: (String, String)*): Self

    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

  35. abstract def withRequestFilter(filter: WSRequestFilter): Self

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

  36. abstract def withRequestTimeout(timeout: Duration): Self

    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.

  37. abstract def withUrl(url: String): Self

    Sets the url for this request.

  38. abstract def withVirtualHost(vh: String): Self

    Sets the virtual host to use in this request

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

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

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

    cookies

    the cookies to be used

  5. def addHttpHeaders(hdrs: (String, String)*): Self

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

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

    hdrs

    the headers to be added

  6. def addQueryStringParameters(parameters: (String, String)*): Self

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

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

    parameters

    the query string parameters

  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  13. def header(name: String): Option[String]

    Get the value of the header with the specified name.

    Get the value of the header with the specified name. If there are more than one values for this header, the first value is returned. If there are no values, than a None is returned.

    name

    the header name

    returns

    the header value

  14. def headerValues(name: String): Seq[String]

    Get all the values of header with the specified name.

    Get all the values of header with the specified name. If there are no values for the header with the specified name, than an empty sequence is returned.

    name

    the header name.

    returns

    all the values for this header name.

  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped