Packages

t

play.api.mvc

FlashCookieBaker

trait FlashCookieBaker extends CookieBaker[Flash] with CookieDataCodec

Helper utilities to manage the Flash cookie.

Source
Flash.scala
Linear Supertypes
CookieDataCodec, CookieBaker[Flash], AnyRef, Any
Known Subclasses
DefaultFlashCookieBaker, LegacyFlashCookieBaker
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FlashCookieBaker
  2. CookieDataCodec
  3. CookieBaker
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def config: FlashConfiguration
  2. abstract def decode(data: String): Map[String, String]

    Decodes from an encoded String.

    Decodes from an encoded String.

    Definition Classes
    CookieDataCodec
  3. abstract def encode(data: Map[String, String]): String

    Encodes the data as a String.

    Encodes the data as a String.

    Definition Classes
    CookieDataCodec

Concrete 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 COOKIE_NAME: String

    The cookie name.

    The cookie name.

    Definition Classes
    FlashCookieBaker → CookieBaker
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  7. def decodeCookieToMap(cookie: Option[Cookie]): Map[String, String]

    Decodes the data from a Cookie.

    Decodes the data from a Cookie.

    Definition Classes
    CookieBaker
  8. def decodeFromCookie(cookie: Option[Cookie]): Flash

    Decodes the data from a Cookie.

    Decodes the data from a Cookie.

    Definition Classes
    CookieBaker
  9. def deserialize(data: Map[String, String]): Flash

    Builds the cookie object from the given data map.

    Builds the cookie object from the given data map.

    data

    the data map to build the cookie object

    returns

    a new cookie object

    Definition Classes
    FlashCookieBaker → CookieBaker
  10. def discard: DiscardingCookie
    Definition Classes
    CookieBaker
  11. def domain: Option[String]

    The cookie domain.

    The cookie domain. Defaults to None.

    Definition Classes
    FlashCookieBaker → CookieBaker
  12. lazy val emptyCookie: Flash

    Default cookie, returned in case of error or if missing in the HTTP headers.

    Default cookie, returned in case of error or if missing in the HTTP headers.

    Definition Classes
    FlashCookieBaker → CookieBaker
  13. def encodeAsCookie(data: Flash): Cookie

    Encodes the data as a Cookie.

    Encodes the data as a Cookie.

    Definition Classes
    CookieBaker
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def httpOnly: Boolean

    true if the Cookie should have the httpOnly flag, disabling access from Javascript.

    true if the Cookie should have the httpOnly flag, disabling access from Javascript. Defaults to true.

    Definition Classes
    FlashCookieBaker → CookieBaker
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. def isSigned: Boolean

    true if the Cookie is signed.

    true if the Cookie is signed. Defaults to false.

    Definition Classes
    CookieBaker
  22. def maxAge: Option[Int]

    The cookie expiration date in seconds, None for a transient cookie

    The cookie expiration date in seconds, None for a transient cookie

    Definition Classes
    CookieBaker
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. def path: String

    The cookie path.

    The cookie path.

    Definition Classes
    FlashCookieBaker → CookieBaker
  27. def sameSite: Option[SameSite]

    The value of the SameSite attribute of the cookie.

    The value of the SameSite attribute of the cookie. Defaults to no SameSite.

    Definition Classes
    FlashCookieBaker → CookieBaker
  28. def secure: Boolean

    true if the Cookie should have the secure flag, restricting usage to https.

    true if the Cookie should have the secure flag, restricting usage to https. Defaults to false.

    Definition Classes
    FlashCookieBaker → CookieBaker
  29. def serialize(flash: Flash): Map[String, String]

    Converts the given cookie object into a data map.

    Converts the given cookie object into a data map.

    returns

    a new Map storing the key-value pairs for the given cookie

    Definition Classes
    FlashCookieBaker → CookieBaker
  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
    @throws( ... ) @native()

Inherited from CookieDataCodec

Inherited from CookieBaker[Flash]

Inherited from AnyRef

Inherited from Any

Ungrouped