Request

Represents an HTTP request.

Instances are created through the companion object. Once an instance is obtained, the request can be configured through "raw" modification methods (

method

headers

...) as well as specialised helpers such as

GET

acceptGzip

/ }}}

acceptGzip }}}

GET }}}

headers }}} as

GET

acceptGzip

/ }}}

acceptGzip }}}

GET }}}

method }}} as

GET

acceptGzip

/ }}}

acceptGzip }}}

GET }}}

Linear Supertypes

AnyRef, Any

Abstract Value Members

abstract def apply(body: Option[RequestEntity]): A
abstract def copy(url: Url, method: Method, headers: Headers): Request[A]

Attributes
protected
abstract val headers: Headers

List of HTTP headers of the request.
abstract def map[B](f: (A) ⇒ B): Request[B]

Applies the specified transformation to the request's eventual response.
Applies the specified transformation to the request's eventual response.
Application developers should be wary of a common pitfall: when working with responses that contain instances of ResponseEntity, they should always clean these up, either by reading their content (transforming it to something else or calling ResponseEntity.empty) or explicitly ignoring them (by calling ResponseEntity.ignore).
This is a common source of issues when mapping error statuses to exceptions: each connection will be kept alive until the remote host decides it has timed out.
abstract val method: Method

HTTP method of the request.
abstract val url: Url

URL on which the request will be performed.

Concrete Value Members

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
def &[T](param: (String, T))(implicit arg0: ValueWriter[T]): Request[A]
def /(segment: String): Request[A]
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def ?(value: QueryString): Request[A]
def CONNECT: Request[A]
def DELETE: Request[A]
def GET: Request[A]
def HEAD: Request[A]
def LINK: Request[A]
def OPTIONS: Request[A]
def PATCH: Request[A]
def POST: Request[A]
def PUT: Request[A]
def TRACE: Request[A]
def UNLINK: Request[A]
def accept: Option[Seq[Conneg[MediaType]]]

Returns the value of this instance's content type preferences.
def accept(types: Conneg[MediaType]*): Request[A]

Notifies the remote server about response content type preferences.
Notifies the remote server about response content type preferences.
This maps to the Accept header.
types
list of media types to declare.
def acceptCharset: Option[Seq[Conneg[Charset]]]

Returns the value of this instance's charset preferences.
def acceptCharset(charsets: Conneg[Charset]*): Request[A]

Notifies the remote server about response charset preferences.
Notifies the remote server about response charset preferences.
This maps to the Accept-Charset header.
charsets
list of charsets to declare.
def acceptDeflate: Request[A]

Notifies the remote server that we accept deflated responses.
def acceptEncoding: Option[Seq[Conneg[Encoding]]]

Returns the value of this instance's encoding header.
def acceptEncoding(encodings: Conneg[Encoding]*): Request[A]

Notifies the remote server about transfer encoding preferences.
Notifies the remote server about transfer encoding preferences.
This maps to the Accept-Encoding header.
encodings
list of encodings to declare.
def acceptGzip: Request[A]

Notifies the remote server that we accept GZIPed responses.
def acceptLanguage: Option[Seq[Conneg[Language]]]

Returns the value of this instance's language preferences.
def acceptLanguage(languages: Conneg[Language]*): Request[A]

Notifies the remote server about response language preferences.
Notifies the remote server about response language preferences.
This maps to the Accept-Language header.
languages
list of languages to declare.
def apply(body: RequestEntity): A
def apply(): A
final def asInstanceOf[T0]: T0

