Add experimental annotation for Session Replay and Add it for Compose

DataDog · Nov 6, 2024 · 2f03af4 · 2f03af4
1 parent cd1b01e
commit 2f03af4
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 0 deletions.
diff --git a/features/dd-sdk-android-session-replay-compose/api/apiSurface b/features/dd-sdk-android-session-replay-compose/api/apiSurface
@@ -2,3 +2,4 @@ class com.datadog.android.sessionreplay.compose.ComposeExtensionSupport : com.da
   override fun getCustomViewMappers(): List<com.datadog.android.sessionreplay.MapperTypeWrapper<*>>
   override fun getOptionSelectorDetectors(): List<com.datadog.android.sessionreplay.recorder.OptionSelectorDetector>
   override fun getCustomDrawableMapper(): List<com.datadog.android.sessionreplay.utils.DrawableToColorMapper>
+annotation com.datadog.android.sessionreplay.compose.ExperimentalSessionReplayApi
diff --git a/features/dd-sdk-android-session-replay-compose/api/dd-sdk-android-session-replay-compose.api b/features/dd-sdk-android-session-replay-compose/api/dd-sdk-android-session-replay-compose.api
@@ -6,3 +6,6 @@ public final class com/datadog/android/sessionreplay/compose/ComposeExtensionSup
 	public fun getOptionSelectorDetectors ()Ljava/util/List;
 }
 
+public abstract interface annotation class com/datadog/android/sessionreplay/compose/ExperimentalSessionReplayApi : java/lang/annotation/Annotation {
+}
+
diff --git a/...pose/src/main/kotlin/com/datadog/android/sessionreplay/compose/ComposeExtensionSupport.kt b/...pose/src/main/kotlin/com/datadog/android/sessionreplay/compose/ComposeExtensionSupport.kt
@@ -23,6 +23,7 @@ import com.datadog.android.sessionreplay.utils.ViewIdentifierResolver
  * Jetpack Compose extension support implementation to be used in the Session Replay
  * configuration.
  */
+@ExperimentalSessionReplayApi
 class ComposeExtensionSupport : ExtensionSupport {
 
     private val viewIdentifierResolver: ViewIdentifierResolver = DefaultViewIdentifierResolver

diff --git a/...src/main/kotlin/com/datadog/android/sessionreplay/compose/ExperimentalSessionReplayApi.kt b/...src/main/kotlin/com/datadog/android/sessionreplay/compose/ExperimentalSessionReplayApi.kt
@@ -0,0 +1,17 @@
+/*
+ * Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0.
+ * This product includes software developed at Datadog (https://www.datadoghq.com/).
+ * Copyright 2016-Present Datadog, Inc.
+ */
+
+package com.datadog.android.sessionreplay.compose
+
+/**
+ * Marker for the experimental Session Replay API.
+ */
+@RequiresOptIn(
+    message = "This is an experimental Session Replay API. It may change in the future.",
+    level = RequiresOptIn.Level.WARNING
+)
+@Retention(AnnotationRetention.BINARY)
+annotation class ExperimentalSessionReplayApi