Skip to content
Deepdots Documentation

Models and Events

Models and Events

Section titled “Models and Events”

Initialization models

Section titled “Initialization models”

InitOptions

Section titled “InitOptions”
  • debug
  • popupOptions
  • provideLang
  • autoLaunch
  • renderChrome
  • metadata

renderChrome (default true, from 0.4.0) controls whether the SDK paints the popup “modal” — the dimmed scrim and the rounded card with elevation drawn by PopupView. Set it to false to render the popup transparent and full-bleed so it blends into your own screen; the survey stays functional (close button in the header, footer with back/start/complete/send). It mirrors the web/RN renderChrome flag. Note the native divergence: the chrome is native Compose (not HTML), and the SDK still auto-mounts a full-screen overlay, so the flag removes the scrim and card but does not hand the container mounting over to your app.

PopupOptions

Section titled “PopupOptions”
  • id
  • publicKey
  • companyId

ShowOptions

Section titled “ShowOptions”
  • surveyId
  • productId
  • data
Section titled “Popup definition model”

PopupDefinition

Section titled “PopupDefinition”
  • id
  • title
  • message
  • trigger
  • triggers
  • conditions
  • cooldown
  • legacyConditions
  • actions
  • surveyId
  • productId
  • style
  • segments

Trigger models

Section titled “Trigger models”

Supported trigger types in code:

  • Trigger.TimeOnPage(seconds: Double)
  • Trigger.Scroll(percentage: Int)
  • Trigger.Exit(delaySeconds: Double = 0.0)
  • Trigger.Event(name: String)
  • Trigger.Click(targetId: String)

Style and segmentation models

Section titled “Style and segmentation models”

Style

Section titled “Style”
  • theme
  • position
  • imageUrl
  • imageSize
  • imageAlignment

Segments

Section titled “Segments”
  • lang
  • path

Event model

Section titled “Event model”

Event

Section titled “Event”
  • PopupShown
  • PopupClicked
  • SurveyCompleted

The shared helper Event.code() maps them to:

  • popup_shown
  • popup_clicked
  • survey_completed

EventData

Section titled “EventData”
  • popupId
  • surveyId
  • productId
  • extra
  • timestamp

Notes for integration teams

Section titled “Notes for integration teams”
  • metadata is where the examples pass userId
  • LegacyCondition remains supported for backward compatibility