edits after first review on Github

Author: cintek

changelog.d/7762.feature

@@ -1 +1 @@
-Added lab feature to pin/unpin messages
+Added lab feature to pin/unpin messages

gradle.properties

@@ -8,7 +8,7 @@
 # The setting is particularly useful for tweaking memory settings.
 
 # Build Time Optimizations
-org.gradle.jvmargs=-Xmx4g -Xms512M -XX:MaxPermSize=2048m -XX:MaxMetaspaceSize=1g -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=UTF-8 -XX:+UseParallelGC
+org.gradle.jvmargs=-Xmx4g -Xms512M -XX:MaxMetaspaceSize=1g -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=UTF-8 -XX:+UseParallelGC
 org.gradle.configureondemand=true
 org.gradle.parallel=true
 org.gradle.vfs.watch=true

library/ui-strings/src/main/res/values/strings.xml

@@ -77,6 +77,10 @@
     <string name="notice_room_server_acl_set_allowed">• Servers matching %s are allowed.</string>
     <string name="notice_room_server_acl_set_ip_literals_allowed">• Servers matching IP literals are allowed.</string>
     <string name="notice_room_server_acl_set_ip_literals_not_allowed">• Servers matching IP literals are banned.</string>
+    <string name="notice_user_pinned_event">%1$s pinned a message.</string>
+    <string name="notice_user_unpinned_event">%1$s unpinned a message.</string>
+    <string name="notice_user_pinned_event_by_you">You pinned a message.</string>
+    <string name="notice_user_unpinned_event_by_you">You unpinned a message.</string>
 
     <string name="notice_room_server_acl_updated_title">%s changed the server ACLs for this room.</string>
     <string name="notice_room_server_acl_updated_title_by_you">You changed the server ACLs for this room.</string>
@@ -373,7 +377,7 @@
     <string name="action_sign_out_confirmation_simple">Are you sure you want to sign out?</string>
     <string name="action_voice_call">Voice Call</string>
     <string name="action_video_call">Video Call</string>
-    <string name="action_open_pinned_messages">Open Pinned Messages</string>
+    <string name="action_open_pinned_events">Open Pinned Messages</string>
     <string name="action_view_threads">View Threads</string>
     <string name="action_mark_all_as_read">Mark all as read</string>
     <string name="action_quick_reply">Quick reply</string>
@@ -803,11 +807,9 @@
     <string name="threads_labs_enable_notice_message">Your homeserver does not currently support threads, so this feature may be unreliable. Some threaded messages may not be reliably available. %sDo you want to enable threads anyway?</string>
 
     <!-- Pinning -->
-    <string name="pinning_message">Pin</string>
-    <string name="unpinning_message">Unpin</string>
-    <string name="pinned_messages_timeline_title">Pinned Messages</string>
-    <string name="user_pinned_message">%1$s pinned a message.</string>
-    <string name="user_unpinned_message">%1$s unpinned a message.</string>
+    <string name="pinning_event">Pin</string>
+    <string name="unpinning_event">Unpin</string>
+    <string name="pinned_events_timeline_title">Pinned Messages</string>
 
     <!-- Search -->
     <string name="search_hint">Search</string>
@@ -3039,7 +3041,7 @@
 
     <string name="labs_auto_report_uisi">Auto Report Decryption Errors.</string>
     <string name="labs_auto_report_uisi_desc">Your system will automatically send logs when an unable to decrypt error occurs</string>
-    <string name="labs_enable_pinned_messages">Enable Pinned Messages</string>
+    <string name="labs_enable_pinned_events">Enable Pinned Messages</string>
     <string name="labs_enable_thread_messages">Enable Thread Messages</string>
     <string name="labs_enable_thread_messages_desc">Note: app will be restarted</string>
     <string name="settings_show_latest_profile">Show latest user info</string>

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/events/model/Event.kt

@@ -449,10 +449,10 @@ fun Event.supportsNotification() =
 fun Event.isContentReportable() =
         this.getClearType() in EventType.MESSAGE + EventType.STATE_ROOM_BEACON_INFO.values
 
