multipaz/org.multipaz.eventlogger/SimpleEventLogger

SimpleEventLogger

class SimpleEventLogger(storage: Storage, partitionId: String = "default", expireAfter: Duration = 60.days, clock: Clock = Clock.System, onAddEvent: suspend (event: Event) -> Map<String, DataItem>? = { _ -> emptyMap() }, scope: CoroutineScope = CoroutineScope(Dispatchers.Default)) : EventLogger

An implementation of EventLogger backed by a Storage implementation.

This implementation also provides an observable flow (eventFlow) that emits whenever the underlying event data is modified, making it easy for UI or other observers to react to changes.

Applications may use onAddEvent to determine if an event should be dropped or if additional application-specific data should be amended to the event. For example an application may have per-document setting on whether to log events or it may add a GPS-location for proximity presentment events.

Constructors

SimpleEventLogger

constructor(storage: Storage, partitionId: String = "default", expireAfter: Duration = 60.days, clock: Clock = Clock.System, onAddEvent: suspend (event: Event) -> Map<String, DataItem>? = { _ -> emptyMap() }, scope: CoroutineScope = CoroutineScope(Dispatchers.Default))

Types

Companion

object Companion

Properties

eventFlow

val eventFlow: SharedFlow<Unit>

A SharedFlow that emits a Unit whenever an event is added, deleted, or when all events are cleared. Observers can collect this flow to know when to refresh their data.

Functions

addEvent

open suspend override fun addEvent(event: Event): Event?

Adds a new event to the logger.

addEventAsync

open override fun addEventAsync(event: Event)

Asynchronously adds an event to the event log.

deleteAllEvents

suspend fun deleteAllEvents()

Deletes all events within the current partition.

deleteEvent

suspend fun deleteEvent(event: Event): Boolean

Deletes a specific event from the logger.

getEvents

suspend fun getEvents(limit: Int = Int.MAX_VALUE, afterEventId: String? = null): List<Event>

Retrieves all events stored in the current partition.