Trait

play.api.i18n

MessagesApi

Related Doc: package i18n

Permalink

trait MessagesApi extends AnyRef

The internationalisation API.

Source
Messages.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
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

    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

  2. abstract 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

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

    Permalink
  4. abstract 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

  5. abstract def langCookieHttpOnly: Boolean

    Permalink
  6. abstract def langCookieName: String

    Permalink
  7. abstract def langCookieSecure: Boolean

    Permalink
  8. abstract def messages: Map[String, Map[String, String]]

    Permalink

    Get all the defined messages

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

    Permalink

    Get the preferred messages for the given Java request

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

    Permalink

    Get the preferred messages for the given request

  11. abstract 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.

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

    Permalink

    Set the language on the result

  13. abstract 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

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. final def asInstanceOf[T0]: T0

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

    Permalink

    returns

    The Java version for Messages API.

  6. def clone(): AnyRef

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  16. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped