play.api.i18n

DefaultMessagesApi

Related Doc: package i18n

class DefaultMessagesApi extends MessagesApi

The internationalisation 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
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DefaultMessagesApi(environment: Environment, configuration: Configuration, langs: Langs)

    Annotations
    @Inject()

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 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

    Definition Classes
    DefaultMessagesApiMessagesApi
  5. 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

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

    Definition Classes
    Any
  7. def clearLang(result: Result): Result

    Definition Classes
    DefaultMessagesApiMessagesApi
  8. def clone(): AnyRef

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

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

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

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

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

    Definition Classes
    AnyRef → Any
  14. 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

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

    Definition Classes
    Any
  16. lazy val langCookieHttpOnly: Boolean

    Definition Classes
    DefaultMessagesApiMessagesApi
  17. lazy val langCookieName: String

    Definition Classes
    DefaultMessagesApiMessagesApi
  18. lazy val langCookieSecure: Boolean

    Definition Classes
    DefaultMessagesApiMessagesApi
  19. def loadAllMessages: Map[String, Map[String, String]]

    Attributes
    protected
  20. def loadMessages(file: String): Map[String, String]

    Attributes
    protected
  21. val messages: Map[String, Map[String, String]]

    Get all the defined messages

    Get all the defined messages

    Definition Classes
    DefaultMessagesApiMessagesApi
  22. val messagesPrefix: Option[String]

    Attributes
    protected
  23. final def ne(arg0: AnyRef): Boolean

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

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

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

    Get the preferred messages for the given Java request

    Get the preferred messages for the given Java request

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

    Get the preferred messages for the given request

    Get the preferred messages for the given request

    Definition Classes
    DefaultMessagesApiMessagesApi
  28. 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.

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

    Set the language on the result

    Set the language on the result

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

    Definition Classes
    AnyRef
  31. def toString(): String

    Definition Classes
    AnyRef → Any
  32. 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

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from MessagesApi

Inherited from AnyRef

Inherited from Any

Ungrouped