play.api.libs.ws.WS

WSRequestHolder

case class WSRequestHolder (url: String, headers: Map[String, Seq[String]], queryString: Map[String, String], calc: Option[SignatureCalculator], auth: Option[(String, String, AuthScheme)], followRedirects: Option[Boolean], timeout: Option[Int]) extends Product with Serializable

A WS Request builder.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. WSRequestHolder
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WSRequestHolder (url: String, headers: Map[String, Seq[String]], queryString: Map[String, String], calc: Option[SignatureCalculator], auth: Option[(String, String, AuthScheme)])

  2. new WSRequestHolder (url: String, headers: Map[String, Seq[String]], queryString: Map[String, String], calc: Option[SignatureCalculator], auth: Option[(String, String, AuthScheme)], followRedirects: Option[Boolean], timeout: Option[Int])

Value Members

  1. def != (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any
  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  5. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  6. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any
  7. val auth : Option[(String, String, AuthScheme)]

  8. val calc : Option[SignatureCalculator]

  9. def canEqual (arg0: Any): Boolean

    Definition Classes
    WSRequestHolder → Equals
  10. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  11. def copy (url: String = this.url, headers: Map[String, Seq[String]] = this.headers, queryString: Map[String, String] = this.queryString, calc: Option[SignatureCalculator] = this.calc, auth: Option[(String, String, AuthScheme)] = this.auth): WSRequestHolder

  12. def delete (): Promise[Response]

    Perform a DELETE on the request asynchronously.

  13. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  14. def equals (arg0: Any): Boolean

    Definition Classes
    WSRequestHolder → Equals → AnyRef → Any
  15. def finalize (): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  16. val followRedirects : Option[Boolean]

  17. def get [A] (consumer: (ResponseHeaders) ⇒ Iteratee[Array[Byte], A]): Promise[Iteratee[Array[Byte], A]]

    performs a get with supplied body

    performs a get with supplied body

    consumer

    that's handling the response

  18. def get (): Promise[Response]

    performs a get with supplied body

  19. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef → Any
  20. def hashCode (): Int

    Definition Classes
    WSRequestHolder → AnyRef → Any
  21. def head (): Promise[Response]

    Perform a HEAD on the request asynchronously.

  22. val headers : Map[String, Seq[String]]

  23. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any
  24. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  25. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  26. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  27. def options (): Promise[Response]

    Perform a OPTIONS on the request asynchronously.

  28. def post [T] (body: T)(implicit wrt: Writeable[T], ct: ContentTypeOf[T]): Promise[Response]

    Perform a POST on the request asynchronously.

  29. def postAndRetrieveStream [A, T] (body: T)(consumer: (ResponseHeaders) ⇒ Iteratee[Array[Byte], A])(implicit wrt: Writeable[T], ct: ContentTypeOf[T]): Promise[Iteratee[Array[Byte], A]]

    performs a POST with supplied body

    performs a POST with supplied body

    consumer

    that's handling the response

  30. def productArity : Int

    Definition Classes
    WSRequestHolder → Product
  31. def productElement (arg0: Int): Any

    Definition Classes
    WSRequestHolder → Product
  32. def productIterator : Iterator[Any]

    Definition Classes
    Product
  33. def productPrefix : String

    Definition Classes
    WSRequestHolder → Product
  34. def put [T] (body: T)(implicit wrt: Writeable[T], ct: ContentTypeOf[T]): Promise[Response]

    Perform a PUT on the request asynchronously.

  35. def putAndRetrieveStream [A, T] (body: T)(consumer: (ResponseHeaders) ⇒ Iteratee[Array[Byte], A])(implicit wrt: Writeable[T], ct: ContentTypeOf[T]): Promise[Iteratee[Array[Byte], A]]

    performs a PUT with supplied body

    performs a PUT with supplied body

    consumer

    that's handling the response

  36. val queryString : Map[String, String]

  37. def sign (calc: SignatureCalculator): WSRequestHolder

    sets the signature calculator for the request

    sets the signature calculator for the request

    calc

  38. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef
  39. val timeout : Option[Int]

  40. def toString (): String

    Definition Classes
    WSRequestHolder → AnyRef → Any
  41. val url : String

  42. def wait (): Unit

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

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

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  45. def withAuth (username: String, password: String, scheme: AuthScheme): WSRequestHolder

    sets the authentication realm

  46. def withFollowRedirects (follow: Boolean): WSRequestHolder

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

  47. def withHeaders (hdrs: (String, String)*): WSRequestHolder

    adds any number of HTTP headers

    adds any number of HTTP headers

    hdrs

  48. def withQueryString (parameters: (String, String)*): WSRequestHolder

    adds any number of query string parameters to the

  49. def withTimeout (timeout: Int): WSRequestHolder

    Sets the request timeout in milliseconds

Deprecated Value Members

  1. def productElements : Iterator[Any]

    Definition Classes
    Product
    Annotations
    @deprecated
    Deprecated

    use productIterator instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any