Poll Feature - Timeline

changelog.d/4653.feature

@@ -0,0 +1 @@
+Poll Feature - Render in timeline

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

@@ -104,6 +104,8 @@ object EventType {
 
     // Poll
     const val POLL_START = "org.matrix.msc3381.poll.start"
+    const val POLL_RESPONSE = "org.matrix.msc3381.poll.response"
+    const val POLL_END = "org.matrix.msc3381.poll.end"
 
     // Unwedging
     internal const val DUMMY = "m.dummy"

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

@@ -24,25 +24,24 @@ import com.squareup.moshi.JsonClass
  */
 @JsonClass(generateAdapter = true)
 data class PollSummaryContent(
-        // Index of my vote
-        var myVote: Int? = null,
+        var myVote: String? = null,
         // Array of VoteInfo, list is constructed so that there is only one vote by user
         // And that optionIndex is valid
-        var votes: List<VoteInfo>? = null
-) {
-
-    fun voteCount(): Int {
-        return votes?.size ?: 0
-    }
+        var votes: List<VoteInfo>? = null,
+        var votesSummary: Map<String, VoteSummary>? = null,
+        var totalVotes: Int = 0,
+        var winnerVoteCount: Int = 0
+)
 
-    fun voteCountForOption(optionIndex: Int): Int {
-        return votes?.filter { it.optionIndex == optionIndex }?.count() ?: 0
-    }
-}
+@JsonClass(generateAdapter = true)
+data class VoteSummary(
+        val total: Int = 0,
+        val percentage: Double = 0.0
+)
 
 @JsonClass(generateAdapter = true)
 data class VoteInfo(
         val userId: String,
-        val optionIndex: Int,
+        val option: String,
         val voteTimestamp: Long
 )

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/model/message/MessageEndPollContent.kt

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2021 The Matrix.org Foundation C.I.C.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.matrix.android.sdk.api.session.room.model.message
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+import org.matrix.android.sdk.api.session.room.model.relation.RelationDefaultContent
+
+/**
+ * Class representing the org.matrix.msc3381.poll.end event content
+ */
+@JsonClass(generateAdapter = true)
+data class MessageEndPollContent(
+        @Json(name = "m.relates_to") val relatesTo: RelationDefaultContent? = null
+)

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/model/message/MessagePollContent.kt

@@ -18,8 +18,18 @@ package org.matrix.android.sdk.api.session.room.model.message
 
 import com.squareup.moshi.Json
 import com.squareup.moshi.JsonClass
+import org.matrix.android.sdk.api.session.events.model.Content
+import org.matrix.android.sdk.api.session.room.model.relation.RelationDefaultContent
 
 @JsonClass(generateAdapter = true)
 data class MessagePollContent(
-    @Json(name = "org.matrix.msc3381.poll.start") val pollCreationInfo: PollCreationInfo? = null
-)
+        /**
+         * Local message type, not from server
+         */
+        @Transient
+        override val msgType: String = MessageType.MSGTYPE_POLL_START,
+        @Json(name = "body") override val body: String = "",
+        @Json(name = "m.relates_to") override val relatesTo: RelationDefaultContent? = null,
+        @Json(name = "m.new_content") override val newContent: Content? = null,
+        @Json(name = "org.matrix.msc3381.poll.start") val pollCreationInfo: PollCreationInfo? = null
+) : MessageContent

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/model/message/MessagePollResponseContent.kt

@@ -21,13 +21,15 @@ import com.squareup.moshi.JsonClass
 import org.matrix.android.sdk.api.session.events.model.Content
 import org.matrix.android.sdk.api.session.room.model.relation.RelationDefaultContent
 
-/**
- * Ref: https://github.com/matrix-org/matrix-doc/pull/2192
- */
 @JsonClass(generateAdapter = true)
 data class MessagePollResponseContent(
-        @Json(name = MessageContent.MSG_TYPE_JSON_KEY) override val msgType: String = MessageType.MSGTYPE_RESPONSE,
-        @Json(name = "body") override val body: String,
+        /**
+         * Local message type, not from server
+         */
+        @Transient
+        override val msgType: String = MessageType.MSGTYPE_POLL_RESPONSE,
+        @Json(name = "body") override val body: String = "",
         @Json(name = "m.relates_to") override val relatesTo: RelationDefaultContent? = null,
-        @Json(name = "m.new_content") override val newContent: Content? = null
+        @Json(name = "m.new_content") override val newContent: Content? = null,
+        @Json(name = "org.matrix.msc3381.poll.response") val response: PollResponse? = null
 ) : MessageContent

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/model/message/MessageType.kt

@@ -25,15 +25,18 @@ object MessageType {
     const val MSGTYPE_VIDEO = "m.video"
     const val MSGTYPE_LOCATION = "m.location"
     const val MSGTYPE_FILE = "m.file"
-    const val MSGTYPE_OPTIONS = "org.matrix.options"
-    const val MSGTYPE_RESPONSE = "org.matrix.response"
-    const val MSGTYPE_POLL_CLOSED = "org.matrix.poll_closed"
+
     const val MSGTYPE_VERIFICATION_REQUEST = "m.key.verification.request"
 
     // Add, in local, a fake message type in order to StickerMessage can inherit Message class
     // Because sticker isn't a message type but a event type without msgtype field
     const val MSGTYPE_STICKER_LOCAL = "org.matrix.android.sdk.sticker"
 
+    // Fake message types for poll events to be able to inherit them from MessageContent
+    // Because poll events are not message events and they don't hanve msgtype field
+    const val MSGTYPE_POLL_START = "org.matrix.android.sdk.poll.start"
+    const val MSGTYPE_POLL_RESPONSE = "org.matrix.android.sdk.poll.response"
+
     const val MSGTYPE_CONFETTI = "nic.custom.confetti"
     const val MSGTYPE_SNOWFALL = "io.element.effect.snowfall"
 }

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/model/message/OptionItem.kt → matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/model/message/PollResponse.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020 The Matrix.org Foundation C.I.C.
+ * Copyright 2021 The Matrix.org Foundation C.I.C.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,11 +19,7 @@ package org.matrix.android.sdk.api.session.room.model.message
 import com.squareup.moshi.Json
 import com.squareup.moshi.JsonClass
 
