Constructor Detail

Method Detail

• setEnabled

   final static Unit setEnabled(Boolean enabled)

  Enable or disable Session Replay.

  Use this method to enable or disable Session Replay.

  Parameters:

  enabled - Pass true to enable Session Replay, false to disable.

• setNetworkLogsEnabled

   final static Unit setNetworkLogsEnabled(Boolean enable)

  Enable or disable recording network logs for Session Replay.

  Use this method to control the recording of network logs during Session Replay.

  Parameters:

  enable - Pass true to enable recording of network logs, false to disable.

• setLuciqLogsEnabled

   final static Unit setLuciqLogsEnabled(Boolean enable)

  Enable or disable recording Luciq logs for Session Replay.

  Use this method to control the recording of Luciq logs during Session Replay.

  Parameters:

  enable - Pass true to enable recording of Luciq logs, false to disable.

• setUserStepsEnabled

   final static Unit setUserStepsEnabled(Boolean enable)

  Enable or disable recording user steps for Session Replay.

  Use this method to control the recording of user steps during Session Replay.

  Parameters:

  enable - Pass true to enable recording of user steps, false to disable.

• getSessionReplayLink

   final static Unit getSessionReplayLink(OnSessionReplayLinkReady callback)

  Retrieves current session's replay link.

  Parameters:

  callback - an OnSessionReplayLinkReady to be invoked when link is ready.

• setSyncCallback

   final static Unit setSyncCallback(SessionSyncListener sessionSyncListener)

  Sets a callback to determine whether a Session Replay should be synchronized.

  This function allows you to register a SessionSyncListener to control the synchronization of Session Replays. The provided listener will be invoked at the beginning of the next session with metadata about the previous session.

  You can use this callback to implement custom logic to decide whether a Session Replay should be synchronized based on specific criteria, such as session duration, or session Attributes.

  Parameters:

  sessionSyncListener - The callback to be invoked before synchronizing a Session Replay.

• setScreenshotQuality

   final static Unit setScreenshotQuality(Integer profile)

  Sets the screenshot quality profile to be used during screenshot capture.

  This method allows configuring the compression and visual fidelity of captured screenshots by applying a specified ScreenshotQuality profile. Supported profiles include:

  • NORMAL (default).

  • HIGH

  • GREYSCALE

  The selected profile is applied at runtime and takes effect immediately. If GREYSCALE is requested but disabled via kill switch, it falls back to NORMAL.

  Parameters:

  profile - The desired quality profile.

• setCapturingMode

   final static Unit setCapturingMode(Integer mode)

  (EXPERIMENTAL) Video-like Session Replay may capture sensitive UI unmasked in some cases. USE AT YOUR OWN DISCRETION TO PREVENT PII LEAKAGE. Opt in ONLY after validating masking/privacy in your app.

  Sets the current screenshot capturing mode.

  This method allows switching between different screenshot strategies at runtime by applying the specified CapturingMode. Supported modes include:

  • NAVIGATION

  • INTERACTIONS

  • FREQUENCY

  If FREQUENCY or INTERACTIONS is requested but disabled via kill switch, it falls back to NAVIGATION.

  Parameters:

  mode - The desired capturing mode.

• setScreenshotCaptureInterval

   final static Unit setScreenshotCaptureInterval(Integer intervalMs)

  (EXPERIMENTAL) Video-like Session Replay may capture sensitive UI unmasked in some cases. USE AT YOUR OWN DISCRETION TO PREVENT PII LEAKAGE. Opt in ONLY after validating masking/privacy in your app.

  Updates the screenshot capture interval for the FREQUENCY capturing mode.

  This method configures how frequently screenshots should be captured (in milliseconds) when using the FREQUENCY mode.

  Behavior:

  • If the current capturingMode is not FREQUENCY, the interval will be reset to CAPTURING_FREQUENCY_DEFAULT and no further checks are performed.

  • If the provided intervalMs is less than MIN_SCREENSHOT_DELAY_MS, a warning is logged, and the interval will be reset to the default value CAPTURING_FREQUENCY_DEFAULT.

  • If intervalMs is valid and capturing mode is FREQUENCY, the interval is updated to the provided value.

  Default values:

  • Minimum interval allowed: 500 ms

  • Default fallback interval: 1000 ms

  Parameters:

  intervalMs - The desired screenshot interval in milliseconds.