trait WSRequest extends StandaloneWSRequest with WSBodyWritables
- Alphabetic
- By Inheritance
- WSRequest
- WSBodyWritables
- XMLBodyWritables
- JsonBodyWritables
- DefaultBodyWritables
- StandaloneWSRequest
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
Abstract Value Members
- abstract def auth: Option[(String, String, WSAuthScheme)]
The authentication this request should use
The authentication this request should use
- Definition Classes
- WSRequest → StandaloneWSRequest
- abstract def body: WSBody
The body of this request
The body of this request
- Definition Classes
- WSRequest → StandaloneWSRequest
- abstract def calc: Option[WSSignatureCalculator]
A calculator of the signature for this request
A calculator of the signature for this request
- Definition Classes
- WSRequest → StandaloneWSRequest
- abstract def contentType: Option[String]
- Definition Classes
- StandaloneWSRequest
- abstract def cookies: Seq[WSCookie]
- Definition Classes
- StandaloneWSRequest
- abstract def delete(): Future[Response]
Perform a DELETE on the request asynchronously.
Perform a DELETE on the request asynchronously.
- Definition Classes
- WSRequest → StandaloneWSRequest
- abstract def execute(): Future[Response]
Execute this request
Execute this request
- Definition Classes
- WSRequest → StandaloneWSRequest
- 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
- Definition Classes
- WSRequest → StandaloneWSRequest
- abstract def followRedirects: Option[Boolean]
Whether this request should follow redirects
Whether this request should follow redirects
- Definition Classes
- WSRequest → StandaloneWSRequest
- abstract def get(): Future[Response]
performs a get
performs a get
- Definition Classes
- WSRequest → StandaloneWSRequest
- abstract def head(): Future[Response]
Perform a HEAD on the request asynchronously.
Perform a HEAD on the request asynchronously.
- Definition Classes
- WSRequest → StandaloneWSRequest
- abstract def headers: Map[String, Seq[String]]
The headers for this request
The headers for this request
- Definition Classes
- WSRequest → StandaloneWSRequest
- abstract def method: String
The method for this request
The method for this request
- Definition Classes
- WSRequest → StandaloneWSRequest
- abstract def options(): Future[Response]
Perform a OPTIONS on the request asynchronously.
Perform a OPTIONS on the request asynchronously.
- Definition Classes
- WSRequest → StandaloneWSRequest
- abstract def patch(body: Source[Part[Source[ByteString, _]], _]): Future[Response]
Perform a PATCH on the request asynchronously.
- abstract def patch(body: File): Future[Response]
Perform a PATCH on the request asynchronously.
Perform a PATCH on the request asynchronously. Request body won't be chunked
- abstract def patch[T](body: T)(implicit arg0: BodyWritable[T]): Future[Response]
Performs a PATCH request.
Performs a PATCH request.
- body
the payload wsBody submitted with this request
- returns
a future with the response for the PATCH request
- Definition Classes
- WSRequest → StandaloneWSRequest
- abstract def post(body: Source[Part[Source[ByteString, _]], _]): Future[Response]
Perform a POST on the request asynchronously.
- abstract def post(body: File): Future[Response]
Perform a POST on the request asynchronously.
Perform a POST on the request asynchronously. Request body won't be chunked
- abstract def post[T](body: T)(implicit arg0: BodyWritable[T]): Future[Response]
Performs a POST request.
Performs a POST request.
- body
the payload wsBody submitted with this request
- returns
a future with the response for the POST request
- Definition Classes
- WSRequest → StandaloneWSRequest
- abstract def proxyServer: Option[WSProxyServer]
The proxy server this request will use
The proxy server this request will use
- Definition Classes
- WSRequest → StandaloneWSRequest
- abstract def put(body: Source[Part[Source[ByteString, _]], _]): Future[Response]
Perform a PUT on the request asynchronously.
- abstract def put(body: File): Future[Response]
Perform a PUT on the request asynchronously.
Perform a PUT on the request asynchronously. Request body won't be chunked
- abstract def put[T](body: T)(implicit arg0: BodyWritable[T]): Future[Response]
Performs a PUT request.
Performs a PUT request.
- body
the payload wsBody submitted with this request
- returns
a future with the response for the PUT request
- Definition Classes
- WSRequest → StandaloneWSRequest
- abstract def queryString: Map[String, Seq[String]]
The query string for this request
The query string for this request
- Definition Classes
- WSRequest → StandaloneWSRequest
- abstract def requestTimeout: Option[Duration]
The timeout for the request
The timeout for the request
- Definition Classes
- WSRequest → StandaloneWSRequest
- abstract def sign(calc: WSSignatureCalculator): Self
sets the signature calculator for the request
sets the signature calculator for the request
- Definition Classes
- WSRequest → StandaloneWSRequest
- abstract def stream(): Future[Response]
- Definition Classes
- StandaloneWSRequest
- abstract def uri: URI
- Definition Classes
- StandaloneWSRequest
- abstract def url: String
- Definition Classes
- StandaloneWSRequest
- abstract def virtualHost: Option[String]
The virtual host this request will use
The virtual host this request will use
- Definition Classes
- WSRequest → StandaloneWSRequest
- abstract def withAuth(username: String, password: String, scheme: WSAuthScheme): Self
sets the authentication realm
sets the authentication realm
- Definition Classes
- WSRequest → StandaloneWSRequest
- abstract def withBody[T](body: T)(implicit arg0: BodyWritable[T]): Self
Sets the body for this request
Sets the body for this request
- Definition Classes
- WSRequest → StandaloneWSRequest
- abstract 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.
- cookie
the cookies to be used
- Definition Classes
- WSRequest → StandaloneWSRequest
- abstract def withFollowRedirects(follow: Boolean): Self
Sets whether redirects (301, 302) should be followed automatically
Sets whether redirects (301, 302) should be followed automatically
- Definition Classes
- WSRequest → StandaloneWSRequest
- 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
- Definition Classes
- WSRequest → StandaloneWSRequest
- abstract def withMethod(method: String): Self
Sets the method for this request
Sets the method for this request
- Definition Classes
- WSRequest → StandaloneWSRequest
- abstract def withProxyServer(proxyServer: WSProxyServer): Self
Sets the proxy server to use in this request
Sets the proxy server to use in this request
- Definition Classes
- WSRequest → StandaloneWSRequest
- 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
- Definition Classes
- WSRequest → StandaloneWSRequest
- abstract 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.
- Definition Classes
- WSRequest → StandaloneWSRequest
- 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.
- Definition Classes
- WSRequest → StandaloneWSRequest
- abstract def withUrl(url: String): Self
- Definition Classes
- StandaloneWSRequest
- abstract def withVirtualHost(vh: String): Self
Sets the virtual host to use in this request
Sets the virtual host to use in this request
- Definition Classes
- WSRequest → StandaloneWSRequest
- abstract 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.
- headers
the headers to be used
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.0) Use withHttpHeaders or addHttpHeaders
- abstract 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.
- parameters
the query string parameters
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.0) Use addQueryStringParameters or withQueryStringParameters
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def addCookies(cookies: WSCookie*): Self
- Definition Classes
- StandaloneWSRequest
- def addHttpHeaders(hdrs: (String, String)*): Self
- Definition Classes
- StandaloneWSRequest
- def addQueryStringParameters(parameters: (String, String)*): Self
- Definition Classes
- StandaloneWSRequest
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def body(objectMapper: ObjectMapper): BodyWritable[JsonNode]
- Definition Classes
- JsonBodyWritables
- implicit val bodyWritableOf_Multipart: BodyWritable[Source[Part[Source[ByteString, _]], _]]
- Definition Classes
- WSBodyWritables
- def clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def header(name: String): Option[String]
- Definition Classes
- StandaloneWSRequest
- def headerValues(name: String): Seq[String]
- Definition Classes
- StandaloneWSRequest
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- implicit val writableOf_File: BodyWritable[File]
- Definition Classes
- DefaultBodyWritables
- implicit val writableOf_InputStream: BodyWritable[Supplier[InputStream]]
- Definition Classes
- DefaultBodyWritables
- implicit val writableOf_Source: BodyWritable[Source[ByteString, _]]
- Definition Classes
- DefaultBodyWritables
- implicit val writeableOf_ByteArray: BodyWritable[Array[Byte]]
- Definition Classes
- DefaultBodyWritables
- implicit val writeableOf_ByteBuffer: BodyWritable[ByteBuffer]
- Definition Classes
- DefaultBodyWritables
- implicit val writeableOf_Bytes: BodyWritable[ByteString]
- Definition Classes
- DefaultBodyWritables
- implicit val writeableOf_Document: BodyWritable[Document]
- Definition Classes
- XMLBodyWritables
- implicit val writeableOf_JsValue: BodyWritable[JsValue]
- Definition Classes
- JsonBodyWritables
- implicit val writeableOf_NodeBuffer: BodyWritable[NodeBuffer]
- Definition Classes
- XMLBodyWritables
- implicit def writeableOf_NodeSeq[C <: NodeSeq]: BodyWritable[C]
- Definition Classes
- XMLBodyWritables
- implicit val writeableOf_String: BodyWritable[String]
- Definition Classes
- DefaultBodyWritables
- implicit val writeableOf_StringBuilder: BodyWritable[StringBuilder]
- Definition Classes
- DefaultBodyWritables
- implicit val writeableOf_WsBody: BodyWritable[WSBody]
- Definition Classes
- DefaultBodyWritables
- implicit val writeableOf_urlEncodedForm: BodyWritable[Map[String, Seq[String]]]
- Definition Classes
- DefaultBodyWritables
- implicit val writeableOf_urlEncodedSimpleForm: BodyWritable[Map[String, String]]
- Definition Classes
- DefaultBodyWritables