Packages

t

play.api.i18n

MessagesApi

trait MessagesApi extends AnyRef

The internationalisation API.

Source
Messages.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
DefaultMessagesApi
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MessagesApi
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def apply(keys: Seq[String], args: Any*)(implicit lang: Lang): String

    Translates the first defined message.

    Translates the first defined message.

    Uses java.text.MessageFormat internally to format the message.

    keys

    the message key

    args

    the message arguments

    returns

    the formatted message or a default rendering if the key wasn’t defined

  2. abstract def apply(key: String, args: Any*)(implicit lang: Lang): String

    Translates a message.

    Translates a message.

    Uses java.text.MessageFormat internally to format the message.

    key

    the message key

    args

    the message arguments

    returns

    the formatted message or a default rendering if the key wasn’t defined

  3. abstract def clearLang(result: Result): Result

    Given a Result, return a new Result with the lang cookie discarded.

  4. abstract def isDefinedAt(key: String)(implicit lang: Lang): Boolean

    Check if a message key is defined.

    Check if a message key is defined.

    key

    the message key

    returns

    a boolean

  5. abstract def langCookieHttpOnly: Boolean

    Whether the HTTP only attribute of the cookie should be set to true or not.

  6. abstract def langCookieMaxAge: Option[Int]

    An optional max age in seconds for the language Cookie.

  7. abstract def langCookieName: String

    Name for the language Cookie.

  8. abstract def langCookieSameSite: Option[SameSite]

    The value of the SameSite attribute of the cookie.

    The value of the SameSite attribute of the cookie. If None, then no SameSite attribute is set.

  9. abstract def langCookieSecure: Boolean

    Whether the secure attribute of the cookie is true or not.

  10. abstract def messages: Map[String, Map[String, String]]

    Get all the defined messages

  11. abstract def preferred(request: RequestHeader): Messages

    Get the preferred messages for the given Java request

  12. abstract def preferred(request: RequestHeader): Messages

    Get the preferred messages for the given request

  13. abstract def preferred(candidates: Seq[Lang]): Messages

    Get the preferred messages for the given candidates.

    Get the preferred messages for the given candidates.

    Will select a language from the candidates, based on the languages available, and fallback to the default language if none of the candidates are available.

  14. abstract def setLang(result: Result, lang: Lang): Result

    Given a Result and a Lang, return a new Result with the lang cookie set to the given Lang.

  15. abstract def translate(key: String, args: Seq[Any])(implicit lang: Lang): Option[String]

    Translates a message.

    Translates a message.

    Uses java.text.MessageFormat internally to format the message.

    key

    the message key

    args

    the message arguments

    returns

    the formatted message, if this key was defined

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def asJava: i18n.MessagesApi

    returns

    The Java version for Messages API.

  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped