Constructor Detail

• SessionReplayConfiguration.Builder

  SessionReplayConfiguration.Builder()

  Calling this constructor will default to a 100% session sampling rate.

• SessionReplayConfiguration.Builder

  SessionReplayConfiguration.Builder(Float sampleRate)

  Parameters:

  sampleRate - must be a value between 0 and 100.

Method Detail

• addExtensionSupport

   final SessionReplayConfiguration.Builder addExtensionSupport(ExtensionSupport extensionSupport)

  Adds an extension support implementation. This is mostly used when you want to provide different behaviour of the Session Replay when using other Android UI frameworks than the default ones.

• useCustomEndpoint

   final SessionReplayConfiguration.Builder useCustomEndpoint(String endpoint)

  Let the Session Replay target a custom server.

• setPrivacy

  @Deprecated(message = This method is deprecated and will be removed in future versions. Use the new fine grained masking apis instead: [setImagePrivacy], [setTouchPrivacy], [setTextAndInputPrivacy].) final SessionReplayConfiguration.Builder setPrivacy(SessionReplayPrivacy privacy)

  Sets the privacy rule for the Session Replay feature. If not specified all the elements will be masked by default (MASK).

• setImagePrivacy

   final SessionReplayConfiguration.Builder setImagePrivacy(ImagePrivacy level)

  Sets the image recording level for the Session Replay feature. If not specified then all images that are considered to be content images will be masked by default.

• setTouchPrivacy

   final SessionReplayConfiguration.Builder setTouchPrivacy(TouchPrivacy level)

  Sets the touch recording level for the Session Replay feature. If not specified then all touches will be hidden by default.

• startRecordingImmediately

   final SessionReplayConfiguration.Builder startRecordingImmediately(Boolean enabled)

  Should recording start automatically (or be manually started). If not specified then by default it starts automatically.

  Parameters:

  enabled - whether recording should start automatically or not.

• setTextAndInputPrivacy

   final SessionReplayConfiguration.Builder setTextAndInputPrivacy(TextAndInputPrivacy level)

  Sets the text and input recording level for the Session Replay feature. If not specified then sensitive text will be masked by default.

• setDynamicOptimizationEnabled

   final SessionReplayConfiguration.Builder setDynamicOptimizationEnabled(Boolean dynamicOptimizationEnabled)

  This option controls whether optimization is enabled or disabled for recording Session Replay data. By default the value is true, meaning the dynamic optimization is enabled.

• setSystemRequirements

   final SessionReplayConfiguration.Builder setSystemRequirements(SystemRequirementsConfiguration systemRequirementsConfiguration)

  Defines the minimum system requirements for enabling the Session Replay feature. When SessionReplay.enable is invoked, the system configuration is verified against these requirements. If the system meets the specified criteria, Session Replay will be successfully enabled. If this function is not invoked, no minimum requirements will be enforced, and Session Replay will be enabled on all devices.

• build

   final SessionReplayConfiguration build()

  Builds a SessionReplayConfiguration based on the current state of this Builder.