Packages

  • package root
    Definition Classes
    root
  • package sttp
    Definition Classes
    root
  • package model

    Most model classes contain both serialisation & parsing functionality, following these conventions:

    Most model classes contain both serialisation & parsing functionality, following these conventions:

    • .toString returns a representation of the model class in a format as in an HTTP request/response. For example, for an uri this will be http://..., for a header [name]: [value], etc.
    • [SthCompanionObject].parse(serialized: String): Either[String, Sth]: returns an error message or an instance of the model class
    • [SthCompanionObject].unsafeApply(values): creates an instance of the model class; validates the input values and in case of an error, *throws an exception*. An error could be e.g. that the input values contain characters outside of the allowed range
    • [SthCompanionObject].safeApply(...): Either[String, Sth]: same as above, but doesn't throw exceptions. Instead, returns an error message or the model class instance
    • [SthCompanionObject].apply(...): Sth: creates the model type, without validation, and without throwing exceptions
    Definition Classes
    sttp
  • package internal
    Definition Classes
    model
  • Cookie
  • CookieValueWithMeta
  • CookieWithMeta
  • HasHeaders
  • Header
  • HeaderNames
  • Headers
  • MediaType
  • MediaTypes
  • Method
  • Methods
  • Part
  • QueryParams
  • StatusCode
  • StatusCodes
  • Uri
  • UriInterpolator

object Header

For a description of the behavior of apply, safeApply and unsafeApply methods, see sttp.model.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Header
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. def accept(mediaRanges: String): Header
  5. def acceptCharset(charsetRanges: String): Header
  6. def acceptEncoding(encodingRanges: String): Header
  7. def accessControlAllowCredentials(allow: Boolean): Header
  8. def accessControlAllowHeaders(headerNames: String*): Header
  9. def accessControlAllowMethods(methods: Method*): Header
  10. def accessControlAllowOrigin(originRange: String): Header
  11. def accessControlExposeHeaders(headerNames: String*): Header
  12. def accessControlMaxAge(deltaSeconds: Long): Header
  13. def accessControlRequestHeaders(headerNames: String*): Header
  14. def accessControlRequestMethod(method: Method): Header
  15. def apply(name: String, value: String): Header
  16. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  17. def authorization(authType: String, credentials: String): Header
  18. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  19. def contentEncoding(encoding: String): Header
  20. def contentLength(length: Long): Header
  21. def contentType(mediaType: MediaType): Header
  22. def cookie(firstCookie: Cookie, otherCookies: Cookie*): Header
  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  25. def etag(tag: String): Header
  26. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. def location(uri: Uri): Header
  30. def location(uri: String): Header
  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  34. def proxyAuthorization(authType: String, credentials: String): Header
  35. def safeApply(name: String, value: String): Either[String, Header]
  36. def setCookie(cookie: CookieWithMeta): Header
  37. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  38. def toString(): String
    Definition Classes
    AnyRef → Any
  39. def unapply(h: Header): Option[(String, String)]
  40. def unsafeApply(name: String, value: String): Header

    Exceptions thrown

    IllegalArgumentException If the header name contains illegal characters.

  41. def userAgent(userAgent: String): Header
  42. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  44. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. def xForwardedFor(firstAddress: String, otherAddresses: String*): Header

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  2. def notValidated(name: String, value: String): Header
    Annotations
    @deprecated
    Deprecated

    use apply

Inherited from AnyRef

Inherited from Any

Ungrouped