umami/dev.appoutlet.umami/Umami

Umami

class Umami(website: Uuid, enableEventQueue: Boolean = true, umamiOptions: UmamiOptionsBuilder.() -> Unit = {})

The main entry point for the Umami analytics library. This class is responsible for initializing the Umami configuration and managing the event queue.

Parameters

enableEventQueue

A flag to enable or disable the event queue.

umamiOptions

A builder for configuring Umami options.

Constructors

Umami

constructor(website: Uuid, enableEventQueue: Boolean = true, umamiOptions: UmamiOptionsBuilder.() -> Unit = {})

constructor(website: String, umamiOptions: UmamiOptionsBuilder.() -> Unit = {})

Creates an Umami instance.

constructor(website: Uuid, umamiOptions: UmamiOptionsBuilder.() -> Unit = {})

Creates an Umami instance.

Properties

headers

val Umami.headers: SuspendMutableMap<String, String>

Provides convenient, internal access to the suspendable map of custom HTTP headers.

httpClient

val httpClient: HttpClient

An HTTP client for making requests to the Umami API. This client is created lazily to ensure it is initialized only when needed.

logger

val Umami.logger: UmamiLogger

Provides convenient, internal access to the configured UmamiLogger instance.

Functions

event

fun Umami.event(referrer: String? = null, title: String? = null, url: String? = null, name: String? = null, data: Map<String, Any?>? = null, tag: String? = null, timestamp: Long? = now(), id: String? = null)

Sends an event to the Umami API.

identify

fun Umami.identify(data: Map<String, Any?>? = null, timestamp: Long? = now(), id: String? = null)

Sends an event to identify the user on the Umami server.

Umami

Parameters

See also

Constructors

Properties

Functions