tolgee-mobile-kotlin-sdk

Core/io.tolgee/Tolgee

Tolgee

open class Tolgee(val config: Tolgee.Config)(source)

The Tolgee class serves as the primary interface for interacting with the Tolgee localization and translation framework. It provides mechanisms for managing languages, locales, and translations in a coroutine-safe and thread-safe manner, ensuring seamless integration of localization features into Kotlin-based applications.

This class maintains internal caches and reactive flows for efficient retrieval and updates of translations and locales, prioritizing both performance and flexibility in multilingual environments.

Core features include:

Loading and caching of project languages and translations
Locale management with support for reactive updates
On-demand and immediate translation resolution

Designed for applications requiring dynamic multilingual support, the Tolgee class ensures thread-safe access patterns and handles asynchronous operations efficiently to maintain consistent behavior.

Properties:

config: Configuration settings for the Tolgee instance.

Methods:

tFlow: Processes and streams dynamic translations for a given key and parameters.
t: Immediately resolves a translation for a given key and parameters.
preload: Preloads languages and translations into memory for subsequent use.
setLocale: Updates the current locale using various parameter types.

Inheritors

Constructors

constructor(config: Tolgee.Config)

Types

interface ChangeListener

Interface for listening to changes in Tolgee translations.

object Companion

The companion object for the Tolgee class, providing static methods and properties to manage the global state and initialization of Tolgee instances.

data class Config

Represents the configuration used for API integration and content management.

sealed interface Formatter

Represents a formatter interface used for defining different formatting strategies for translations within the Tolgee platform.

Properties

availableLocales

open val availableLocales: List<Locale>?

The list of available locales from the manifest or configuration.

availableLocaleTags

open val availableLocaleTags: List<String>?

The list of available locale tags (e.g., ["en", "fr", "de"]) from the manifest or configuration.

val changeFlow: MutableSharedFlow<Unit>

A flow that emits whenever translations change.

open val config: Tolgee.Config

Functions

addChangeListener

fun addChangeListener(listener: Tolgee.ChangeListener)

Registers a listener to be notified when translations change.

open fun getLocale(): Locale

Gets the current locale for the Tolgee instance.

open suspend fun preload()

Preloads the required languages and their translations for the current Tolgee instance.

open suspend fun preloadAll()

Preloads all available languages and their translations into memory.

removeChangeListener

fun removeChangeListener(listener: Tolgee.ChangeListener): Boolean

Unregisters a previously registered change listener.

open fun setLocale(locale: Locale): Locale

Sets the current locale for the Tolgee instance, updating it in the reactive locale flow.

open fun setLocale(localeTag: String): Locale

Adjusts the current locale used for translations.

open fun t(key: String, parameters: TolgeeMessageParams = TolgeeMessageParams.None): String?

Immediate Tolgee translation for a key with parameters.

open fun tArray(key: String): List<String>

open fun tArrayFlow(key: String): Flow<List<String>>

open fun tFlow(key: String, parameters: TolgeeMessageParams = TolgeeMessageParams.None): Flow<String>

Updating Tolgee translation for a key with parameters.