Builder

Provides a builder pattern for constructing a Config instance with customizable properties. Supports fluent method chaining to set various parameters such as API keys, URLs, project ID, locale, network configuration, and CDN settings.

Constructors

Builder

constructor()

Properties

availableLocales

var availableLocales: List<Locale>?

A list of available locales. If specified, the app won't try to fetch a manifest from the server. Instead, it will use the provided list of locales. Can be used to save on network requests.

contentDelivery

var contentDelivery: Tolgee.Config.ContentDelivery

Represents the content delivery network (CDN) configuration associated with the builder.

defaultLanguage

var defaultLanguage: Locale?

The default language to use as a final fallback when the requested locale and its base language are not available. This ensures that users with unsupported languages receive translations from the CDN (in the default language) instead of falling back to native bundled translations.

locale

var locale: Locale?

Represents the locale used for translations or language-specific configurations. This variable holds a Locale object that defines the language and region settings for the associated configuration or operation.

network

var network: Tolgee.Config.Network

Represents the network configuration used within the Builder. This property defines the HTTP client and coroutine context used for executing network operations. Can be customized directly by setting a Network instance or using a builder lambda function.

Functions

availableLocales

fun availableLocales(vararg locales: Locale): Tolgee.Config.Builder

fun availableLocales(locales: List<Locale>): Tolgee.Config.Builder

Sets the available locales configuration for the builder and returns the instance for further customization.

availableLocaleTags

fun availableLocaleTags(vararg localeTags: String): Tolgee.Config.Builder

fun availableLocaleTags(localeTags: List<String>): Tolgee.Config.Builder

Sets the available locales configuration for the builder and returns the instance for further customization.

build

fun build(): Tolgee.Config

Builds and returns a new instance of the Config class using the provided builder properties.

contentDelivery

fun contentDelivery(contentDelivery: Tolgee.Config.ContentDelivery): Tolgee.Config.Builder

Sets the CDN configuration for the Builder instance.

fun contentDelivery(builder: Tolgee.Config.ContentDelivery.Builder.() -> Unit): Tolgee.Config.Builder

Configures the CDN settings for the builder.

@JvmOverloads

fun contentDelivery(url: String, builder: Tolgee.Config.ContentDelivery.Builder.() -> Unit = { }): Tolgee.Config.Builder

Configures the content delivery settings for the Builder instance.

defaultLanguage

fun defaultLanguage(locale: Locale): Tolgee.Config.Builder

fun defaultLanguage(localeTag: String): Tolgee.Config.Builder

Sets the default language to use as a final fallback when the requested locale is not available.

locale

fun locale(locale: Locale): Tolgee.Config.Builder

Sets the locale configuration for the builder and returns the instance for further customization.

fun locale(localeTag: String): Tolgee.Config.Builder

Sets the locale for the configuration using the provided locale string.

locale

fun Tolgee.Config.Builder.locale(nsLocale: NSLocale): Tolgee.Config.Builder

Sets the locale configuration for the builder and returns the instance for further customization.

network

fun network(network: Tolgee.Config.Network): Tolgee.Config.Builder

Configures the network settings for the builder.

fun network(builder: Tolgee.Config.Network.Builder.() -> Unit): Tolgee.Config.Builder

Configures the network settings for the builder using the provided configuration block.