Trait

play.api.libs.ws

WSClient

Related Doc: package ws

Permalink

trait WSClient extends Closeable

A Play specific WS client that can use Play specific classes in the request and response building.

Typically, access this class through dependency injection, i.e.

class MyService @Inject()(ws: WSClient) {
  val response: Future[WSResponse] = ws.url("http://example.com").get()
}

Please see the documentation at https://www.playframework.com/documentation/latest/ScalaWS for more details.

Source
WSClient.scala
Linear Supertypes
Closeable, AutoCloseable, AnyRef, Any
Known Subclasses
AhcWSClient, InternalWSClient
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WSClient
  2. Closeable
  3. AutoCloseable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def close(): Unit

    Permalink

    Closes this client, and releases underlying resources.

    Closes this client, and releases underlying resources.

    Definition Classes
    WSClient → Closeable → AutoCloseable
    Annotations
    @throws( ... )

  2. abstract def underlying[T]: T

    Permalink

    The underlying implementation of the client, if any.

    The underlying implementation of the client, if any. You must cast explicitly to the type you want.

    T

    the type you are expecting (i.e. isInstanceOf)

    returns

    the backing class.

  3. abstract def url(url: String): WSRequest

    Permalink

    Generates a request.

    Generates a request.

    url

    The base URL to make HTTP requests to.

    returns

    a request

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

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

    Permalink
    Definition Classes
    AnyRef → Any

  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  17. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  18. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  19. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Closeable

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped