object Header

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

Type Members

  1. final case class Accept(mimeTypes: NonEmptyChunk[MediaTypeWithQFactor]) extends Header with Product with Serializable
  2. sealed trait AcceptEncoding extends Header

    Represents an AcceptEncoding header value.

  3. sealed trait AcceptLanguage extends Header

    The Accept-Language request HTTP header indicates the natural language and locale that the client prefers.

  4. final case class AcceptPatch(mediaTypes: NonEmptyChunk[MediaType]) extends Header with Product with Serializable

    The Accept-Patch response HTTP header advertises which media-type the server is able to understand in a PATCH request.

  5. sealed trait AcceptRanges extends Header

    The Accept-Ranges HTTP response header is a marker used by the server to advertise its support for partial requests from the client for file downloads.

    The Accept-Ranges HTTP response header is a marker used by the server to advertise its support for partial requests from the client for file downloads. The value of this field indicates the unit that can be used to define a range. By default the RFC 7233 specification supports only 2 possible values.

  6. sealed trait AccessControlAllowCredentials extends Header
  7. sealed trait AccessControlAllowHeaders extends Header
  8. sealed trait AccessControlAllowMethods extends Header
  9. sealed trait AccessControlAllowOrigin extends Header

    The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin.

    The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin.

    For requests without credentials, the literal value "*" can be specified as a wildcard; the value tells browsers to allow requesting code from any origin to access the resource. Attempting to use the wildcard with credentials results in an error.

    <origin> Specifies an origin. Only a single origin can be specified. If the server supports clients from multiple origins, it must return the origin for the specific client making the request.

    null Specifies the origin "null".

  10. sealed trait AccessControlExposeHeaders extends Header

    The Access-Control-Expose-Headers response header allows a server to indicate which response headers should be made available to scripts running in the browser, in response to a cross-origin request.

  11. final case class AccessControlMaxAge(duration: zio.Duration) extends Header with Product with Serializable

    The Access-Control-Max-Age response header indicates how long the results of a preflight request (that is the information contained in the Access-Control-Allow-Methods and Access-Control-Allow-Headers headers) can be cached.

    The Access-Control-Max-Age response header indicates how long the results of a preflight request (that is the information contained in the Access-Control-Allow-Methods and Access-Control-Allow-Headers headers) can be cached.

    Maximum number of seconds the results can be cached, as an unsigned non-negative integer. Firefox caps this at 24 hours (86400 seconds). Chromium (prior to v76) caps at 10 minutes (600 seconds). Chromium (starting in v76) caps at 2 hours (7200 seconds). The default value is 5 seconds.

  12. final case class AccessControlRequestHeaders(values: NonEmptyChunk[String]) extends Header with Product with Serializable
  13. final case class AccessControlRequestMethod(method: Method) extends Header with Product with Serializable
  14. final case class Age(duration: zio.Duration) extends Header with Product with Serializable

    Age header value.

  15. final case class Allow(methods: NonEmptyChunk[Method]) extends Header with Product with Serializable

    The Allow header must be sent if the server responds with a 405 Method Not Allowed status code to indicate which request methods can be used.

  16. sealed trait AuthenticationScheme extends AnyRef
  17. sealed trait Authorization extends Header

    Authorization header value.

    Authorization header value.

    The Authorization header value contains one of the auth schemes

  18. sealed trait CacheControl extends Header

    CacheControl header value.

  19. sealed trait Connection extends Header

    Connection header value.

  20. final case class ContentBase(uri: URI) extends Header with Product with Serializable
  21. sealed trait ContentDisposition extends Header
  22. sealed trait ContentEncoding extends Header
  23. sealed trait ContentLanguage extends Header
  24. final case class ContentLength(length: Long) extends Header with Product with Serializable

    The Content-Length header indicates the size of the message body, in bytes, sent to the recipient.

  25. final case class ContentLocation(value: URI) extends Header with Product with Serializable
  26. final case class ContentMd5(value: String) extends Header with Product with Serializable
  27. sealed trait ContentRange extends Header
  28. sealed trait ContentSecurityPolicy extends Header
  29. sealed trait ContentTransferEncoding extends Header
  30. final case class ContentType(mediaType: MediaType, boundary: Option[Boundary] = None, charset: Option[Charset] = None) extends Header with Product with Serializable
  31. final case class Cookie(value: NonEmptyChunk[Cookie.Request]) extends Header with Product with Serializable
  32. final case class Custom(customName: CharSequence, value: CharSequence) extends Header with Product with Serializable
  33. sealed trait DNT extends Header
  34. final case class Date(value: ZonedDateTime) extends Header with Product with Serializable
  35. sealed trait ETag extends Header
  36. sealed trait Expect extends Header

    The Expect HTTP request header indicates expectations that need to be met by the server to handle the request successfully.

    The Expect HTTP request header indicates expectations that need to be met by the server to handle the request successfully. There is only one defined expectation: 100-continue

  37. final case class Expires(value: ZonedDateTime) extends Header with Product with Serializable
  38. final case class From(email: String) extends Header with Product with Serializable

    From header value.

  39. sealed trait HeaderType extends AnyRef
  40. final case class Host(hostAddress: String, port: Option[Int] = None) extends Header with Product with Serializable
  41. sealed trait IfMatch extends Header
  42. final case class IfModifiedSince(value: ZonedDateTime) extends Header with Product with Serializable
  43. sealed trait IfNoneMatch extends Header
  44. sealed trait IfRange extends Header

    The If-Range HTTP request header makes a range request conditional.

    The If-Range HTTP request header makes a range request conditional. Possible values:

    • <day-name>, <day> <month> <year> <hour>:<minute>:<second> GMT
    • <etag> a string of ASCII characters placed between double quotes (Like "675af34563dc-tr34"). A weak entity tag (one prefixed by W/) must not be used in this header.
  45. final case class IfUnmodifiedSince(value: ZonedDateTime) extends Header with Product with Serializable
  46. final case class LastModified(value: ZonedDateTime) extends Header with Product with Serializable
  47. final case class Location(url: URL) extends Header with Product with Serializable

    Location header value.

  48. final case class MaxForwards(value: Int) extends Header with Product with Serializable

    Max-Forwards header value

  49. sealed trait Origin extends Header

    Origin header value.

  50. sealed trait Pragma extends Header

    Pragma header value.

  51. final case class ProxyAuthenticate(scheme: AuthenticationScheme, realm: Option[String]) extends Header with Product with Serializable

    The HTTP Proxy-Authenticate response header defines the authentication method that should be used to gain access to a resource behind a proxy server.

    The HTTP Proxy-Authenticate response header defines the authentication method that should be used to gain access to a resource behind a proxy server. It authenticates the request to the proxy server, allowing it to transmit the request further.

    scheme

    Authentication type

    realm

    A description of the protected area, the realm. If no realm is specified, clients often display a formatted host name instead.

  52. final case class ProxyAuthorization(authenticationScheme: AuthenticationScheme, credential: String) extends Header with Product with Serializable

    Proxy-Authorization: <type> <credentials>

    Proxy-Authorization: <type> <credentials>

    <type> - AuthenticationScheme

    <credentials> - The resulting string is base64 encoded

    Example

    Proxy-Authorization: Basic YWxhZGRpbjpvcGVuc2VzYW1l

  53. sealed trait Range extends Header
  54. final case class Referer(url: URL) extends Header with Product with Serializable

    The Referer HTTP request header contains the absolute or partial address from which a resource has been requested.

    The Referer HTTP request header contains the absolute or partial address from which a resource has been requested. The Referer header allows a server to identify referring pages that people are visiting from or where requested resources are being used. This data can be used for analytics, logging, optimized caching, and more.

    When you click a link, the Referer contains the address of the page that includes the link. When you make resource requests to another domain, the Referer contains the address of the page that uses the requested resource.

    The Referer header can contain an origin, path, and querystring, and may not contain URL fragments (i.e. #section) or username:password information. The request's referrer policy defines the data that can be included. See Referrer-Policy for more information and examples.

  55. sealed trait RetryAfter extends Header
  56. final case class SecWebSocketAccept(hashedKey: String) extends Header with Product with Serializable
  57. sealed trait SecWebSocketExtensions extends Header
  58. final case class SecWebSocketKey(base64EncodedKey: String) extends Header with Product with Serializable
  59. final case class SecWebSocketLocation(url: URL) extends Header with Product with Serializable
  60. final case class SecWebSocketOrigin(url: URL) extends Header with Product with Serializable
  61. final case class SecWebSocketProtocol(subProtocols: NonEmptyChunk[String]) extends Header with Product with Serializable
  62. final case class SecWebSocketVersion(version: Int) extends Header with Product with Serializable
  63. final case class Server(name: String) extends Header with Product with Serializable

    Server header value.

  64. final case class SetCookie(value: Cookie.Response) extends Header with Product with Serializable
  65. sealed trait Te extends Header
  66. final case class Trailer(header: String) extends Header with Product with Serializable

    Trailer header value.

  67. sealed trait TransferEncoding extends Header
  68. sealed trait Upgrade extends Header
  69. final case class UpgradeInsecureRequests() extends Header with Product with Serializable
  70. sealed trait UserAgent extends Header
  71. sealed trait Vary extends Header

    Vary header value.

  72. sealed trait Via extends Header
  73. sealed trait WWWAuthenticate extends Header
  74. final case class Warning(code: Int, agent: String, text: String, date: Option[ZonedDateTime] = None) extends Header with Product with Serializable
  75. sealed trait XFrameOptions extends Header
  76. final case class XRequestedWith(value: String) extends Header with Product with Serializable

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. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. object Accept extends HeaderType with Serializable
  20. object AcceptEncoding extends HeaderType
  21. object AcceptLanguage extends HeaderType
  22. object AcceptPatch extends HeaderType with Serializable
  23. object AcceptRanges extends HeaderType
  24. object AccessControlAllowCredentials extends HeaderType
  25. object AccessControlAllowHeaders extends HeaderType

    The Access-Control-Allow-Headers response header is used in response to a preflight request which includes the Access-Control-Request-Headers to indicate which HTTP headers can be used during the actual request.

  26. object AccessControlAllowMethods extends HeaderType
  27. object AccessControlAllowOrigin extends HeaderType
  28. object AccessControlExposeHeaders extends HeaderType
  29. object AccessControlMaxAge extends HeaderType with Serializable
  30. object AccessControlRequestHeaders extends HeaderType with Serializable

    The Access-Control-Request-Headers request header is used by browsers when issuing a preflight request to let the server know which HTTP headers the client might send when the actual request is made (such as with setRequestHeader()).

    The Access-Control-Request-Headers request header is used by browsers when issuing a preflight request to let the server know which HTTP headers the client might send when the actual request is made (such as with setRequestHeader()). The complementary server-side header of Access-Control-Allow-Headers will answer this browser-side header.

  31. object AccessControlRequestMethod extends HeaderType with Serializable
  32. object Age extends HeaderType with Serializable
  33. object Allow extends HeaderType with Serializable
  34. object AuthenticationScheme
  35. object Authorization extends HeaderType
  36. object CacheControl extends HeaderType
  37. object Connection extends HeaderType
  38. object ContentBase extends HeaderType with Serializable
  39. object ContentDisposition extends HeaderType
  40. object ContentEncoding extends HeaderType
  41. object ContentLanguage extends HeaderType
  42. object ContentLength extends HeaderType with Serializable
  43. object ContentLocation extends HeaderType with Serializable
  44. object ContentMd5 extends HeaderType with Serializable
  45. object ContentRange extends HeaderType
  46. object ContentSecurityPolicy extends HeaderType
  47. object ContentTransferEncoding extends HeaderType
  48. object ContentType extends HeaderType with Serializable
  49. object Cookie extends HeaderType with Serializable

    The Cookie HTTP request header contains stored HTTP cookies associated with the server.

  50. object DNT extends HeaderType
  51. object Date extends HeaderType with Serializable

    The Date general HTTP header contains the date and time at which the message originated.

  52. object ETag extends HeaderType
  53. object Expect extends HeaderType
  54. object Expires extends HeaderType with Serializable

    The Expires HTTP header contains the date/time after which the response is considered expired.

    The Expires HTTP header contains the date/time after which the response is considered expired.

    Invalid expiration dates with value 0 represent a date in the past and mean that the resource is already expired.

    Expires: <Date>

    Date: <day-name>, <day> <month> <year> <hour>:<minute>:<second> GMT

    Example:

    Expires: Wed, 21 Oct 2015 07:28:00 GMT

  55. object From extends HeaderType with Serializable
  56. object HeaderType
  57. object Host extends HeaderType with Serializable
  58. object IfMatch extends HeaderType
  59. object IfModifiedSince extends HeaderType with Serializable
  60. object IfNoneMatch extends HeaderType
  61. object IfRange extends HeaderType
  62. object IfUnmodifiedSince extends HeaderType with Serializable

    If-Unmodified-Since request header makes the request for the resource conditional: the server will send the requested resource or accept it in the case of a POST or another non-safe method only if the resource has not been modified after the date specified by this HTTP header.

  63. object LastModified extends HeaderType with Serializable
  64. object Location extends HeaderType with Serializable
  65. object MaxForwards extends HeaderType with Serializable
  66. object Origin extends HeaderType
  67. object Pragma extends HeaderType
  68. object ProxyAuthenticate extends HeaderType with Serializable
  69. object ProxyAuthorization extends HeaderType with Serializable

    The HTTP Proxy-Authorization request header contains the credentials to authenticate a user agent to a proxy server, usually after the server has responded with a 407 Proxy Authentication Required status and the Proxy-Authenticate header.

  70. object Range extends HeaderType
  71. object Referer extends HeaderType with Serializable
  72. object RetryAfter extends HeaderType

    The RetryAfter HTTP header contains the date/time after which to retry

    The RetryAfter HTTP header contains the date/time after which to retry

    RetryAfter: <Date>

    Date: <day-name>, <day> <month> <year> <hour>:<minute>:<second> GMT

    Example:

    Expires: Wed, 21 Oct 2015 07:28:00 GMT

    Or RetryAfter the delay seconds.

  73. object SecWebSocketAccept extends HeaderType with Serializable

    The Sec-WebSocket-Accept header is used in the websocket opening handshake.

    The Sec-WebSocket-Accept header is used in the websocket opening handshake. It would appear in the response headers. That is, this is header is sent from server to client to inform that server is willing to initiate a websocket connection.

    See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Sec-WebSocket-Accept

  74. object SecWebSocketExtensions extends HeaderType

    The Sec-WebSocket-Extensions header is used in the WebSocket handshake.

    The Sec-WebSocket-Extensions header is used in the WebSocket handshake. It is initially sent from the client to the server, and then subsequently sent from the server to the client, to agree on a set of protocol-level extensions to use during the connection.

    See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Sec-WebSocket-Extensions

  75. object SecWebSocketKey extends HeaderType with Serializable

    The Sec-WebSocket-Key header is used in the WebSocket handshake.

    The Sec-WebSocket-Key header is used in the WebSocket handshake. It is sent from the client to the server to provide part of the information used by the server to prove that it received a valid WebSocket handshake. This helps ensure that the server does not accept connections from non-WebSocket clients (e.g. HTTP clients) that are being abused to send data to unsuspecting WebSocket servers.

    See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Sec-WebSocket-Key

  76. object SecWebSocketLocation extends HeaderType with Serializable
  77. object SecWebSocketOrigin extends HeaderType with Serializable

    The Sec-WebSocket-Origin header is used to protect against unauthorized cross-origin use of a WebSocket server by scripts using the |WebSocket| API in a Web browser.

    The Sec-WebSocket-Origin header is used to protect against unauthorized cross-origin use of a WebSocket server by scripts using the |WebSocket| API in a Web browser. The server is informed of the script origin generating the WebSocket connection request.

  78. object SecWebSocketProtocol extends HeaderType with Serializable

    The Sec-WebSocket-Protocol header field is used in the WebSocket opening handshake.

    The Sec-WebSocket-Protocol header field is used in the WebSocket opening handshake. It is sent from the client to the server and back from the server to the client to confirm the subprotocol of the connection. This enables scripts to both select a subprotocol and be sure that the server agreed to serve that subprotocol.

    See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Sec-WebSocket-Protocol

  79. object SecWebSocketVersion extends HeaderType with Serializable

    The Sec-WebSocket-Version header field is used in the WebSocket opening handshake.

    The Sec-WebSocket-Version header field is used in the WebSocket opening handshake. It is sent from the client to the server to indicate the protocol version of the connection.

    See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Sec-WebSocket-Version

  80. object Server extends HeaderType with Serializable
  81. object SetCookie extends HeaderType with Serializable
  82. object Te extends HeaderType
  83. object Trailer extends HeaderType with Serializable
  84. object TransferEncoding extends HeaderType
  85. object Upgrade extends HeaderType
  86. object UpgradeInsecureRequests extends HeaderType with Serializable

    The HTTP Upgrade-Insecure-Requests request header sends a signal to the server expressing the client's preference for an encrypted and authenticated response.

  87. object UserAgent extends HeaderType

    The "User-Agent" header field contains information about the user agent originating the request, which is often used by servers to help identify the scope of reported interoperability problems, to work around or tailor responses to avoid particular user agent limitations, and for analytics regarding browser or operating system use

  88. object Vary extends HeaderType
  89. object Via extends HeaderType

    The Via general header is added by proxies, both forward and reverse, and can appear in the request or response headers.

    The Via general header is added by proxies, both forward and reverse, and can appear in the request or response headers. It is used for tracking message forwards, avoiding request loops, and identifying the protocol capabilities of senders along the request/response chain

  90. object WWWAuthenticate extends HeaderType
  91. object Warning extends HeaderType with Serializable
  92. object XFrameOptions extends HeaderType
  93. object XRequestedWith extends HeaderType with Serializable

Deprecated Value Members

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

Inherited from AnyRef

Inherited from Any

Ungrouped