play.api.libs.ws.ning

NingWSRequest

Related Doc: package ning

case class NingWSRequest(client: NingWSClient, url: String, method: String, body: WSBody, headers: Map[String, Seq[String]], queryString: Map[String, Seq[String]], calc: Option[WSSignatureCalculator], auth: Option[(String, String, WSAuthScheme)], followRedirects: Option[Boolean], requestTimeout: Option[Int], virtualHost: Option[String], proxyServer: Option[WSProxyServer], disableUrlEncoding: Option[Boolean]) extends WSRequest with Product with Serializable

A Ning WS Request.

Source
NingWS.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, WSRequest, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. NingWSRequest
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. WSRequest
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new NingWSRequest(client: NingWSClient, url: String, method: String, body: WSBody, headers: Map[String, Seq[String]], queryString: Map[String, Seq[String]], calc: Option[WSSignatureCalculator], auth: Option[(String, String, WSAuthScheme)], followRedirects: Option[Boolean], requestTimeout: Option[Int], virtualHost: Option[String], proxyServer: Option[WSProxyServer], disableUrlEncoding: Option[Boolean])

Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  5. val auth: Option[(String, String, WSAuthScheme)]

    The authentication this request should use

    The authentication this request should use

    Definition Classes
    NingWSRequestWSRequest
  6. val body: WSBody

    The body of this request

    The body of this request

    Definition Classes
    NingWSRequestWSRequest
  7. def buildRequest(): Request

    Creates and returns an AHC request, running all operations on it.

  8. val calc: Option[WSSignatureCalculator]

    A calculator of the signature for this request

    A calculator of the signature for this request

    Definition Classes
    NingWSRequestWSRequest
  9. val client: NingWSClient

  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def contentType: Option[String]

  12. def delete(): Future[WSResponse]

    Perform a DELETE on the request asynchronously.

    Perform a DELETE on the request asynchronously.

    Definition Classes
    WSRequest
  13. val disableUrlEncoding: Option[Boolean]

  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  15. def execute(): Future[WSResponse]

    Execute this request

    Execute this request

    Definition Classes
    NingWSRequestWSRequest
  16. def execute(method: String): Future[WSResponse]

    Definition Classes
    WSRequest
  17. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. val followRedirects: Option[Boolean]

    Whether this request should follow redirects

    Whether this request should follow redirects

    Definition Classes
    NingWSRequestWSRequest
  19. def get[A](consumer: (WSResponseHeaders) ⇒ Iteratee[Array[Byte], A])(implicit ec: ExecutionContext): Future[Iteratee[Array[Byte], A]]

    performs a get

    performs a get

    consumer

    that's handling the response

    Definition Classes
    WSRequest
  20. def get(): Future[WSResponse]

    performs a get

    performs a get

    Definition Classes
    WSRequest
  21. def getBody: Option[Array[Byte]]

    Returns the body as an array of bytes.

  22. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  23. def getStream(): Future[(WSResponseHeaders, Enumerator[Array[Byte]])]

    performs a get

    performs a get

    Definition Classes
    WSRequest
  24. def head(): Future[WSResponse]

    Perform a HEAD on the request asynchronously.

    Perform a HEAD on the request asynchronously.

    Definition Classes
    WSRequest
  25. val headers: Map[String, Seq[String]]

    The headers for this request

    The headers for this request

    Definition Classes
    NingWSRequestWSRequest
  26. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  27. val method: String

    The method for this request

    The method for this request

    Definition Classes
    NingWSRequestWSRequest
  28. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  29. final def notify(): Unit

    Definition Classes
    AnyRef
  30. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  31. def options(): Future[WSResponse]

    Perform a OPTIONS on the request asynchronously.

    Perform a OPTIONS on the request asynchronously.

    Definition Classes
    WSRequest
  32. def patch(body: File): Future[WSResponse]

    Perform a PATCH on the request asynchronously.

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

    Definition Classes
    WSRequest
  33. def patch[T](body: T)(implicit wrt: Writeable[T]): Future[WSResponse]

    Perform a PATCH on the request asynchronously.

    Perform a PATCH on the request asynchronously.

    Definition Classes
    WSRequest
  34. def patchAndRetrieveStream[A, T](body: T)(consumer: (WSResponseHeaders) ⇒ Iteratee[Array[Byte], A])(implicit wrt: Writeable[T], ec: ExecutionContext): Future[Iteratee[Array[Byte], A]]

    performs a POST with supplied body

    performs a POST with supplied body

    consumer

    that's handling the response

    Definition Classes
    WSRequest
  35. def post(body: File): Future[WSResponse]

    Perform a POST on the request asynchronously.

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

    Definition Classes
    WSRequest
  36. def post[T](body: T)(implicit wrt: Writeable[T]): Future[WSResponse]

    Perform a POST on the request asynchronously.

    Perform a POST on the request asynchronously.

    Definition Classes
    WSRequest
  37. def postAndRetrieveStream[A, T](body: T)(consumer: (WSResponseHeaders) ⇒ Iteratee[Array[Byte], A])(implicit wrt: Writeable[T], ec: ExecutionContext): Future[Iteratee[Array[Byte], A]]

    performs a POST with supplied body

    performs a POST with supplied body

    consumer

    that's handling the response

    Definition Classes
    WSRequest
  38. val proxyServer: Option[WSProxyServer]

    The proxy server this request will use

    The proxy server this request will use

    Definition Classes
    NingWSRequestWSRequest
  39. def put(body: File): Future[WSResponse]

    Perform a PUT on the request asynchronously.

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

    Definition Classes
    WSRequest
  40. def put[T](body: T)(implicit wrt: Writeable[T]): Future[WSResponse]

    Perform a PUT on the request asynchronously.

    Perform a PUT on the request asynchronously.

    Definition Classes
    WSRequest
  41. def putAndRetrieveStream[A, T](body: T)(consumer: (WSResponseHeaders) ⇒ Iteratee[Array[Byte], A])(implicit wrt: Writeable[T], ec: ExecutionContext): Future[Iteratee[Array[Byte], A]]

    performs a PUT with supplied body

    performs a PUT with supplied body

    consumer

    that's handling the response

    Definition Classes
    WSRequest
  42. val queryString: Map[String, Seq[String]]

    The query string for this request

    The query string for this request

    Definition Classes
    NingWSRequestWSRequest
  43. def requestHeader(name: String): Option[String]

    Returns the HTTP header given by name, using the request builder.

    Returns the HTTP header given by name, using the request builder. This may be signed, so may return extra headers that were not directly input.

  44. def requestHeaders: Map[String, Seq[String]]

    Returns the current headers of the request, using the request builder.

    Returns the current headers of the request, using the request builder. This may be signed, so may return extra headers that were not directly input.

  45. def requestQueryParams: Map[String, Seq[String]]

    Returns the current query string parameters, using the request builder.

    Returns the current query string parameters, using the request builder. This may be signed, so may not return the same parameters that were input.

  46. val requestTimeout: Option[Int]

    The timeout for the request

    The timeout for the request

    Definition Classes
    NingWSRequestWSRequest
  47. def requestUrl: String

    Returns the current URL, using the request builder.

    Returns the current URL, using the request builder. This may be signed by OAuth, as opposed to request.url.

  48. def sign(calc: WSSignatureCalculator): WSRequest

    sets the signature calculator for the request

    sets the signature calculator for the request

    calc

    Definition Classes
    NingWSRequestWSRequest
  49. def stream(): Future[(WSResponseHeaders, Enumerator[Array[Byte]])]

    Execute this request and stream the response body in an enumerator

    Execute this request and stream the response body in an enumerator

    Definition Classes
    NingWSRequestWSRequest
  50. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  51. lazy val uri: URI

    The URI for this request

    The URI for this request

    Definition Classes
    WSRequest
  52. val url: String

    The base URL for this request

    The base URL for this request

    Definition Classes
    NingWSRequestWSRequest
  53. val virtualHost: Option[String]

    The virtual host this request will use

    The virtual host this request will use

    Definition Classes
    NingWSRequestWSRequest
  54. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  57. def withAuth(username: String, password: String, scheme: WSAuthScheme): WSRequest

    sets the authentication realm

    sets the authentication realm

    Definition Classes
    NingWSRequestWSRequest
  58. def withBody(body: WSBody): WSRequest

    Sets the body for this request

    Sets the body for this request

    Definition Classes
    NingWSRequestWSRequest
  59. def withBody[T](body: T)(implicit wrt: Writeable[T]): WSRequest

    Sets the body for this request

    Sets the body for this request

    Definition Classes
    WSRequest
  60. def withFollowRedirects(follow: Boolean): WSRequest

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

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

    Definition Classes
    NingWSRequestWSRequest
  61. def withHeaders(hdrs: (String, String)*): WSRequest

    adds any number of HTTP headers

    adds any number of HTTP headers

    hdrs

    Definition Classes
    NingWSRequestWSRequest
  62. def withMethod(method: String): WSRequest

    Sets the method for this request

    Sets the method for this request

    Definition Classes
    NingWSRequestWSRequest
  63. def withProxyServer(proxyServer: WSProxyServer): WSRequest

    Sets the proxy server to use in this request

    Sets the proxy server to use in this request

    Definition Classes
    NingWSRequestWSRequest
  64. def withQueryString(parameters: (String, String)*): WSRequest

    adds any number of query string parameters to the

    adds any number of query string parameters to the

    Definition Classes
    NingWSRequestWSRequest
  65. def withRequestTimeout(timeout: Long): WSRequest

    Sets the maximum time in milliseconds you expect the request to take.

    Sets the maximum time in milliseconds you expect the request to take. Warning: a stream consumption will be interrupted when this time is reached unless -1 is set.

    Definition Classes
    NingWSRequestWSRequest
  66. def withVirtualHost(vh: String): WSRequest

    Sets the virtual host to use in this request

    Sets the virtual host to use in this request

    Definition Classes
    NingWSRequestWSRequest

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from WSRequest

Inherited from AnyRef

Inherited from Any

Ungrouped