root
API
Generated with
root/play.api.libs.ws/WSRequest

WSRequest

play.api.libs.ws.WSRequest
trait WSRequest extends StandaloneWSRequest, WSBodyWritables

A WS Request builder.

Attributes

Graph
Supertypes
trait XMLBodyWritables
trait JsonBodyWritables
trait DefaultBodyWritables
trait StandaloneWSRequest
class Object
trait Matchable
class Any
Show all

Members list

Type members

Types

override type Response = WSResponse
override type Self = WSRequest

Value members

Abstract methods

override def addCookies(cookies: WSCookie*): Self

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

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

Value parameters

cookies

the cookies to be used

Attributes

Definition Classes
StandaloneWSRequest
override def auth: Option[(String, String, WSAuthScheme)]

The authentication this request should use

The authentication this request should use

Attributes

Definition Classes
StandaloneWSRequest
override def body: WSBody

The body of this request

The body of this request

Attributes

Definition Classes
StandaloneWSRequest
override def calc: Option[WSSignatureCalculator]

A calculator of the signature for this request

A calculator of the signature for this request

Attributes

Definition Classes
StandaloneWSRequest
override def delete(): Future[Response]

Perform a DELETE on the request asynchronously.

Perform a DELETE on the request asynchronously.

Attributes

Definition Classes
StandaloneWSRequest
override 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

Definition Classes
StandaloneWSRequest
override def execute(): Future[Response]

Execute this request

Execute this request

Attributes

Definition Classes
StandaloneWSRequest
override def followRedirects: Option[Boolean]

Whether this request should follow redirects

Whether this request should follow redirects

Attributes

Definition Classes
StandaloneWSRequest
override def get(): Future[Response]

performs a get

performs a get

Attributes

Definition Classes
StandaloneWSRequest
override def head(): Future[Response]

Perform a HEAD on the request asynchronously.

Perform a HEAD on the request asynchronously.

Attributes

Definition Classes
StandaloneWSRequest
override def headers: Map[String, Seq[String]]

The headers for this request

The headers for this request

Attributes

Definition Classes
StandaloneWSRequest
override def method: String

The method for this request

The method for this request

Attributes

Definition Classes
StandaloneWSRequest
override def options(): Future[Response]

Perform a OPTIONS on the request asynchronously.

Perform a OPTIONS on the request asynchronously.

Attributes

Definition Classes
StandaloneWSRequest
override def patch[T : BodyWritable](body: T): Future[Response]

Performs a PATCH request.

Performs a PATCH request.

Value parameters

body

the payload wsBody submitted with this request

Attributes

Returns

a future with the response for the PATCH request

Definition Classes
StandaloneWSRequest
def patch(body: File): Future[Response]

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

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

Attributes

def patch(body: Source[Part[Source[ByteString, _]], _]): Future[Response]

Perform a PATCH on the request asynchronously.

Perform a PATCH on the request asynchronously.

Attributes

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

Performs a POST request.

Performs a POST request.

Value parameters

body

the payload wsBody submitted with this request

Attributes

Returns

a future with the response for the POST request

Definition Classes
StandaloneWSRequest
def post(body: File): Future[Response]

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

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

Attributes

def post(body: Source[Part[Source[ByteString, _]], _]): Future[Response]

Perform a POST on the request asynchronously.

Perform a POST on the request asynchronously.

Attributes

override def proxyServer: Option[WSProxyServer]

The proxy server this request will use

The proxy server this request will use

Attributes

Definition Classes
StandaloneWSRequest
override def put[T : BodyWritable](body: T): Future[Response]

Performs a PUT request.

Performs a PUT request.

Value parameters

body

the payload wsBody submitted with this request

Attributes

Returns

a future with the response for the PUT request

Definition Classes
StandaloneWSRequest
def put(body: File): Future[Response]

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

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

Attributes

def put(body: Source[Part[Source[ByteString, _]], _]): Future[Response]

Perform a PUT on the request asynchronously.

Perform a PUT on the request asynchronously.

Attributes

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

The query string for this request

The query string for this request

Attributes

Definition Classes
StandaloneWSRequest
override def requestTimeout: Option[Duration]

The timeout for the request

The timeout for the request

Attributes

Definition Classes
StandaloneWSRequest
override def sign(calc: WSSignatureCalculator): Self

sets the signature calculator for the request

sets the signature calculator for the request

Attributes

Definition Classes
StandaloneWSRequest
override def virtualHost: Option[String]

The virtual host this request will use

The virtual host this request will use

Attributes

Definition Classes
StandaloneWSRequest
override def withAuth(username: String, password: String, scheme: WSAuthScheme): Self

sets the authentication realm

sets the authentication realm

Attributes

Definition Classes
StandaloneWSRequest
override def withBody[T : BodyWritable](body: T): Self

Sets the body for this request

Sets the body for this request

Attributes

Definition Classes
StandaloneWSRequest
override def withCookies(cookie: WSCookie*): Self

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

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

Value parameters

cookie

the cookies to be used

Attributes

Definition Classes
StandaloneWSRequest
override def withFollowRedirects(follow: Boolean): Self

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

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

Attributes

Definition Classes
StandaloneWSRequest
override 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

Definition Classes
StandaloneWSRequest
override def withMethod(method: String): Self

Sets the method for this request

Sets the method for this request

Attributes

Definition Classes
StandaloneWSRequest
override def withProxyServer(proxyServer: WSProxyServer): Self

Sets the proxy server to use in this request

Sets the proxy server to use in this request

Attributes

Definition Classes
StandaloneWSRequest
override 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

Definition Classes
StandaloneWSRequest
override 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

Definition Classes
StandaloneWSRequest
override 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

Definition Classes
StandaloneWSRequest
override def withVirtualHost(vh: String): Self

Sets the virtual host to use in this request

Sets the virtual host to use in this request

Attributes

Definition Classes
StandaloneWSRequest

Deprecated methods

def withHeaders(headers: (String, String)*): Self

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

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

Value parameters

headers

the headers to be used

Attributes

Deprecated
true
def withQueryString(parameters: (String, String)*): Self

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.

Value parameters

parameters

the query string parameters

Attributes

Deprecated
true

Inherited methods

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

Inherited from:
StandaloneWSRequest
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

Inherited from:
StandaloneWSRequest
def body(objectMapper: ObjectMapper): BodyWritable[JsonNode]

Attributes

Inherited from:
JsonBodyWritables
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

Inherited from:
StandaloneWSRequest
def cookies: Seq[WSCookie]

The cookies for this request

The cookies for this request

Attributes

Inherited from:
StandaloneWSRequest
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

Inherited from:
StandaloneWSRequest
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.

Inherited from:
StandaloneWSRequest
def stream(): Future[Response]

Execute this request and stream the response body.

Execute this request and stream the response body.

Attributes

Inherited from:
StandaloneWSRequest
def uri: URI

The URI for this request

The URI for this request

Attributes

Inherited from:
StandaloneWSRequest
def url: String

The base URL for this request

The base URL for this request

Attributes

Inherited from:
StandaloneWSRequest
def withDisableUrlEncoding(disableUrlEncoding: Boolean): Self

Sets whether url encoding should be disabled

Sets whether url encoding should be disabled

Attributes

Inherited from:
StandaloneWSRequest
def withUrl(url: String): Self

Sets the url for this request.

Sets the url for this request.

Attributes

Inherited from:
StandaloneWSRequest

Implicits

Inherited implicits

implicit val bodyWritableOf_Multipart: BodyWritable[Source[Part[Source[ByteString, _]], _]]

Attributes

Inherited from:
WSBodyWritables
implicit val writableOf_File: BodyWritable[File]

