Core/io.tolgee.common/PlatformTolgee

PlatformTolgee

actual typealias PlatformTolgee = TolgeeAndroid(source)

Typealias representing a platform-specific implementation of the Tolgee class for Android.

This alias maps PlatformTolgee to TolgeeAndroid on the Android platform, allowing platform dependency abstraction in multi-platform projects. The actual implementation, TolgeeAndroid, provides Android-specific utilities for managing translations and localization tasks using string resources.

actual data class PlatformTolgee : Tolgee(source)

An actual implementation of the Tolgee class for a specific platform. This class is used to handle platform-specific operations and configurations related to the Tolgee localization framework.

actual typealias PlatformTolgee = TolgeeApple

Provides a platform-specific type alias for the Tolgee localization framework implementation. On Apple platforms, PlatformTolgee is resolved to TolgeeApple, which handles localization functionality specific to Apple environments.

expect class PlatformTolgee : Tolgee(source)

Platform-specific implementation of the Tolgee interface. This class is expected to provide platform-dependent functionalities for the Tolgee library, enabling internationalization and localization features.

actual data class PlatformTolgee : Tolgee(source)

A platform-specific implementation of the Tolgee class.

This class provides platform-specific configuration and behavior for Tolgee functionalities and extends the core Tolgee class by implementing platform-targeted logic.

Parameters

config

The configuration used to initialize the Tolgee instance.

actual data class PlatformTolgee : Tolgee(source)

Platform-specific implementation of the Tolgee class.

This class provides platform-specific functionality for the Tolgee library. It inherits from the common Tolgee base class and applies the supplied configuration.

Parameters

config

The configuration object used to set up the Tolgee instance.

actual data class PlatformTolgee : Tolgee(source)

An actual implementation of the Tolgee class for a specific platform. This class is used to handle platform-specific operations and configurations related to the Tolgee localization framework.

actual data class PlatformTolgee : Tolgee(source)

Actual implementation of the PlatformTolgee class for a specific platform. It extends the Tolgee base class and is initialized with a Config object.

This class is used to provide platform-specific implementations or configurations for the Tolgee library.

Parameters

config

The configuration object used to initialize the PlatformTolgee instance.

actual data class PlatformTolgee : Tolgee(source)

A platform-specific implementation of the Tolgee class. This class extends the Tolgee base class and provides platform-dependent behavior.

Parameters

config

The configuration object used to initialize the Tolgee instance.

Properties

Link copied to clipboard
val changeFlow: MutableSharedFlow<Unit>
val changeFlow: MutableSharedFlow<Unit>

A flow that emits whenever translations change.

val changeFlow: MutableSharedFlow<Unit>

A flow that emits whenever translations change.

val changeFlow: <Error class: unknown class>

A flow that emits whenever translations change.

val changeFlow: MutableSharedFlow<Unit>
val changeFlow: MutableSharedFlow<Unit>
val changeFlow: MutableSharedFlow<Unit>

A flow that emits whenever translations change.

Link copied to clipboard
open override val config: Tolgee.Config

The configuration object that contains settings and options necessary for the operation of the Tolgee framework.

open val config: Tolgee.Config
open override val config: Tolgee.Config
open override val config: Tolgee.Config
open override val config: Tolgee.Config

The configuration object that contains settings and options necessary for the operation of the Tolgee framework.

open override val config: Tolgee.Config
open override val config: Tolgee.Config

Functions

Link copied to clipboard
fun addChangeListener(listener: Tolgee.ChangeListener)
fun addChangeListener(listener: Tolgee.ChangeListener)

Registers a listener to be notified when translations change.

fun addChangeListener(listener: Tolgee.ChangeListener)

Registers a listener to be notified when translations change.

fun addChangeListener(listener: Tolgee.ChangeListener)

Registers a listener to be notified when translations change.

fun addChangeListener(listener: Tolgee.ChangeListener)
fun addChangeListener(listener: Tolgee.ChangeListener)
fun addChangeListener(listener: Tolgee.ChangeListener)

Registers a listener to be notified when translations change.

Link copied to clipboard
open fun getLocale(): Locale
open fun getLocale(): Locale

Gets the current locale for the Tolgee instance.

open fun getLocale(): DefaultLocaleImpl

Gets the current locale for the Tolgee instance.

open fun getLocale(): <Error class: unknown class>

Gets the current locale for the Tolgee instance.

open fun getLocale(): Locale
open fun getLocale(): Locale
open fun getLocale(): DefaultLocaleImpl

Gets the current locale for the Tolgee instance.

Link copied to clipboard
open suspend fun preload()
open suspend fun preload()

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

open suspend fun preload()

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

open suspend fun preload()

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

open suspend fun preload()
open suspend fun preload()
open suspend fun preload()

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

Link copied to clipboard
fun removeChangeListener(listener: Tolgee.ChangeListener): Boolean
fun removeChangeListener(listener: Tolgee.ChangeListener): Boolean

Unregisters a previously registered change listener.

fun removeChangeListener(listener: Tolgee.ChangeListener): Boolean

Unregisters a previously registered change listener.

fun removeChangeListener(listener: Tolgee.ChangeListener): Boolean

Unregisters a previously registered change listener.

fun removeChangeListener(listener: Tolgee.ChangeListener): Boolean
fun removeChangeListener(listener: Tolgee.ChangeListener): Boolean
fun removeChangeListener(listener: Tolgee.ChangeListener): Boolean

Unregisters a previously registered change listener.

Link copied to clipboard
open fun setLocale(locale: Locale): Locale
open fun setLocale(localeTag: String): Locale
@JvmOverloads
open fun setLocale(locale: Locale): Locale

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

@JvmOverloads
open fun setLocale(localeTag: String): Locale

Adjusts the current locale used for translations.

@JvmOverloads
open fun setLocale(locale: Locale): DefaultLocaleImpl

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

@JvmOverloads
open fun setLocale(localeTag: String): <Error class: unknown class>

Adjusts the current locale used for translations.

@JvmOverloads
open fun setLocale(locale: <Error class: unknown class>): <Error class: unknown class>

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

@JvmOverloads
open fun setLocale(localeTag: String): <Error class: unknown class>

Adjusts the current locale used for translations.

open fun setLocale(locale: Locale): Locale
open fun setLocale(localeTag: String): Locale
open fun setLocale(locale: Locale): Locale
open fun setLocale(localeTag: String): Locale
@JvmOverloads
open fun setLocale(locale: Locale): DefaultLocaleImpl

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

@JvmOverloads
open fun setLocale(localeTag: String): <Error class: unknown class>

Adjusts the current locale used for translations.

Link copied to clipboard
open fun t(key: String, parameters: TolgeeMessageParams): String?
@JvmOverloads
open fun t(key: String, parameters: TolgeeMessageParams = TolgeeMessageParams.None): String?

Immediate Tolgee translation for a key with parameters.

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

Immediate Tolgee translation for a key with parameters.

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

Immediate Tolgee translation for a key with parameters.

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

Immediate Tolgee translation for a key with parameters.

Link copied to clipboard
open fun tArray(key: String): List<String>
open fun tArray(key: String): List<String>
open fun tArray(key: String): List<String>
open fun tArray(key: String): List<String>
open fun tArray(key: String): List<String>
open fun tArray(key: String): List<String>
open fun tArray(key: String): List<String>
Link copied to clipboard
open fun tArrayFlow(key: String): Flow<List<String>>
open fun tArrayFlow(key: String): Flow<List<String>>
open fun tArrayFlow(key: String): Flow<List<String>>
open fun tArrayFlow(key: String): Flow<List<String>>
open fun tArrayFlow(key: String): Flow<List<String>>
open fun tArrayFlow(key: String): Flow<List<String>>
open fun tArrayFlow(key: String): Flow<List<String>>
Link copied to clipboard
open fun tFlow(key: String, parameters: TolgeeMessageParams): Flow<String>
@JvmOverloads
open fun tFlow(key: String, parameters: TolgeeMessageParams = TolgeeMessageParams.None): Flow<String>

Updating Tolgee translation for a key with parameters.

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

Updating Tolgee translation for a key with parameters.

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

Updating Tolgee translation for a key with parameters.

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

Updating Tolgee translation for a key with parameters.