Document the nuances in UserId and SessionId types. (#1616)

2023-10-20 14:25:20 +02:00
parent ee60744530
commit 7e8f78c05d
2 changed files with 8 additions and 0 deletions
--- a/libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/core/SessionId.kt
+++ b/libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/core/SessionId.kt
@@ -16,4 +16,7 @@

 package io.element.android.libraries.matrix.api.core

+/**
+ * The [UserId] of the currently logged in user.
+ */
 typealias SessionId = UserId
--- a/libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/core/UserId.kt
+++ b/libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/core/UserId.kt
@@ -19,6 +19,11 @@ package io.element.android.libraries.matrix.api.core
 import io.element.android.libraries.matrix.api.BuildConfig
 import java.io.Serializable

+/**
+ * A [String] holding a valid Matrix user ID.
+ *
+ * https://spec.matrix.org/v1.8/appendices/#user-identifiers
+ */
@JvmInline
 value class UserId(val value: String) : Serializable {