Reference

Complete reference for the Screeb .NET MAUI SDK.

✨ New to Screeb? Start with the Install guide.

Methods by capability

Lifecycle

Method	Description	More
InitSdk(string channelId, string? userId = null, Dictionary<string, object>? properties = null, ScreebHooks? hooks = null, ScreebInitOptions? initOptions = null, string? language = null): Task<bool?>	Initialize the Screeb SDK. Must be called before any other method.	👉
CloseSdk(): Task<bool?>	Stop the SDK. Opposite of InitSdk.	👉

Identity

Method	Description	More
SetIdentity(string userId, Dictionary<string, object>? properties = null): Task<bool?>	Identify the current user with optional properties.	👉
SetProperties(Dictionary<string, object>? properties = null): Task<bool?>	Send visitor properties without changing the identity.	👉
ResetIdentity(): Task<bool?>	Reset user identity (e.g. on logout).	👉
GetIdentity(): Task<Dictionary<string, object>?>	Get current visitor identity and properties.	👉

Groups

Method	Description	More
AssignGroup(string? groupType, string groupName, Dictionary<string, object>? properties = null): Task<bool?>	Assign the current user to a group.	👉
UnassignGroup(string? groupType, string groupName, Dictionary<string, object>? properties = null): Task<bool?>	Remove the current user from a group.	👉

Tracking

Method	Description	More
TrackEvent(string name, Dictionary<string, object>? properties = null): Task<bool?>	Track a custom event.	👉
TrackScreen(string name, Dictionary<string, object>? properties = null): Task<bool?>	Track a screen navigation event.	👉

Surveys

Method	Description	More
StartSurvey(string surveyId, bool allowMultipleResponses = true, Dictionary<string, object>? hiddenFields = null, bool ignoreSurveyStatus = true, ScreebHooks? hooks = null, string? language = null, string? distributionId = null): Task<bool?>	Start a specific survey programmatically.	👉
CloseSurvey(string? surveyId = null): Task<bool?>	Close the currently displayed survey.	-

Messages

Method	Description	More
StartMessage(string messageId, bool allowMultipleResponses = true, Dictionary<string, object>? hiddenFields = null, bool ignoreMessageStatus = true, ScreebHooks? hooks = null, string? language = null, string? distributionId = null): Task<bool?>	Start a specific message programmatically.	👉
CloseMessage(string? messageId = null): Task<bool?>	Close the currently displayed message.	👉

Session replay

Method	Description	More
SessionReplayStart(): Task<bool?>	Start session replay recording.	👉
SessionReplayStop(): Task<bool?>	Stop session replay recording.	👉

Debug

Method	Description	More
Debug(): Task<string?>	Get SDK debug information.	👉
DebugTargeting(): Task<string?>	Get targeting debug information (why surveys aren't showing).	👉

Privacy helpers

Method	Description	More
ScreebMaskText(this T element): T	Mask a view or component in session replay.	👉
ScreebNoCapture(this T element): T	Exclude a view or component from session replay capture.	👉
ScreebId(this T element, string id): T	Set a stable Screeb element ID for IAM targeting.	👉

API signatures

Lifecycle

InitSdk(string channelId, string? userId = null, Dictionary<string, object>? properties = null, ScreebHooks? hooks = null, ScreebInitOptions? initOptions = null, string? language = null): Task<bool?>
CloseSdk(): Task<bool?>

Identity

SetIdentity(string userId, Dictionary<string, object>? properties = null): Task<bool?>
SetProperties(Dictionary<string, object>? properties = null): Task<bool?>
ResetIdentity(): Task<bool?>
GetIdentity(): Task<Dictionary<string, object>?>

Groups

AssignGroup(string? groupType, string groupName, Dictionary<string, object>? properties = null): Task<bool?>
UnassignGroup(string? groupType, string groupName, Dictionary<string, object>? properties = null): Task<bool?>

Tracking

TrackEvent(string name, Dictionary<string, object>? properties = null): Task<bool?>
TrackScreen(string name, Dictionary<string, object>? properties = null): Task<bool?>

Surveys

StartSurvey(string surveyId, bool allowMultipleResponses = true, Dictionary<string, object>? hiddenFields = null, bool ignoreSurveyStatus = true, ScreebHooks? hooks = null, string? language = null, string? distributionId = null): Task<bool?>
CloseSurvey(string? surveyId = null): Task<bool?>

Messages

StartMessage(string messageId, bool allowMultipleResponses = true, Dictionary<string, object>? hiddenFields = null, bool ignoreMessageStatus = true, ScreebHooks? hooks = null, string? language = null, string? distributionId = null): Task<bool?>
CloseMessage(string? messageId = null): Task<bool?>

Session replay

SessionReplayStart(): Task<bool?>
SessionReplayStop(): Task<bool?>

Debug

Debug(): Task<string?>
DebugTargeting(): Task<string?>

Privacy helpers

ScreebMaskText(this T element): T
ScreebNoCapture(this T element): T
ScreebId(this T element, string id): T

Hooks

Hooks can be passed to initialization and programmatic survey/message starts. Callback payloads are forwarded as JSON strings by the mobile wrappers.

var hooks = new ScreebHooks
{
    Version = "1.0.0",
    Callbacks =
    {
        ["onSurveyShowed"] = async payload =>
        {
            // handle hook payload
            return null;
        },
    },
};

For complete hook payload definitions, see the JS tag hooks reference.

Privacy helpers

entry.ScreebMaskText();

view.ScreebNoCapture();

button.ScreebId("checkout-button");

Type definitions

public class ScreebHooks
{
    /// <summary>Hooks version identifier passed verbatim to the native SDK.</summary>
    public required string Version { get; set; }

    /// <summary>
    /// Hook callbacks: key = hook name (e.g. "onSurveyShowed"),
    /// value = async callback receiving the JSON payload string.
    /// </summary>
    public Dictionary<string, Func<string, Task<object?>>> Callbacks { get; set; } = new();
}

public class ScreebInitOptions
{
    public bool IsDebugMode { get; set; } = false;
    public bool DisableMirror { get; set; } = false;
}