docs: agent options for experimental features

hyperledger · Apr 29, 2024 · fb38cfd · fb38cfd
1 parent 0802fb7
commit fb38cfd
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/...m-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/ConnectionManager.kt b/...m-sdk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/ConnectionManager.kt
@@ -38,7 +38,7 @@ import kotlin.jvm.Throws
  * @property experimentLiveModeOptIn Flag to opt in or out of the experimental feature mediator live mode, using websockets.
  * @property pairings The mutable list of DIDPair representing the connections managed by the ConnectionManager.
  */
-class ConnectionManager(
+class ConnectionManager @JvmOverloads constructor(
     private val mercury: Mercury,
     private val castor: Castor,
     private val pluto: Pluto,

diff --git a/...dk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/helpers/AgentOptions.kt b/...dk/src/commonMain/kotlin/io/iohk/atala/prism/walletsdk/prismagent/helpers/AgentOptions.kt
@@ -1,5 +1,13 @@
 package io.iohk.atala.prism.walletsdk.prismagent.helpers
 
+/**
+ * Class that represent agent options that the SDK user can define to modify some behaviors of the SDK.
+ * @param experiments Represents the experimental features available
+ */
 data class AgentOptions(val experiments: Experiments = Experiments())
 
+/**
+ * Class to define experimental features available within the SDK.
+ * @param liveMode Flag to enable or disable the live mode to listen for messages from the mediator.
+ */
 data class Experiments(val liveMode: Boolean = false)