Class

play.api.i18n

DefaultMessagesApi

Related Doc: package i18n

Permalink

class DefaultMessagesApi extends MessagesApi

The Messages API.

Annotations
@Singleton()
Source
Messages.scala
Linear Supertypes
MessagesApi, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DefaultMessagesApi
  2. MessagesApi
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DefaultMessagesApi(messages: Map[String, Map[String, String]])

    Permalink
  2. new DefaultMessagesApi(javaMessages: Map[String, Map[String, String]], langs: i18n.Langs)

    Permalink
  3. new DefaultMessagesApi(messages: Map[String, Map[String, String]] = Map.empty, langs: Langs = new DefaultLangs(), langCookieName: String = "PLAY_LANG", langCookieSecure: Boolean = false, langCookieHttpOnly: Boolean = false, httpConfiguration: HttpConfiguration = HttpConfiguration())

    Permalink
    Annotations
    @Inject()

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 apply(keys: Seq[String], args: Any*)(implicit lang: Lang): String

    Permalink

    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

    Definition Classes
    DefaultMessagesApiMessagesApi
  5. def apply(key: String, args: Any*)(implicit lang: Lang): String

    Permalink

    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

    Definition Classes
    DefaultMessagesApiMessagesApi
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def asJava: i18n.MessagesApi

    Permalink

    returns

    The Java version for Messages API.

    Definition Classes
    MessagesApi
  8. def clearLang(result: Result): Result

    Permalink
    Definition Classes
    DefaultMessagesApiMessagesApi
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. final def eq(arg0: AnyRef): Boolean

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  15. val httpConfiguration: HttpConfiguration

    Permalink
  16. def isDefinedAt(key: String)(implicit lang: Lang): Boolean

    Permalink

    Check if a message key is defined.

    Check if a message key is defined.

    key

    the message key

    returns

    a boolean

    Definition Classes
    DefaultMessagesApiMessagesApi
  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  18. val langCookieHttpOnly: Boolean

    Permalink
    Definition Classes
    DefaultMessagesApiMessagesApi
  19. val langCookieName: String

    Permalink
    Definition Classes
    DefaultMessagesApiMessagesApi
  20. val langCookieSecure: Boolean

    Permalink
    Definition Classes
    DefaultMessagesApiMessagesApi
  21. val messages: Map[String, Map[String, String]]

    Permalink

    Get all the defined messages

    Get all the defined messages

    Definition Classes
    DefaultMessagesApiMessagesApi
  22. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  23. def noMatch(key: String, args: Seq[Any])(implicit lang: Lang): String

    Permalink
    Attributes
    protected
  24. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  26. def preferred(request: RequestHeader): Messages

    Permalink

    Get the preferred messages for the given request

    Get the preferred messages for the given request

    Definition Classes
    DefaultMessagesApiMessagesApi
  27. def preferred(request: RequestHeader): Messages

    Permalink

    Get the preferred messages for the given Java request

    Get the preferred messages for the given Java request

    Definition Classes
    DefaultMessagesApiMessagesApi
  28. def preferred(candidates: Seq[Lang]): Messages

    Permalink

    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.

    Definition Classes
    DefaultMessagesApiMessagesApi
  29. def setLang(result: Result, lang: Lang): Result

    Permalink

    Set the language on the result

    Set the language on the result

    Definition Classes
    DefaultMessagesApiMessagesApi
  30. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    AnyRef → Any
  32. def translate(key: String, args: Seq[Any])(implicit lang: Lang): Option[String]

    Permalink

    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

    Definition Classes
    DefaultMessagesApiMessagesApi
  33. final def wait(): Unit

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

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

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

Inherited from MessagesApi

Inherited from AnyRef

Inherited from Any

Ungrouped