Merge pull request #1073 from vector-im/feature/improve_api

Improve api of CreateRoomParams

.idea/codeStyles/Project.xml

@@ -1,9 +1,6 @@
 <component name="ProjectCodeStyleConfiguration">
   <code_scheme name="Project" version="173">
     <option name="RIGHT_MARGIN" value="160" />
-    <AndroidXmlCodeStyleSettings>
-      <option name="ARRANGEMENT_SETTINGS_MIGRATED_TO_191" value="true" />
-    </AndroidXmlCodeStyleSettings>
     <JetCodeStyleSettings>
       <option name="PACKAGES_TO_USE_STAR_IMPORTS">
         <value>

CHANGES.md

@@ -21,6 +21,7 @@ Bugfix 🐛:
  - Leaving a room creates a stuck "leaving room" loading screen. (#1041)
  - Fix some invitation handling issues (#1013)
  - New direct chat: selecting a participant sometimes results in two breadcrumbs (#1022)
+ - New direct chat: selecting several participants was not adding the room to the direct chats list
 
 Translations 🗣:
  -
@@ -28,6 +29,7 @@ Translations 🗣:
 SDK API changes ⚠️:
  - Get crypto methods through Session.cryptoService()
  - ProgressListener.onProgress() function will be invoked on the background thread instead of UI thread
+ - Improve CreateRoomParams API (#1070)
 
 Build 🧱:
  -

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/create/CreateRoomParams.kt

@@ -17,6 +17,7 @@
 package im.vector.matrix.android.api.session.room.model.create
 
 import android.util.Patterns
+import androidx.annotation.CheckResult
 import com.squareup.moshi.Json
 import com.squareup.moshi.JsonClass
 import im.vector.matrix.android.api.MatrixPatterns.isUserId
@@ -120,26 +121,37 @@ data class CreateRoomParams(
         @Json(name = "power_level_content_override")
         val powerLevelContentOverride: PowerLevelsContent? = null
 ) {
-    /**
-     * Set to true means that if cross-signing is enabled and we can get keys for every invited users,
-     * the encryption will be enabled on the created room
-     */
     @Transient
     internal var enableEncryptionIfInvitedUsersSupportIt: Boolean = false
         private set
 
-    fun enableEncryptionIfInvitedUsersSupportIt(): CreateRoomParams {
-        enableEncryptionIfInvitedUsersSupportIt = true
+    /**
+     * After calling this method, when the room will be created, if cross-signing is enabled and we can get keys for every invited users,
+     * the encryption will be enabled on the created room
+     * @param value true to activate this behavior.
+     * @return this, to allow chaining methods
+     */
+    fun enableEncryptionIfInvitedUsersSupportIt(value: Boolean = true): CreateRoomParams {
+        enableEncryptionIfInvitedUsersSupportIt = value
         return this
     }
 
     /**
      * Add the crypto algorithm to the room creation parameters.
      *
-     * @param algorithm the algorithm
+     * @param enable true to enable encryption.
+     * @param algorithm the algorithm, default to [MXCRYPTO_ALGORITHM_MEGOLM], which is actually the only supported algorithm for the moment
+     * @return a modified copy of the CreateRoomParams object, or this if there is no modification
      */
-    fun enableEncryptionWithAlgorithm(algorithm: String = MXCRYPTO_ALGORITHM_MEGOLM): CreateRoomParams {
+    @CheckResult
+    fun enableEncryptionWithAlgorithm(enable: Boolean = true,
+                                      algorithm: String = MXCRYPTO_ALGORITHM_MEGOLM): CreateRoomParams {
+        // Remove the existing value if any.
+        val newInitialStates = initialStates
+                ?.filter { it.type != EventType.STATE_ROOM_ENCRYPTION }
+
         return if (algorithm == MXCRYPTO_ALGORITHM_MEGOLM) {
+            if (enable) {
                 val contentMap = mapOf("algorithm" to algorithm)
 
                 val algoEvent = Event(
@@ -149,8 +161,13 @@ data class CreateRoomParams(
                 )
 
                 copy(
-                    initialStates = initialStates.orEmpty().filter { it.type != EventType.STATE_ROOM_ENCRYPTION } + algoEvent
+                        initialStates = newInitialStates.orEmpty() + algoEvent
                 )
+            } else {
+                return copy(
+                        initialStates = newInitialStates
+                )
+            }
         } else {
             Timber.e("Unsupported algorithm: $algorithm")
             this
@@ -161,7 +178,9 @@ data class CreateRoomParams(
      * Force the history visibility in the room creation parameters.
      *
      * @param historyVisibility the expected history visibility, set null to remove any existing value.
+     * @return a modified copy of the CreateRoomParams object
      */
+    @CheckResult
     fun setHistoryVisibility(historyVisibility: RoomHistoryVisibility?): CreateRoomParams {
         // Remove the existing value if any.
         val newInitialStates = initialStates
@@ -187,7 +206,9 @@ data class CreateRoomParams(
 
     /**
      * Mark as a direct message room.
+     * @return a modified copy of the CreateRoomParams object
      */
+    @CheckResult
     fun setDirectMessage(): CreateRoomParams {
         return copy(
                 preset = CreateRoomPreset.PRESET_TRUSTED_PRIVATE_CHAT,
@@ -195,20 +216,6 @@ data class CreateRoomParams(
         )
     }
 
-    /**
-     * @return the invite count
-     */
-    private fun getInviteCount(): Int {
-        return invitedUserIds?.size ?: 0
-    }
-
-    /**
-     * @return the pid invite count
-     */
-    private fun getInvite3PidCount(): Int {
-        return invite3pids?.size ?: 0
-    }
-
     /**
      * Tells if the created room can be a direct chat one.
      *
@@ -217,7 +224,6 @@ data class CreateRoomParams(
     fun isDirect(): Boolean {
         return preset == CreateRoomPreset.PRESET_TRUSTED_PRIVATE_CHAT
                 && isDirect == true
-                && (1 == getInviteCount() || 1 == getInvite3PidCount())
     }
 
     /**
@@ -232,7 +238,9 @@ data class CreateRoomParams(
      * ids might be a matrix id or an email address.
      *
      * @param ids the participant ids to add.
+     * @return a modified copy of the CreateRoomParams object
      */
+    @CheckResult
     fun addParticipantIds(hsConfig: HomeServerConnectionConfig,
                           userId: String,
                           ids: List<String>): CreateRoomParams {

vector/src/main/java/im/vector/riotx/features/roomdirectory/createroom/CreateRoomViewModel.kt

@@ -30,7 +30,6 @@ import im.vector.matrix.android.api.session.Session
 import im.vector.matrix.android.api.session.room.model.RoomDirectoryVisibility
 import im.vector.matrix.android.api.session.room.model.create.CreateRoomParams
 import im.vector.matrix.android.api.session.room.model.create.CreateRoomPreset
-import im.vector.matrix.android.internal.crypto.MXCRYPTO_ALGORITHM_MEGOLM
 import im.vector.riotx.core.platform.EmptyViewEvents
 import im.vector.riotx.core.platform.VectorViewModel
 import im.vector.riotx.features.roomdirectory.RoomDirectoryActivity
@@ -91,10 +90,9 @@ class CreateRoomViewModel @AssistedInject constructor(@Assisted initialState: Cr
                 visibility = if (state.isInRoomDirectory) RoomDirectoryVisibility.PUBLIC else RoomDirectoryVisibility.PRIVATE,
                 // Public room
                 preset = if (state.isPublic) CreateRoomPreset.PRESET_PUBLIC_CHAT else CreateRoomPreset.PRESET_PRIVATE_CHAT
-        ).let {
+        )
                 // Encryption
-            if (state.isEncrypted) it.enableEncryptionWithAlgorithm(MXCRYPTO_ALGORITHM_MEGOLM) else it
-        }
+                .enableEncryptionWithAlgorithm(state.isEncrypted)
 
         session.createRoom(createRoomParams, object : MatrixCallback<String> {
             override fun onSuccess(data: String) {