Skip to content

Android SESSION REPLAY

Prerequisites

Configuration

// Add SDK dependencies
implementation 'com.cloudcare.ft.mobile.sdk.tracker.agent:ft-sdk:[latest_version]'
// Enable session replay feature
implementation 'com.cloudcare.ft.mobile.sdk.tracker.agent:ft-session-replay:[latest_version]'
// To support session replay, material component support is required
implementation 'com.cloudcare.ft.mobile.sdk.tracker.agent:ft-session-replay-material:[latest_version]'

Code Invocation

FTSdk.initSessionReplayConfig(new FTSessionReplayConfig().setSampleRate(1f)
            .setPrivacy(SessionReplayPrivacy.ALLOW)
            .addExtensionSupport(new MaterialExtensionSupport()), context);

FTSdk.initSessionReplayConfig(FTSessionReplayConfig().setSampleRate(1f)
            .setPrivacy(SessionReplayPrivacy.ALLOW)
            .addExtensionSupport(MaterialExtensionSupport()), context)
Method Name Type Required Meaning
setSampleRate Float No Set the collection rate, range [0,1], 0 means no collection, 1 means full collection, default value is 1.
setPrivacy SessionReplayPrivacy No SessionReplayPrivacy.ALLOW does not mask privacy data, SessionReplayPrivacy.MASK masks all data including text, CheckBox, RadioButton, Switch; SessionReplayPrivacy.USER_INPUT (recommended) masks part of the user input data including text in input fields, CheckBox, RadioButton, Switch. Default is SessionReplayPrivacy.MASK. Deprecated soon, compatible usage recommended, prefer using setTouchPrivacy and setTextAndInputPrivacy for masking settings.
setTextAndInputPrivacy TextAndInputPrivacy No TextAndInputPrivacy.MASK_SENSITIVE_INPUTS masks only password information, TextAndInputPrivacy.MASK_ALL_INPUTS masks part of the user input data including text in input fields, CheckBox, RadioButton, Switch; TextAndInputPrivacy.MASK_ALL, masks all data including text, CheckBox, RadioButton, Switch. Default is TextAndInputPrivacy.MASK_ALL. Overrides setPrivacy configuration after setting. Supported in ft-session-replay version 0.1.1-alpha01 and above.
setTouchPrivacy TouchPrivacy No TouchPrivacy.SHOW does not mask touch data, TouchPrivacy.HIDE masks touch data. Overrides setPrivacy configuration after setting. Supported in ft-session-replay version 0.1.1-alpha01 and above.
addExtensionSupport ExtensionSupport No Adds additional custom support. Using ft-session-replay-material allows you to use MaterialExtensionSupport for additional Material component collection support.

Privacy Overrides

Supported in ft-session-replay version 0.1.1-alpha01 and above.

In addition to supporting global masking level configurations through FTSessionReplayConfig, the SDK also supports overriding these settings at the view level.

View-level privacy overrides:

  • Supports overriding text and input masking levels as well as touch masking levels.
  • Supports setting to completely hide specific views.

Note:

  • To ensure correct recognition of override settings, they should be applied as early as possible in the view lifecycle. This prevents Session Replay from processing views before the override settings are applied.
  • Privacy overrides affect the view and its subviews. This means that even if the override is applied to a view that may not take immediate effect (for example, applying an image override to text input), the override will still apply to all subviews.
  • Priority of privacy overrides: Subviews > Parent Views > Global Settings

Text and Input Overrides

To override text and input privacy, use PrivacyOverrideExtensions.setSessionReplayTextAndInputPrivacy(View,TextAndInputPrivacy) on the view instance and set it to one of the values in the TextAndInputPrivacy enumeration. If you need to remove existing override rules, simply set this property to null.

// Mark hidden element override for the specified view
PrivacyOverrideExtensions.setSessionReplayTextAndInputPrivacy(view, TextAndInputPrivacy.MASK_ALL);
// Remove the hidden element override setting for the view
PrivacyOverrideExtensions.setSessionReplayTextAndInputPrivacy(view, null);

// Mark hidden element override for the specified view
PrivacyOverrideExtensions.setSessionReplayTextAndInputPrivacy(view, TextAndInputPrivacy.MASK_ALL)
// Remove the hidden element override setting for the view
PrivacyOverrideExtensions.setSessionReplayTextAndInputPrivacy(view, null)

Touch Overrides

To override touch privacy, use PrivacyOverrideExtensions.setSessionReplayTouchPrivacy(View,TouchPrivacy) on the view instance and set it to one of the values in the TouchPrivacy enumeration. If you need to remove existing override rules, simply set this property to null.

// Mark hidden element override for the specified view
PrivacyOverrideExtensions.setSessionReplayTouchPrivacy(view, TouchPrivacy.HIDE);
// Remove the hidden element override setting for the view
PrivacyOverrideExtensions.setSessionReplayTouchPrivacy(view, null);

// Mark hidden element override for the specified view
PrivacyOverrideExtensions.setSessionReplayTouchPrivacy(view, TouchPrivacy.HIDE)
// Remove the hidden element override setting for the view
PrivacyOverrideExtensions.setSessionReplayTouchPrivacy(view, null)

Hidden Element Overrides

For sensitive elements that need to be completely hidden, use PrivacyOverrideExtensions.setSessionReplayHidden(View,Boolean) for setting.

When an element is marked as hidden, it will be replaced with a "Hidden" placeholder during replay, and its subviews will not be recorded.

Note: Marking a view as hidden will not prevent touch interactions from being recorded on that element. To hide touch interactions, in addition to marking the element as hidden, use touch overrides.

// Mark hidden element override for the specified view
PrivacyOverrideExtensions.setSessionReplayHidden(view, true)
// Remove the hidden element override setting for the view
PrivacyOverrideExtensions.setSessionReplayHidden(view, false)

// Mark hidden element override for the specified view
PrivacyOverrideExtensions.setSessionReplayHidden(view, true)
// Remove the hidden element override setting for the view
PrivacyOverrideExtensions.setSessionReplayHidden(view, false)