Definition Classes
Any
def auth(user: String, pwd: String): Request[A]
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def date: Option[Date]
def date(date: Date = new Date()): Request[A]
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): 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[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def header[T](name: String)(implicit arg0: ValueReader[T]): Option[T]

Returns the value of the specified header.
def header[T](name: String, value: T)(implicit arg0: ValueWriter[T]): Request[A]

Sets the value of the specified header.
Sets the value of the specified header.
This method expects an appropriate implicit ValueWriter to be in scope. Standard formats are declared in Headers.
def headers(value: Headers): Request[A]
def ifMatch: Option[Seq[ETag]]
def ifMatch(tags: ETag*): Request[A]
def ifModifiedSince: Option[Date]
def ifModifiedSince(date: Date): Request[A]
def ifNoneMatch: Option[Seq[ETag]]
def ifNoneMatch(tags: ETag*): Request[A]
def ifRange(date: Date): Request[A]
def ifRange(tag: ETag): Request[A]
def ifUnmodifiedSince: Option[Date]
def ifUnmodifiedSince(date: Date): Request[A]
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def maxForwards: Option[Int]
def maxForwards(value: Int): Request[A]
def method(value: Method): Request[A]
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def range: Option[Seq[ByteRange]]
def range(ranges: ByteRange*): Request[A]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def url(value: Url): Request[A]
def userAgent: Option[String]
def userAgent(name: String): Request[A]
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object Request | package fetch

trait Request[A] extends AnyRef

Abstract Value Members

abstract def apply(body: Option[RequestEntity]): A

abstract def copy(url: Url, method: Method, headers: Headers): Request[A]

abstract val headers: Headers

abstract def map[B](f: (A) ⇒ B): Request[B]

abstract val method: Method

abstract val url: Url

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def &[T](param: (String, T))(implicit arg0: ValueWriter[T]): Request[A]

def /(segment: String): Request[A]

final def ==(arg0: Any): Boolean

def ?(value: QueryString): Request[A]

def CONNECT: Request[A]

def DELETE: Request[A]

def GET: Request[A]

def HEAD: Request[A]

def LINK: Request[A]

def OPTIONS: Request[A]

def PATCH: Request[A]

def POST: Request[A]

def PUT: Request[A]

def TRACE: Request[A]

def UNLINK: Request[A]

def accept: Option[Seq[Conneg[MediaType]]]

def accept(types: Conneg[MediaType]*): Request[A]

def acceptCharset: Option[Seq[Conneg[Charset]]]

def acceptCharset(charsets: Conneg[Charset]*): Request[A]

def acceptDeflate: Request[A]

def acceptEncoding: Option[Seq[Conneg[Encoding]]]

def acceptEncoding(encodings: Conneg[Encoding]*): Request[A]

def acceptGzip: Request[A]

def acceptLanguage: Option[Seq[Conneg[Language]]]

def acceptLanguage(languages: Conneg[Language]*): Request[A]

def apply(body: RequestEntity): A

def apply(): A

final def asInstanceOf[T0]: T0

def auth(user: String, pwd: String): Request[A]

def clone(): AnyRef

def date: Option[Date]

def date(date: Date = new Date()): Request[A]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

def header[T](name: String)(implicit arg0: ValueReader[T]): Option[T]

def header[T](name: String, value: T)(implicit arg0: ValueWriter[T]): Request[A]

def headers(value: Headers): Request[A]

def ifMatch: Option[Seq[ETag]]

def ifMatch(tags: ETag*): Request[A]

def ifModifiedSince: Option[Date]

def ifModifiedSince(date: Date): Request[A]

def ifNoneMatch: Option[Seq[ETag]]

def ifNoneMatch(tags: ETag*): Request[A]

def ifRange(date: Date): Request[A]

def ifRange(tag: ETag): Request[A]

def ifUnmodifiedSince: Option[Date]

def ifUnmodifiedSince(date: Date): Request[A]

final def isInstanceOf[T0]: Boolean

def maxForwards: Option[Int]

def maxForwards(value: Int): Request[A]

def method(value: Method): Request[A]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def range: Option[Seq[ByteRange]]

def range(ranges: ByteRange*): Request[A]

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

def toString(): String

def url(value: Url): Request[A]

def userAgent: Option[String]

def userAgent(name: String): Request[A]

final def wait(): Unit

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

final def wait(arg0: Long): Unit