play-ws-standalone
API
Generated with
play-ws-standalone/play.api.libs.ws/StandaloneWSRequest

StandaloneWSRequest

play.api.libs.ws.StandaloneWSRequest
trait StandaloneWSRequest

A WS Request builder.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Type members

Types

type Self <: StandaloneWSRequest { type Self = Self; }

Value members

Abstract methods

def auth: Option[(String, String, WSAuthScheme)]

The authentication this request should use

The authentication this request should use

Attributes

def body: WSBody

The body of this request

The body of this request

Attributes

def calc: Option[WSSignatureCalculator]

A calculator of the signature for this request

A calculator of the signature for this request

Attributes

def contentType: Option[String]

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

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

Attributes

def cookies: Seq[WSCookie]

The cookies for this request

The cookies for this request

Attributes

def delete(): Future[Response]

Perform a DELETE on the request asynchronously.

Perform a DELETE on the request asynchronously.

Attributes

def execute(method: String): Future[Response]

Executes the given HTTP method.

Executes the given HTTP method.

Value parameters

method

the HTTP method that will be executed

Attributes

Returns

a future with the response for this request

def execute(): Future[Response]

Execute this request

Execute this request

Attributes

def followRedirects: Option[Boolean]

Whether this request should follow redirects

Whether this request should follow redirects

Attributes

def get(): Future[Response]

Performs a GET.

Performs a GET.

Attributes

def head(): Future[Response]

Perform a HEAD on the request asynchronously.

Perform a HEAD on the request asynchronously.

Attributes

def headers: Map[String, Seq[String]]

The headers for this request

The headers for this request

Attributes

def method: String

The method for this request

The method for this request

Attributes

def options(): Future[Response]

Perform a OPTIONS on the request asynchronously.

Perform a OPTIONS on the request asynchronously.

Attributes

def patch[T : BodyWritable](body: T): Future[Response]

Performs a PATCH request.

Performs a PATCH request.

Value parameters

body

the payload body submitted with this request

Attributes

Returns

a future with the response for the PATCH request

def post[T : BodyWritable](body: T): Future[Response]

Performs a POST request.

Performs a POST request.

Value parameters

body

the payload body submitted with this request

Attributes

Returns

a future with the response for the POST request

def proxyServer: Option[WSProxyServer]

The proxy server this request will use

The proxy server this request will use

Attributes

def put[T : BodyWritable](body: T): Future[Response]

Performs a PUT request.

Performs a PUT request.

Value parameters

body

the payload body submitted with this request

Attributes

Returns

a future with the response for the PUT request

def queryString: Map[String, Seq[String]]

The query string for this request

The query string for this request

Attributes

def requestTimeout: Option[Duration]

The timeout for the request

The timeout for the request

Attributes

def sign(calc: WSSignatureCalculator): Self

sets the signature calculator for the request

sets the signature calculator for the request

Value parameters

calc

the signature calculator

Attributes

def stream(): Future[Response]

Execute this request and stream the response body.

Execute this request and stream the response body.

Attributes

def uri: URI

The URI for this request

The URI for this request

Attributes

def url: String

The base URL for this request

The base URL for this request

Attributes

def virtualHost: Option[String]

The virtual host this request will use

The virtual host this request will use

Attributes

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

sets the authentication realm

sets the authentication realm

Attributes

def withBody[T : BodyWritable](body: T): Self

Sets the body for this request.

Sets the body for this request.

Attributes

def withCookies(cookies: WSCookie*): Self

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.

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.

Value parameters

cookies

the cookies to be used

Attributes

def withDisableUrlEncoding(disableUrlEncoding: Boolean): Self

Sets whether url encoding should be disabled

Sets whether url encoding should be disabled

Attributes

def withFollowRedirects(follow: Boolean): Self

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

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

Attributes

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.

Value parameters

headers

the headers to be used

Attributes

def withMethod(method: String): Self

Sets the method for this request

Sets the method for this request

Attributes

def withProxyServer(proxyServer: WSProxyServer): Self

Sets the proxy server to use in this request

Sets the proxy server to use in this request

Attributes

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.

Value parameters

parameters

the query string parameters

Attributes

def withRequestFilter(filter: WSRequestFilter): Self

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.

Attributes

def withRequestTimeout(timeout: Duration): Self

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.

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.

Attributes

def withUrl(url: String): Self

Sets the url for this request.

Sets the url for this request.

Attributes

def withVirtualHost(vh: String): Self

Sets the virtual host to use in this request

Sets the virtual host to use in this request

Attributes

Concrete methods

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.

Value parameters

cookies

the cookies to be used

Attributes

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.

Value parameters

hdrs

the headers to be added

Attributes

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.

Value parameters

parameters

the query string parameters

Attributes

def header(name: String): Option[String]

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.

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.

Value parameters

name

the header name

Attributes

Returns

the header value

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

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.

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.

Value parameters

name

the header name.

Attributes

Returns

all the values for this header name.

Generated with