eventtracker/in.singhangad.eventtracker/EventTrackerConfig/Builder

Builder

class Builder

Fluent builder for EventTrackerConfig.

EventTrackerConfig.Builder()
    .addAdapter(BackendBatchAdapter("https://api.example.com/v1/events"))
    .addAdapter(FirebaseAdapter()) // requires :eventtracker-adapter-firebase
    .batchSize(75)
    .maxRetries(10)
    .build()
Content copied to clipboard

Constructors

Link copied to clipboard
constructor()

Functions

Link copied to clipboard
fun addAdapter(adapter: EventAdapter): EventTrackerConfig.Builder

Register a destination adapter. Adapters are called in registration order. At least one adapter is required by build.

Link copied to clipboard
fun batchIntervalMs(ms: Long): EventTrackerConfig.Builder

Maximum age of a queued event before an automatic flush is triggered.

Link copied to clipboard
fun batchSize(size: Int): EventTrackerConfig.Builder

Maximum events per backend batch. Clamped to 1..1000.

Link copied to clipboard
fun build(): EventTrackerConfig

Build the immutable EventTrackerConfig.

Link copied to clipboard
fun encryptAtRest(enabled: Boolean): EventTrackerConfig.Builder

Enable SQLCipher encryption for the local database. Requires the host app to include the net.zetetic:android-database-sqlcipher dependency.

Link copied to clipboard
fun logger(logger: EventLogger): EventTrackerConfig.Builder

Provide a custom logger. Defaults to a no-op logger in production.

Link copied to clipboard
fun maxLocalEvents(n: Int): EventTrackerConfig.Builder

Hard cap on the local events table. Excess oldest rows are dropped.

Link copied to clipboard
fun maxRetries(n: Int): EventTrackerConfig.Builder

Maximum HTTP delivery attempts before events are dead-lettered.

Link copied to clipboard
fun samplingRate(eventName: String, rate: Double): EventTrackerConfig.Builder

Set a per-event-name sampling rate.