-/**
- * Ref: https://github.com/matrix-org/matrix-doc/pull/2192
- */
 @JsonClass(generateAdapter = true)
-data class OptionItem(
-        @Json(name = "label") val label: String?,
-        @Json(name = "value") val value: String?
+data class PollResponse(
+        @Json(name = "answers") val answers: List<String>? = null
 )

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/send/SendService.kt

@@ -91,11 +91,17 @@ interface SendService {
     /**
      * Method to send a poll response.
      * @param pollEventId the poll currently replied to
-     * @param optionIndex The reply index
-     * @param optionValue The option value (for compatibility)
+     * @param answerId The id of the answer
      * @return a [Cancelable]
      */
-    fun sendOptionsReply(pollEventId: String, optionIndex: Int, optionValue: String): Cancelable
+    fun voteToPoll(pollEventId: String, answerId: String): Cancelable
+
+    /**
+     * End a poll in the room.
+     * @param pollEventId event id of the poll
+     * @return a [Cancelable]
+     */
+    fun endPoll(pollEventId: String): Cancelable
 
     /**
      * Redact (delete) the given event.

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/summary/RoomSummaryConstants.kt

@@ -32,6 +32,7 @@ object RoomSummaryConstants {
             EventType.CALL_ANSWER,
             EventType.ENCRYPTED,
             EventType.STICKER,
-            EventType.REACTION
+            EventType.REACTION,
+            EventType.POLL_START
     )
 }

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

@@ -27,6 +27,7 @@ import org.matrix.android.sdk.api.session.events.model.toModel
 import org.matrix.android.sdk.api.session.room.model.EventAnnotationsSummary
 import org.matrix.android.sdk.api.session.room.model.ReadReceipt
 import org.matrix.android.sdk.api.session.room.model.message.MessageContent
+import org.matrix.android.sdk.api.session.room.model.message.MessagePollContent
 import org.matrix.android.sdk.api.session.room.model.message.MessageStickerContent
 import org.matrix.android.sdk.api.session.room.model.message.MessageTextContent
 import org.matrix.android.sdk.api.session.room.model.relation.RelationDefaultContent
@@ -126,10 +127,10 @@ fun TimelineEvent.getEditedEventId(): String? {
  * Get last MessageContent, after a possible edition
  */
 fun TimelineEvent.getLastMessageContent(): MessageContent? {
-    return if (root.getClearType() == EventType.STICKER) {
-        root.getClearContent().toModel<MessageStickerContent>()
-    } else {
-        (annotations?.editSummary?.latestContent ?: root.getClearContent()).toModel()
+    return when (root.getClearType()) {
+        EventType.STICKER    -> root.getClearContent().toModel<MessageStickerContent>()
+        EventType.POLL_START -> root.getClearContent().toModel<MessagePollContent>()
+        else                 -> (annotations?.editSummary?.latestContent ?: root.getClearContent()).toModel()
     }
 }
 

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/di/MoshiProvider.kt

@@ -25,7 +25,6 @@ import org.matrix.android.sdk.api.session.room.model.message.MessageFileContent
 import org.matrix.android.sdk.api.session.room.model.message.MessageImageContent
 import org.matrix.android.sdk.api.session.room.model.message.MessageLocationContent
 import org.matrix.android.sdk.api.session.room.model.message.MessageNoticeContent
-import org.matrix.android.sdk.api.session.room.model.message.MessageOptionsContent
 import org.matrix.android.sdk.api.session.room.model.message.MessagePollResponseContent
 import org.matrix.android.sdk.api.session.room.model.message.MessageTextContent
 import org.matrix.android.sdk.api.session.room.model.message.MessageType
@@ -57,8 +56,7 @@ object MoshiProvider {
                     .registerSubtype(MessageLocationContent::class.java, MessageType.MSGTYPE_LOCATION)
                     .registerSubtype(MessageFileContent::class.java, MessageType.MSGTYPE_FILE)
                     .registerSubtype(MessageVerificationRequestContent::class.java, MessageType.MSGTYPE_VERIFICATION_REQUEST)
-                    .registerSubtype(MessageOptionsContent::class.java, MessageType.MSGTYPE_OPTIONS)
-                    .registerSubtype(MessagePollResponseContent::class.java, MessageType.MSGTYPE_RESPONSE)
+                    .registerSubtype(MessagePollResponseContent::class.java, MessageType.MSGTYPE_POLL_RESPONSE)
             )
             .add(SerializeNulls.JSON_ADAPTER_FACTORY)
             .build()

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/notification/ProcessEventForPushTask.kt

@@ -56,6 +56,7 @@ internal class DefaultProcessEventForPushTask @Inject constructor(
 
         val allEvents = (newJoinEvents + inviteEvents).filter { event ->
             when (event.type) {
+                EventType.POLL_START,
                 EventType.MESSAGE,
                 EventType.REDACTION,
                 EventType.ENCRYPTED,