Reference

Complete reference for @screeb/react-native.

✨ New to Screeb? Start with the Install guide.

Methods by capability

Lifecycle

Method	Description	More
initSdk(channelId: string, userId?: string, properties?: Record<string, unknown> | Map<string, unknown>, hooks?: HookMap, initOptions?: InitOptions, language?: string): Promise<void>	Initialize the Screeb SDK.	👉
closeSdk(): Promise<void>	Stop the SDK.	👉

Identity

Method	Description	More
setIdentity(userId: string, properties?: Record<string, unknown> | Map<string, unknown> | null): Promise<void>	Identify the current user with optional properties.	👉
setProperties(properties?: Record<string, unknown> | Map<string, unknown> | null): Promise<void>	Send visitor properties without changing the identity.	👉
resetIdentity(): Promise<void>	Reset the current visitor identity.	👉
getIdentity(): Promise<{ [key: string]: unknown; } | null>	Get the current visitor identity and properties.	👉

Groups

Method	Description	More
assignGroup(type: string | null, name: string, properties?: Record<string, unknown> | Map<string, unknown> | null): Promise<void>	Assign the current user to a group.	👉
unassignGroup(type: string | null, name: string, properties?: Record<string, unknown> | Map<string, unknown> | null): Promise<void>	Remove the current user from a group.	👉

Tracking

Method	Description	More
trackEvent(name: string, properties?: Record<string, unknown> | Map<string, unknown> | null): Promise<void>	Track a custom event.	👉
trackScreen(name: string, properties?: Record<string, unknown> | Map<string, unknown> | null): Promise<void>	Track a screen navigation event.	👉

Surveys

Method	Description	More
startSurvey(surveyId: string, allowMultipleResponses?: boolean, hiddenFields?: Record<string, unknown> | Map<string, unknown> | null, ignoreSurveyStatus?: boolean, hooks?: HookMap, language?: string, distributionId?: string): Promise<void>	Start a specific survey programmatically.	👉
closeSurvey(surveyId?: string): Promise<void>	Close the currently displayed survey.	-

Messages

Method	Description	More
startMessage(messageId: string, allowMultipleResponses?: boolean, hiddenFields?: Record<string, unknown> | Map<string, unknown> | null, ignoreMessageStatus?: boolean, hooks?: HookMap, language?: string, distributionId?: string): Promise<void>	Start a specific message programmatically.	👉
closeMessage(messageId?: string): Promise<void>	Close the currently displayed message.	👉

Session replay

Method	Description	More
sessionReplayStart(): Promise<void>	Start session replay recording.	👉
sessionReplayStop(): Promise<void>	Stop session replay recording.	👉

Debug

Method	Description	More
debug(): Promise<string>	Get SDK debug information.	👉
debugTargeting(): Promise<string>	Get targeting debug information.	👉

Privacy helpers

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

API signatures

Lifecycle

initSdk(channelId: string, userId?: string, properties?: Record<string, unknown> | Map<string, unknown>, hooks?: HookMap, initOptions?: InitOptions, language?: string): Promise<void>
closeSdk(): Promise<void>

Identity

setIdentity(userId: string, properties?: Record<string, unknown> | Map<string, unknown> | null): Promise<void>
setProperties(properties?: Record<string, unknown> | Map<string, unknown> | null): Promise<void>
resetIdentity(): Promise<void>
getIdentity(): Promise<{ [key: string]: unknown; } | null>

Groups

assignGroup(type: string | null, name: string, properties?: Record<string, unknown> | Map<string, unknown> | null): Promise<void>
unassignGroup(type: string | null, name: string, properties?: Record<string, unknown> | Map<string, unknown> | null): Promise<void>

Tracking

trackEvent(name: string, properties?: Record<string, unknown> | Map<string, unknown> | null): Promise<void>
trackScreen(name: string, properties?: Record<string, unknown> | Map<string, unknown> | null): Promise<void>

Surveys

startSurvey(surveyId: string, allowMultipleResponses?: boolean, hiddenFields?: Record<string, unknown> | Map<string, unknown> | null, ignoreSurveyStatus?: boolean, hooks?: HookMap, language?: string, distributionId?: string): Promise<void>
closeSurvey(surveyId?: string): Promise<void>

Messages

startMessage(messageId: string, allowMultipleResponses?: boolean, hiddenFields?: Record<string, unknown> | Map<string, unknown> | null, ignoreMessageStatus?: boolean, hooks?: HookMap, language?: string, distributionId?: string): Promise<void>
closeMessage(messageId?: string): Promise<void>

Session replay

sessionReplayStart(): Promise<void>
sessionReplayStop(): Promise<void>

Debug

debug(): Promise<string>
debugTargeting(): Promise<string>

Privacy helpers

ScreebMaskText(props: ScreebPrivacyViewProps)
ScreebNoCapture(props: ScreebPrivacyViewProps)
ScreebId({ id, ...props }: ScreebIdProps)

Hooks

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

const hooks = {
  version: "1.0.0",
  onSurveyShowed: async (payload: string) => {
    // handle hook payload
  },
};

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

Privacy helpers

<ScreebMaskText>
  <Text>Sensitive content</Text>
</ScreebMaskText>

<ScreebNoCapture>
  <Text>Do not record</Text>
</ScreebNoCapture>

<ScreebId id="checkout-button">
  <Button title="Checkout" />
</ScreebId>

Type definitions

type HookMap = {
  version?: string;
  [key: string]: unknown;
};

type InitOptions = {
  isDebugMode?: boolean;
  disableMirror?: boolean;
};

type ScreebPrivacyViewProps = ViewProps;

type ScreebIdProps = ViewProps & {
  id: string;
};