Version: Kotlin Multiplatform SDK

Reference

Introduction

The reference is your key to a comprehensive understanding of the Screeb Kotlin Multiplatform SDK.

✨ If this is your first look at the documentation, we recommend beginning with the Getting started guide.

After installing the Screeb KMP SDK, you can call the SDK from common Kotlin code:

import app.screeb.sdk.kmp.Screeb

Screeb.methodName(argument1, argument2)

Method	Description	More
`initSdk`	Initialize the SDK and associate the current session with your Screeb project.	👉
`closeSdk`	Stop the SDK and clear registered hooks.	👉
`setIdentity`	Identify the current user.	👉
`resetIdentity`	Reset the current user session and switch to an anonymous visitor.	👉
`getIdentity`	Get the current visitor identity.	👉
`setProperties`	Update visitor properties.	👉
`assignGroup`	Assign the current user to a group.	👉
`unassignGroup`	Remove the current user from a group.	👉
`trackEvent`	Track a custom event.	👉
`trackScreen`	Track a screen navigation.	👉
`startSurvey`	Start a survey programmatically.	👉
`closeSurvey`	Close the current survey.
`startMessage`	Start a message programmatically.	👉
`closeMessage`	Close the current message.
`sessionReplayStart`	Start session replay recording.	👉
`sessionReplayStop`	Stop session replay recording.	👉
`debug`	Get SDK debug information.	👉
`debugTargeting`	Get targeting debug information.	👉

ScreebHooks callbacks are supported on Android and iOS for initSdk, startSurvey, and startMessage.

The KMP SDK exposes platform helpers for native Android View and iOS UIView instances:

Helper	Description
`screebMaskText()`	Masks text content in session replay.
`screebNoCapture()`	Excludes the view from session replay capture.
`screebId("stable_id")`	Sets a stable view identifier for replay and targeting context.