vertx-lang-scala-docs_2.12 3.5.4 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package ext
  Definition Classes
    scala
-  package web
  Definition Classes
    ext
-  package client
  Definition Classes
    web
-  package codec
  Definition Classes
    web
-  package handler
  Definition Classes
    web
-  package sstore
  Definition Classes
    web
-  package templ
  Definition Classes
    web
- Cookie
- FileUpload
- Http2PushMapping
- LanguageHeader
- Locale
- MIMEHeader
- ParsedHeaderValue
- ParsedHeaderValues
- Route
- Router
- RoutingContext
- Session

c

io.vertx.scala.ext.web

# Cookie 

###
Companion object Cookie

#### class Cookie extends AnyRef

Represents an HTTP Cookie.

All cookies must have a name and a value and can optionally have other fields set such as path, domain, etc.

(Derived from io.netty.handler.codec.http.Cookie)

Linear Supertypes
AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. Cookie
2. AnyRef
3. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new Cookie(_asJava: AnyRef)

### 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 asJava: AnyRef
6.  def clone(): AnyRef
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @native() @throws( ... )
7.  def encode(): String

   Encode the cookie to a string.

   Encode the cookie to a string. This is what is used in the Set-Cookie header

   returns

     the encoded cookie

8.  final def eq(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef
9.  def equals(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
10.  def finalize(): Unit
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )
11.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
12.  def getDomain(): Option[String]

    returns

      the domain for the cookie

13.  def getName(): String

    returns

      the name of this cookie

14.  def getPath(): Option[String]

    returns

      the path for this cookie

15.  def getValue(): String

    returns

      the value of this cookie

16.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
17.  def isChanged(): Boolean

    Has the cookie been changed? Changed cookies will be saved out in the response and sent to the browser.

    Has the cookie been changed? Changed cookies will be saved out in the response and sent to the browser.

    returns

      true if changed

18.  def isFromUserAgent(): Boolean

    Has this Cookie been sent from the User Agent (the browser)? or was created during the executing on the request.

    Has this Cookie been sent from the User Agent (the browser)? or was created during the executing on the request.

    returns

      true if the cookie comes from the User Agent.

19.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
20.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
21.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
22.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
23.  def setChanged(changed: Boolean): Unit

    Set the cookie as being changed.

    Set the cookie as being changed. Changed will be true for a cookie just created, false by default if just read from the request

    changed

      true if changed

24.  def setDomain(domain: Option[String]): Cookie

    Sets the domain of this cookie

    Sets the domain of this cookie

    domain

      The domain to use

    returns

      a reference to this, so the API can be used fluently

25.  def setHttpOnly(httpOnly: Boolean): Cookie

    Determines if this cookie is HTTP only.

    Determines if this cookie is HTTP only. If set to true, this cookie cannot be accessed by a client side script. However, this works only if the browser supports it. For for information, please look here.

    httpOnly

      True if the cookie is HTTP only, otherwise false.

26.  def setMaxAge(maxAge: Long): Cookie

    Sets the maximum age of this cookie in seconds.

    Sets the maximum age of this cookie in seconds. If an age of `0` is specified, this cookie will be automatically removed by browser because it will expire immediately. If MIN_VALUE is specified, this cookie will be removed when the browser is closed. If you don't set this the cookie will be a session cookie and be removed when the browser is closed.

    maxAge

      The maximum age of this cookie in seconds

27.  def setPath(path: Option[String]): Cookie

    Sets the path of this cookie.

    Sets the path of this cookie.

    path

      The path to use for this cookie

    returns

      a reference to this, so the API can be used fluently

28.  def setSecure(secure: Boolean): Cookie

    Sets the security getStatus of this cookie

    Sets the security getStatus of this cookie

    secure

      True if this cookie is to be secure, otherwise false

    returns

      a reference to this, so the API can be used fluently

29.  def setValue(value: String): Cookie

    Sets the value of this cookie

    Sets the value of this cookie

    value

      The value to set

    returns

      a reference to this, so the API can be used fluently

30.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
31.  def toString(): String
    Definition Classes
      AnyRef → Any
32.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
33.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
34.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @native() @throws( ... )

### Inherited from AnyRef

### Inherited from Any

### Ungrouped