Class MPSessionReplayConfig
-
- All Implemented Interfaces:
@Serializable() public final class MPSessionReplayConfigConfiguration options for Mixpanel Session Replay.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classMPSessionReplayConfig.Companion
-
Field Summary
Fields Modifier and Type Field Description private BooleanwifiOnlyprivate LongflushIntervalprivate BooleanautoStartRecordingprivate DoublerecordingSessionsPercentprivate Set<AutoMaskedView>autoMaskedViewsprivate BooleanenableLoggingprivate RemoteSettingsModeremoteSettingsModeprivate DebugOptionsdebugOptionsprivate StringserverUrlpublic final static MPSessionReplayConfig.CompanionCompanion
-
Constructor Summary
Constructors Constructor Description MPSessionReplayConfig(Boolean wifiOnly, Long flushInterval, Boolean autoStartRecording, Double recordingSessionsPercent, Set<AutoMaskedView> autoMaskedViews, Boolean enableLogging, RemoteSettingsMode remoteSettingsMode, DebugOptions debugOptions, String serverUrl)
-
Method Summary
Modifier and Type Method Description final BooleangetWifiOnly()If true, session replays will only be flushed when connected to Wi-Fi. final UnitsetWifiOnly(Boolean wifiOnly)If true, session replays will only be flushed when connected to Wi-Fi. final LonggetFlushInterval()Interval in seconds at which session replay events are flushed to the server. final UnitsetFlushInterval(Long flushInterval)Interval in seconds at which session replay events are flushed to the server. final BooleangetAutoStartRecording()Deprecated. final UnitsetAutoStartRecording(@Deprecated(message = "Use recordingSessionsPercent instead. Set to 0 to disable auto-start recording. Any value > 0 and <= 100 enables it.") Boolean autoStartRecording)Deprecated. final DoublegetRecordingSessionsPercent()Sampling rate for recording sessions (0.0 to 100.0). final UnitsetRecordingSessionsPercent(Double recordingSessionsPercent)Sampling rate for recording sessions (0.0 to 100.0). final Set<AutoMaskedView>getAutoMaskedViews()Set of view types to automatically mask during recording. final UnitsetAutoMaskedViews(Set<AutoMaskedView> autoMaskedViews)Set of view types to automatically mask during recording. final BooleangetEnableLogging()If true, enables debug logging for session replay. final UnitsetEnableLogging(Boolean enableLogging)If true, enables debug logging for session replay. final RemoteSettingsModegetRemoteSettingsMode()Controls how remote SDK config settings are fetched and applied. final UnitsetRemoteSettingsMode(RemoteSettingsMode remoteSettingsMode)Controls how remote SDK config settings are fetched and applied. final DebugOptionsgetDebugOptions()Debug feature configuration. final UnitsetDebugOptions(DebugOptions debugOptions)Debug feature configuration. final StringgetServerUrl()The server URL for your Mixpanel data residency. final UnitsetServerUrl(String serverUrl)The server URL for your Mixpanel data residency. final StringtoJson()-
-
Constructor Detail
-
MPSessionReplayConfig
MPSessionReplayConfig(Boolean wifiOnly, Long flushInterval, Boolean autoStartRecording, Double recordingSessionsPercent, Set<AutoMaskedView> autoMaskedViews, Boolean enableLogging, RemoteSettingsMode remoteSettingsMode, DebugOptions debugOptions, String serverUrl)
-
-
Method Detail
-
getWifiOnly
final Boolean getWifiOnly()
If true, session replays will only be flushed when connected to Wi-Fi. Default:
true.
-
setWifiOnly
final Unit setWifiOnly(Boolean wifiOnly)
If true, session replays will only be flushed when connected to Wi-Fi. Default:
true.
-
getFlushInterval
final Long getFlushInterval()
Interval in seconds at which session replay events are flushed to the server.
-
setFlushInterval
final Unit setFlushInterval(Long flushInterval)
Interval in seconds at which session replay events are flushed to the server.
-
getAutoStartRecording
final Boolean getAutoStartRecording()
Deprecated. Use recordingSessionsPercent instead. This property will be removed in a future release. Default:
true.
-
setAutoStartRecording
final Unit setAutoStartRecording(@Deprecated(message = "Use recordingSessionsPercent instead. Set to 0 to disable auto-start recording. Any value > 0 and <= 100 enables it.") Boolean autoStartRecording)
Deprecated. Use recordingSessionsPercent instead. This property will be removed in a future release. Default:
true.
-
getRecordingSessionsPercent
final Double getRecordingSessionsPercent()
Sampling rate for recording sessions (0.0 to 100.0). Default:
100.0.
-
setRecordingSessionsPercent
final Unit setRecordingSessionsPercent(Double recordingSessionsPercent)
Sampling rate for recording sessions (0.0 to 100.0). Default:
100.0.
-
getAutoMaskedViews
final Set<AutoMaskedView> getAutoMaskedViews()
Set of view types to automatically mask during recording.
-
setAutoMaskedViews
final Unit setAutoMaskedViews(Set<AutoMaskedView> autoMaskedViews)
Set of view types to automatically mask during recording.
-
getEnableLogging
final Boolean getEnableLogging()
If true, enables debug logging for session replay. Default:
false.
-
setEnableLogging
final Unit setEnableLogging(Boolean enableLogging)
If true, enables debug logging for session replay. Default:
false.
-
getRemoteSettingsMode
final RemoteSettingsMode getRemoteSettingsMode()
Controls how remote SDK config settings are fetched and applied. Default:
DISABLED.
-
setRemoteSettingsMode
final Unit setRemoteSettingsMode(RemoteSettingsMode remoteSettingsMode)
Controls how remote SDK config settings are fetched and applied. Default:
DISABLED.
-
getDebugOptions
final DebugOptions getDebugOptions()
Debug feature configuration. When not null, debug features are enabled. Only works in debuggable builds.
-
setDebugOptions
final Unit setDebugOptions(DebugOptions debugOptions)
Debug feature configuration. When not null, debug features are enabled. Only works in debuggable builds.
-
getServerUrl
final String getServerUrl()
The server URL for your Mixpanel data residency. Use constants from DataResidency: DataResidency.US, DataResidency.EU, or DataResidency.IN. Defaults to US.
-
setServerUrl
final Unit setServerUrl(String serverUrl)
The server URL for your Mixpanel data residency. Use constants from DataResidency: DataResidency.US, DataResidency.EU, or DataResidency.IN. Defaults to US.
-
-
-
-