-fun Event.getIdsOfPinnedEvents(): MutableList<String>? {
+fun Event.getIdsOfPinnedEvents(): List<String>? {
     return getClearContent()?.toModel<PinnedEventsStateContent>()?.eventIds
 }
 
-fun Event.getPreviousIdsOfPinnedEvents(): MutableList<String>? {
+fun Event.getPreviousIdsOfPinnedEvents(): List<String>? {
     return resolvedPrevContent()?.toModel<PinnedEventsStateContent>()?.eventIds
 }

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/model/pinnedmessages/PinnedEventsStateContent.kt

@@ -24,5 +24,5 @@ import com.squareup.moshi.JsonClass
  */
 @JsonClass(generateAdapter = true)
 data class PinnedEventsStateContent(
-        @Json(name = "pinned") val eventIds: MutableList<String>
+        @Json(name = "pinned") val eventIds: List<String>
 )

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/state/StateService.kt

@@ -67,9 +67,14 @@ interface StateService {
     suspend fun deleteAvatar()
 
     /**
-     * Pin a message of the room.
+     * Pin an event of the room.
      */
-    suspend fun pinMessage(eventIds: MutableList<String>)
+    suspend fun pinEvent(eventId: String)
+
+    /**
+     * Unpin an event of the room.
+     */
+    suspend fun unpinEvent(eventId: String)
 
     /**
      * Send a state event to the room.
@@ -108,16 +113,6 @@ interface StateService {
      */
     fun getStateEventsLive(eventTypes: Set<String>, stateKey: QueryStateEventValue): LiveData<List<Event>>
 
-    /**
-     * Get state event containing the IDs of pinned events of the room
-     */
-    fun getPinnedEventsState(): Event?
-
-    /**
-     * Tells if an event is a pinned message
-     */
-    fun isPinned(eventId: String): Boolean?
-
     suspend fun setJoinRulePublic()
     suspend fun setJoinRuleInviteOnly()
     suspend fun setJoinRuleRestricted(allowList: List<String>)

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/timeline/Timeline.kt

@@ -43,7 +43,7 @@ interface Timeline {
     /**
      * This must be called before any other method after creating the timeline. It ensures the underlying database is open
      */
-    fun start(rootThreadEventId: String? = null, rootPinnedMessageEventId: String? = null)
+    fun start(rootThreadEventId: String? = null, isFromPinnedEventsTimeline: Boolean = false)
 
     /**
      * This must be called when you don't need the timeline. It ensures the underlying database get closed.

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/timeline/TimelineSettings.kt

@@ -33,9 +33,9 @@ data class TimelineSettings(
          */
         val rootThreadEventId: String? = null,
         /**
-         * The root pinned message eventId if this is a pinned messages timeline, or null if this is NOT a pinned messages timeline.
+         * True if the timeline is a pinned messages timeline.
          */
-        val rootPinnedMessageEventId: String? = null,
+        val isFromPinnedEventsTimeline: Boolean = false,
         /**
          * If true Sender Info shown in room will get the latest data information (avatar + displayName).
          */
@@ -50,5 +50,5 @@ data class TimelineSettings(
     /**
      * Returns true if this is a pinned messages timeline or false otherwise.
      */
-    fun isPinnedMessagesTimeline() = rootPinnedMessageEventId != null
+    fun isPinnedEventsTimeline() = isFromPinnedEventsTimeline
 }

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/room/RoomAPI.kt

@@ -33,7 +33,6 @@ import org.matrix.android.sdk.internal.session.room.membership.RoomMembersRespon
 import org.matrix.android.sdk.internal.session.room.membership.admin.UserIdAndReason
 import org.matrix.android.sdk.internal.session.room.membership.joining.InviteBody
 import org.matrix.android.sdk.internal.session.room.membership.threepid.ThreePidInviteBody
-import org.matrix.android.sdk.internal.session.room.pinnedmessages.PinnedEventsStateResponse
 import org.matrix.android.sdk.internal.session.room.read.ReadBody
 import org.matrix.android.sdk.internal.session.room.relation.RelationsResponse
 import org.matrix.android.sdk.internal.session.room.reporting.ReportContentBody
@@ -249,7 +248,7 @@ internal interface RoomAPI {
                 @Path("roomId") roomId: String,
                 @Path("eventType") eventType: String,
                 @Path("state_key") stateKey: String
-    ): PinnedEventsStateResponse
+    ): Content
 
     /**
      * Paginate relations for event based in normal topological order.