-
public interface HeatmapIdentifierRegistryStores and retrieves HeatmapIdentifiers keyed by composite view identity key (see heatmapViewKey).
Implementations must be thread-safe: the write side (Session Replay) may call setHeatmapIdentifiers from a background traversal thread while the read side (RUM) calls getHeatmapIdentifier from the main thread.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classHeatmapIdentifierRegistry.Companion
-
Method Summary
Modifier and Type Method Description abstract UnitsetHeatmapIdentifiers(Map<Long, HeatmapIdentifier> identifiers, String screenName)Replaces the current snapshot with identifiers, scoped to screenName. abstract HeatmapIdentifiergetHeatmapIdentifier(Long heatmapViewKey, String currentScreenName)Returns the HeatmapIdentifier for the view with the given heatmapViewKey, or null if the view is unknown or if currentScreenName does not match the screen that produced the current snapshot (indicating the snapshot is stale). -
-
Method Detail
-
setHeatmapIdentifiers
abstract Unit setHeatmapIdentifiers(Map<Long, HeatmapIdentifier> identifiers, String screenName)
Replaces the current snapshot with identifiers, scoped to screenName.
- Parameters:
identifiers- a map of view identity keys (see heatmapViewKey) to their HeatmapIdentifiers.screenName- the RUM view URL active when the snapshot was computed.
-
getHeatmapIdentifier
abstract HeatmapIdentifier getHeatmapIdentifier(Long heatmapViewKey, String currentScreenName)
Returns the HeatmapIdentifier for the view with the given heatmapViewKey, or null if the view is unknown or if currentScreenName does not match the screen that produced the current snapshot (indicating the snapshot is stale).
- Parameters:
heatmapViewKey- the composite identity key of the tapped view, as returned by heatmapViewKey.currentScreenName- the RUM view URL active at the time of the tap.
-
-
-
-