Reference
Complete reference for the Screeb Kotlin Multiplatform SDK.
✨ New to Screeb? Start with the Install guide.
Methods by capability
Lifecycle
| Method | Description | More |
|---|---|---|
initSdk(channelId: String, userId: String? = null, properties: Map<String, Any>? = null, hooks: ScreebHooks? = null, initOptions: ScreebInitOptions? = null, language: String? = null): Boolean? | Initialize the Screeb SDK. | 👉 |
closeSdk(): Boolean? | Stop the SDK. | 👉 |
Identity
| Method | Description | More |
|---|---|---|
setIdentity(userId: String, properties: Map<String, Any>? = null): Boolean? | Identify the current user with optional properties. | 👉 |
setProperties(properties: Map<String, Any>? = null): Boolean? | Send visitor properties without changing the identity. | 👉 |
resetIdentity(): Boolean? | Reset the current visitor identity. | 👉 |
getIdentity(): Map<String, Any>? | Get the current visitor identity and properties. | 👉 |
Groups
| Method | Description | More |
|---|---|---|
assignGroup(groupType: String? = null, groupName: String, properties: Map<String, Any>? = null): Boolean? | Assign the current user to a group. | 👉 |
unassignGroup(groupType: String? = null, groupName: String, properties: Map<String, Any>? = null): Boolean? | Remove the current user from a group. | 👉 |
Tracking
| Method | Description | More |
|---|---|---|
trackEvent(name: String, properties: Map<String, Any>? = null): Boolean? | Track a custom event. | 👉 |
trackScreen(name: String, properties: Map<String, Any>? = null): Boolean? | Track a screen navigation event. | 👉 |
Surveys
| Method | Description | More |
|---|---|---|
startSurvey(surveyId: String, allowMultipleResponses: Boolean = true, hiddenFields: Map<String, Any>? = null, ignoreSurveyStatus: Boolean = true, hooks: ScreebHooks? = null, language: String? = null, distributionId: String? = null): Boolean? | Start a specific survey programmatically. | 👉 |
closeSurvey(surveyId: String? = null): Boolean? | Close the currently displayed survey. | - |
Messages
| Method | Description | More |
|---|---|---|
startMessage(messageId: String, allowMultipleResponses: Boolean = true, hiddenFields: Map<String, Any>? = null, ignoreMessageStatus: Boolean = true, hooks: ScreebHooks? = null, language: String? = null, distributionId: String? = null): Boolean? | Start a specific message programmatically. | 👉 |
closeMessage(messageId: String? = null): Boolean? | Close the currently displayed message. | 👉 |
Session replay
| Method | Description | More |
|---|---|---|
sessionReplayStart(): Boolean? | Start session replay recording. | 👉 |
sessionReplayStop(): Boolean? | Stop session replay recording. | 👉 |
Debug
| Method | Description | More |
|---|---|---|
debug(): String? | Get SDK debug information. | 👉 |
debugTargeting(): String? | Get targeting debug information. | 👉 |
Privacy helpers
| Method | Description | More |
|---|---|---|
View.screebMaskText(): View | Mask a view or component in session replay. | 👉 |
UIView.screebMaskText(): UIView | Mask a view or component in session replay. | 👉 |
View.screebNoCapture(): View | Exclude a view or component from session replay capture. | 👉 |
UIView.screebNoCapture(): UIView | Exclude a view or component from session replay capture. | 👉 |
View.screebId(id: String): View | Set a stable Screeb element ID for IAM targeting. | 👉 |
UIView.screebId(id: String): UIView | Set a stable Screeb element ID for IAM targeting. | 👉 |
API signatures
Lifecycle
initSdk(channelId: String, userId: String? = null, properties: Map<String, Any>? = null, hooks: ScreebHooks? = null, initOptions: ScreebInitOptions? = null, language: String? = null): Boolean?
closeSdk(): Boolean?
Identity
setIdentity(userId: String, properties: Map<String, Any>? = null): Boolean?
setProperties(properties: Map<String, Any>? = null): Boolean?
resetIdentity(): Boolean?
getIdentity(): Map<String, Any>?
Groups
assignGroup(groupType: String? = null, groupName: String, properties: Map<String, Any>? = null): Boolean?
unassignGroup(groupType: String? = null, groupName: String, properties: Map<String, Any>? = null): Boolean?
Tracking
trackEvent(name: String, properties: Map<String, Any>? = null): Boolean?
trackScreen(name: String, properties: Map<String, Any>? = null): Boolean?
Surveys
startSurvey(surveyId: String, allowMultipleResponses: Boolean = true, hiddenFields: Map<String, Any>? = null, ignoreSurveyStatus: Boolean = true, hooks: ScreebHooks? = null, language: String? = null, distributionId: String? = null): Boolean?
closeSurvey(surveyId: String? = null): Boolean?
Messages
startMessage(messageId: String, allowMultipleResponses: Boolean = true, hiddenFields: Map<String, Any>? = null, ignoreMessageStatus: Boolean = true, hooks: ScreebHooks? = null, language: String? = null, distributionId: String? = null): Boolean?
closeMessage(messageId: String? = null): Boolean?
Session replay
sessionReplayStart(): Boolean?
sessionReplayStop(): Boolean?
Debug
debug(): String?
debugTargeting(): String?
Privacy helpers
View.screebMaskText(): View
UIView.screebMaskText(): UIView
View.screebNoCapture(): View
UIView.screebNoCapture(): UIView
View.screebId(id: String): View
UIView.screebId(id: String): UIView
Hooks
Hooks can be passed to initialization and programmatic survey/message starts. Callback payloads are forwarded as JSON strings by the mobile wrappers.
val hooks = ScreebHooks(
version = "1.0.0",
callbacks = mapOf(
"onSurveyShowed" to { payload -> /* handle hook payload */ },
),
)
For complete hook payload definitions, see the JS tag hooks reference.
Privacy helpers
view.screebMaskText()
view.screebNoCapture()
view.screebId("checkout-button")
Type definitions
data class ScreebHooks( val version: String, val callbacks: Map<String, suspend (String) -> Any?> = emptyMap(), )
data class ScreebInitOptions( val isDebugMode: Boolean = false, val disableMirror: Boolean = false, )