Trait

play.api.mvc

FlashCookieBaker

Related Doc: package mvc

Permalink

trait FlashCookieBaker extends CookieBaker[Flash] with CookieDataCodec

Helper utilities to manage the Flash cookie.

Source
Flash.scala
Linear Supertypes
Known Subclasses
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

    Permalink
  2. abstract def decode(data: String): Map[String, String]

    Permalink

    Decodes from an encoded String.

    Decodes from an encoded String.

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

    Permalink

    Encodes the data as a String.

    Encodes the data as a String.

    Definition Classes
    CookieDataCodec

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def COOKIE_NAME: String

    Permalink

    The cookie name.

    The cookie name.

    Definition Classes
    FlashCookieBakerCookieBaker
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def decodeCookieToMap(cookie: Option[Cookie]): Map[String, String]

    Permalink

    Decodes the data from a Cookie.

    Decodes the data from a Cookie.

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

    Permalink

    Decodes the data from a Cookie.

    Decodes the data from a Cookie.

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

    Permalink

    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
    FlashCookieBakerCookieBaker
  10. def discard: DiscardingCookie

    Permalink
    Definition Classes
    CookieBaker
  11. def domain: Option[String]

    Permalink

    The cookie domain.

    The cookie domain. Defaults to None.

    Definition Classes
    FlashCookieBakerCookieBaker
  12. lazy val emptyCookie: Flash

    Permalink

    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
    FlashCookieBakerCookieBaker
  13. def encodeAsCookie(data: Flash): Cookie

    Permalink

    Encodes the data as a Cookie.

    Encodes the data as a Cookie.

    Definition Classes
    CookieBaker
  14. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  18. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  19. def httpOnly: Boolean

    Permalink

    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
    FlashCookieBakerCookieBaker
  20. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  21. def isSigned: Boolean

    Permalink

    true if the Cookie is signed.

    true if the Cookie is signed. Defaults to false.

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

    Permalink

    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

    Permalink
    Definition Classes
    AnyRef
  24. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  26. def path: String

    Permalink

    The cookie path.

    The cookie path.

    Definition Classes
    FlashCookieBakerCookieBaker
  27. def sameSite: Option[SameSite]

    Permalink

    The value of the SameSite attribute of the cookie.

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

    Definition Classes
    FlashCookieBakerCookieBaker
  28. def secure: Boolean

    Permalink

    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
    FlashCookieBakerCookieBaker
  29. def serialize(flash: Flash): Map[String, String]

    Permalink

    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
    FlashCookieBakerCookieBaker
  30. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  31. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  32. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from CookieDataCodec

Inherited from CookieBaker[Flash]

Inherited from AnyRef

Inherited from Any

Ungrouped