Trait

play.api.libs.ws

StandaloneWSRequest

Related Doc: package ws

Permalink

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. All

Type Members

  1. abstract type Response <: StandaloneWSResponse

    Permalink
  2. abstract type Self <: StandaloneWSRequest { type Self <: StandaloneWSRequest.this.Self }

    Permalink

Abstract Value Members

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

    Permalink

    The authentication this request should use

  2. abstract def body: WSBody

    Permalink

    The body of this request

  3. abstract def calc: Option[WSSignatureCalculator]

    Permalink

    A calculator of the signature for this request

  4. abstract def contentType: Option[String]

    Permalink

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

  5. abstract def cookies: Seq[WSCookie]

    Permalink

    The cookies for this request

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

    Permalink

    Perform a DELETE on the request asynchronously.

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

    Permalink

    Execute this request

  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

  9. abstract def followRedirects: Option[Boolean]

    Permalink

    Whether this request should follow redirects

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

    Permalink

    Performs a GET.

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

    Permalink

    Perform a HEAD on the request asynchronously.

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

    Permalink

    The headers for this request

  13. abstract def method: String

    Permalink

    The method for this request

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

    Permalink

    Perform a OPTIONS on the request asynchronously.

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

    Permalink

    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]

    Permalink

    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]

    Permalink

    The proxy server this request will use

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

    Permalink

    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]]

    Permalink

    The query string for this request

  20. abstract def requestTimeout: Option[Int]

    Permalink

    The timeout for the request

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

    Permalink

    sets the signature calculator for the request

    sets the signature calculator for the request

    calc

    the signature calculator

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

    Permalink

    Execute this request and stream the response body.

  23. abstract def uri: URI

    Permalink

    The URI for this request

  24. abstract def url: String

    Permalink

    The base URL for this request

  25. abstract def virtualHost: Option[String]

    Permalink

    The virtual host this request will use

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

    Permalink

    sets the authentication realm

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

    Permalink

    Sets the body for this request.

  28. abstract def withCookies(cookies: WSCookie*): 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.

    cookies

    the cookies to be used

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

    Permalink

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

  30. 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

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

    Permalink

    Sets the method for this request

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

    Permalink

    Sets the proxy server to use in this request

  33. 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

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

    Permalink

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

  35. 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.

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

    Permalink

    Sets the virtual host to use in this request

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

    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

    Permalink

    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

    Permalink

    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

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

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

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

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

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

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

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

    Permalink

    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

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

    Permalink

    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.

  16. final def isInstanceOf[T0]: Boolean

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

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

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

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

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped