umami/dev.appoutlet.umami/UmamiOptionsBuilder

UmamiOptionsBuilder

class UmamiOptionsBuilder

A DSL-style builder for constructing UmamiOptions instances, providing a flexible way to configure the Umami client.

This builder allows setting various properties such as the API endpoint, tracking parameters, and technical configurations like the HTTP client engine and coroutine scope. After configuring the desired options, the internal build method is called to create an immutable UmamiOptions object.

Example usage:

val umami = Umami(websiteId = "your-website-id") {
    baseUrl("https://my.umami.instance")
    hostname("myapp.com")
    // ... other configurations
}

Constructors

UmamiOptionsBuilder

constructor()

Properties

var baseUrl: Url

The base URL of the Umami API endpoint. Defaults to "https://cloud.umami.is".

var coroutineScope: CoroutineScope

The coroutine scope for background tasks. Defaults to Dispatchers.Default.

eventQueueCapacity

var eventQueueCapacity: Int

The maximum number of events to hold in the queue. Defaults to EVENT_QUEUE_CAPACITY.

var headers: SuspendMutableMap<String, String>

A suspendable map for managing custom HTTP headers. Defaults to InMemoryHeaders.

var hostname: Hostname?

The hostname of the website being tracked (e.g., "myapp.com").

httpClientEngine

var httpClientEngine: HttpClientEngine

The Ktor HTTP client engine for network requests. Defaults to the platform's default engine.

var ip: Ip?

The IP address of the user.

var language: Language?

The language of the user's browser, in IETF language tag format (e.g., "en-US").

var logger: UmamiLogger

The logger for internal library messages. Defaults to DefaultUmamiLogger.

var screenSize: ScreenSize?

The screen size of the user's device (e.g., "1920x1080").

var userAgent: String

The user agent string of the client. Defaults to a generated value.

Functions

fun baseUrl(value: String)

Sets the base URL of the Umami API from a string.

fun hostname(value: String)

Sets the hostname of the website being tracked.

fun ip(value: String)

Sets the IP address of the user.

fun language(value: String)

Sets the language of the user's browser from an IETF language tag string.

fun screenSize(value: String)

Sets the screen size from a string in "widthxheight" format (e.g., "1920x1080").

fun screenSize(width: Int, height: Int)

Sets the screen size from explicit width and height values.