Gå til indhold

API Reference

Denne side opsummerer de offentlige entry points, der er synlige i den delte Kotlin-kode.

Hovedansvar:

  • initialisere SDK-runtime
  • indlæse popup-definitioner
  • tilføje en platformskontekst
  • evaluere triggers og køsætte popups
  • rendere popup- og survey-oplevelser
  • udsende popup-lifecycle-events
  • init(options: InitOptions)
  • initialize(options: InitOptions)
  • autoLaunch()
  • attachContext(context: PlatformContext)
  • setPath(path: String?)
  • onScroll(percentage: Int)
  • onExit()
  • triggerEvent(eventName: String)
  • triggerClick(targetId: String)
  • show(options: ShowOptions, context: PlatformContext)
  • showByPopupId(popupId: String, context: PlatformContext)
  • triggerSurvey(surveyId: String, context: PlatformContext, popupId: String? = null)
  • on(event: Event, listener: (EventData) -> Unit)
  • off(event: Event, listener: (EventData) -> Unit)
  • environment: Environment — read-only, afspejler den backend, SDK’et peger på efter init() (standard er Environment.Production). Nyttig til i runtime at fastslå, hvilken backend en given publicKey rammer.

Deepdots-objektet tilbyder hjælpe-helpers:

  • create()
  • createInitialized(options)
  • now()
  • parseHtml(html)
  • dismiss(context)
  • getSurveyHtml(surveyId, productId)
  • createInitializedSimple(...)

Repositoriet tilbyder også scroll-binding-helpers på Android:

  • bindRecyclerView(recyclerView: RecyclerView)
  • bindScrollView(scrollView: ScrollView)

De hjælper med at oversætte værtens scroll til onScroll(...)-opdateringer til trigger-evaluering.