Creates an SourceBody with "application/octet-stream" content type from a file.

Creates an SourceBody with "application/octet-stream" content type from a file.

Attributes

Inherited from:
DefaultBodyWritables
implicit val writableOf_InputStream: BodyWritable[Supplier[InputStream]]

Creates an SourceBody with "application/octet-stream" content type from an inputstream.

Creates an SourceBody with "application/octet-stream" content type from an inputstream.

Attributes

Inherited from:
DefaultBodyWritables
implicit val writableOf_Source: BodyWritable[Source[ByteString, _]]

Creates an SourceBody with "application/octet-stream" content type from a file.

Creates an SourceBody with "application/octet-stream" content type from a file.

Attributes

Inherited from:
DefaultBodyWritables
implicit val writeableOf_ByteArray: BodyWritable[Array[Byte]]

Creates an InMemoryBody with "application/octet-stream" content type from an array of bytes.

Creates an InMemoryBody with "application/octet-stream" content type from an array of bytes.

Attributes

Inherited from:
DefaultBodyWritables
implicit val writeableOf_ByteBuffer: BodyWritable[ByteBuffer]

Creates an InMemoryBody with "application/octet-stream" content type from a bytebuffer.

Creates an InMemoryBody with "application/octet-stream" content type from a bytebuffer.

Attributes

Inherited from:
DefaultBodyWritables
implicit val writeableOf_Bytes: BodyWritable[ByteString]

Creates an InMemoryBody with "application/octet-stream" content type.

Creates an InMemoryBody with "application/octet-stream" content type.

Attributes

Inherited from:
DefaultBodyWritables
implicit val writeableOf_Document: BodyWritable[Document]

Creates an InMemoryBody with "text/xml" content type.

Creates an InMemoryBody with "text/xml" content type.

Attributes

Inherited from:
XMLBodyWritables
implicit val writeableOf_JsValue: BodyWritable[JsValue]

Creates an InMemoryBody with "application/json" content type, using the static ObjectMapper.

Creates an InMemoryBody with "application/json" content type, using the static ObjectMapper.

Attributes

Inherited from:
JsonBodyWritables
implicit val writeableOf_NodeBuffer: BodyWritable[NodeBuffer]

Creates an InMemoryBody with "text/xml" content type.

Creates an InMemoryBody with "text/xml" content type.

Attributes

Inherited from:
XMLBodyWritables
implicit def writeableOf_NodeSeq[C <: NodeSeq]: BodyWritable[C]

Creates an InMemoryBody with "text/xml" content type.

Creates an InMemoryBody with "text/xml" content type.

Attributes

Inherited from:
XMLBodyWritables
implicit val writeableOf_String: BodyWritable[String]

Creates an InMemoryBody with "text/plain" content type.

Creates an InMemoryBody with "text/plain" content type.

Attributes

Inherited from:
DefaultBodyWritables
implicit val writeableOf_StringBuilder: BodyWritable[StringBuilder]

Creates an InMemoryBody with "text/plain" content type from a StringBuilder

Creates an InMemoryBody with "text/plain" content type from a StringBuilder

Attributes

Inherited from:
DefaultBodyWritables
implicit val writeableOf_WsBody: BodyWritable[WSBody]

Creates a BodyWritable with an identity function, with "application/octet-stream" content type.

Creates a BodyWritable with an identity function, with "application/octet-stream" content type.

Attributes

Inherited from:
DefaultBodyWritables
implicit val writeableOf_urlEncodedForm: BodyWritable[Map[String, Seq[String]]]

Creates an InMemoryBody with "application/x-www-form-urlencoded" content type.

Creates an InMemoryBody with "application/x-www-form-urlencoded" content type.

Attributes

Inherited from:
DefaultBodyWritables
implicit val writeableOf_urlEncodedSimpleForm: BodyWritable[Map[String, String]]

Attributes

Inherited from:
DefaultBodyWritables
Generated with