Add first "batch" of state events.

- This includes new interfaces and extraction of some records for shared usage.

- This commit deprecates the sendStateEvent

- RoomMessageEvent has been moved

Author: hikingc

src/main/java/io/github/hikingc/matrixsdk/api/Event.java

@@ -1,6 +1,7 @@
 package io.github.hikingc.matrixsdk.api;
 
 import io.github.hikingc.matrixsdk.api.events.*;
+import io.github.hikingc.matrixsdk.api.events.messages.RoomMessageEvent;
 import io.github.hikingc.matrixsdk.api.identifiers.RoomID;
 import io.github.hikingc.matrixsdk.exceptions.MatrixIOException;
 import io.github.hikingc.matrixsdk.exceptions.MatrixNetworkException;
@@ -97,7 +98,7 @@ public interface Event {
     /// **This cannot be undone.**
     ///
     /// If the server advertises support for sending a state event using `m.room.redact`,
-    /// use [#sendStateEvent(RoomID, String, String, RoomStateEvent)]
+    /// use [#sendStateEvent(RoomID, String, String, DeserializedEvent)]
     ///
     /// @param roomId  the room ID where to redact the event.
     /// @param eventId the event ID of the event to target and redact.

src/main/java/io/github/hikingc/matrixsdk/api/events/ClientEvent.java

@@ -30,5 +30,5 @@ public record ClientEvent(@JsonProperty(required = true) Map<String, Object> con
                           String stateKey,
                           @JsonProperty(required = true) String type,
                           UnsignedData unsigned
-) implements RoomStateEvent<Map<String, Object>> {
+) implements DeserializedEvent<Map<String, Object>> {
 }

src/main/java/io/github/hikingc/matrixsdk/api/events/DeserializedEvent.java

@@ -0,0 +1,42 @@
+package io.github.hikingc.matrixsdk.api.events;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+
+
+/// Interface that enforces fields required by both State and Message events when the event is retrieved from the server.
+///
+/// @param <T> the event `m.` type
+/// @see <a href="https://spec.matrix.org/latest/client-server-api/#room-event-format">The room event format as defined in the specification.</a>
+@JsonInclude(JsonInclude.Include.NON_ABSENT)
+public sealed interface DeserializedEvent<T> permits ClientEvent, SingletonStateEvent {
+
+    /// @return the body of this event, as created by the user which sent it.
+    T content();
+
+    /// @return the globally unique identifier for this event.
+    String eventId();
+
+
+    /// @return timestamp (in milliseconds since the Unix epoch) on originating homeserver when this event
+    /// was sent.
+    Long originServerTs();
+
+    /// @return the ID of the room associated with this event.
+    String roomId();
+
+    /// @return contains the fully-qualified ID of the user who sent this event.
+    String sender();
+
+    /// @return present if, and only if, this event is a state event. The key making this piece of state
+    /// unique in the room. Note that it is often an empty string.
+    /// State keys starting with an @ are reserved for referencing user IDs, such as room members. Except a few events,
+    /// state events set with a given user’s ID as the state key MUST only be set by that user.
+    String stateKey();
+
+    /// @return the type of the event.
+    String type();
+
+    /// @return optional extra information about the event.
+    UnsignedData unsigned();
+
+}

src/main/java/io/github/hikingc/matrixsdk/api/events/EncryptedFile.java

@@ -1,5 +1,7 @@
 package io.github.hikingc.matrixsdk.api.events;
 
+import io.github.hikingc.matrixsdk.api.events.messages.RoomMessageEvent;
+
 import java.util.Map;
 
 /// Holds information of an encrypted file as the extension to [RoomMessageEvent].

src/main/java/io/github/hikingc/matrixsdk/api/events/EventContent.java

@@ -1,9 +1,6 @@
 package io.github.hikingc.matrixsdk.api.events;
 
-import com.fasterxml.jackson.annotation.JsonProperty;
-
 import java.net.URI;
-import java.util.Map;
 
 /// Represents the contents of an event
 ///
@@ -27,21 +24,4 @@ public record EventContent(URI avatarUrl,
                            ThirdPartyInvite thirdPartyInvite) {
 
 
-    /// @param displayName a name which can be displayed to represent the user instead of their third-party identifier
-    /// @param signed      a block of content which has been signed by the identity server, which homeservers can use to verify the event. Clients should ignore this.
-    public record ThirdPartyInvite(@JsonProperty(required = true) String displayName,
-                                   @JsonProperty(required = true) SignedThirdPartyInvite signed) {
-
-        /// @param mxid       the user ID that has been bound to the third-party identifier.
-        /// @param signatures the identity server signatures for this block. This is a map of identity server name to signing key identifier to base64-encoded signature.
-        /// @param token      The token generated by the identity server at the `/store_invite` endpoint.
-        ///
-        /// It matches the `state_key` of the corresponding `m.room.third_party_invite` event.
-        /// @see <a href="https://spec.matrix.org/v1.19/appendices/#signing-json">documentation about  Signing JSON</a>
-        /// @see <a href="https://spec.matrix.org/v1.19/identity-service-api/#post_matrixidentityv2store-invite">Identity Service API</a>
-        public record SignedThirdPartyInvite(@JsonProperty(required = true) String mxid,
-                                             @JsonProperty(required = true) Map<String, Map<String, String>> signatures,
-                                             @JsonProperty(required = true) String token) {
-        }
-    }
 }

src/main/java/io/github/hikingc/matrixsdk/api/events/RoomInfo.java

@@ -2,6 +2,7 @@
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 import io.github.hikingc.matrixsdk.api.Room;
+import io.github.hikingc.matrixsdk.api.events.messages.RoomMessageEvent;
 import io.github.hikingc.matrixsdk.api.identifiers.RoomID;
 import io.github.hikingc.matrixsdk.api.rooms.PublicRoomRequest;
 
@@ -24,7 +25,7 @@ public record RoomInfo(List<Event> accountData,
                        List<ClientEvent> state,
                        String visibility) {
 
-    /// Holds a Matrix event, which can then be serialized as one of either [RoomStateEvent] or [RoomMessageEvent] for example.
+    /// Holds a Matrix event, which can then be serialized as one of either [DeserializedEvent] or [RoomMessageEvent] for example.
     ///
     /// @param content the fields of an event.
     /// @param type    the type of the event, for example, `m.tag`

src/main/java/io/github/hikingc/matrixsdk/api/events/RoomStateEvent.java

@@ -0,0 +1,13 @@
+package io.github.hikingc.matrixsdk.api.events;
+
+import io.github.hikingc.matrixsdk.api.events.states.*;
+
+/// Interface that represents all state events which hold an empty `state_key` [String].
+///
+/// @param <C> a Record that represents the `content` of the event.
+public sealed interface SingletonStateEvent<C> extends DeserializedEvent<C> permits RoomAvatarEvent, RoomCanonicalAliasEvent, RoomCreateEvent, RoomGuestAcessEvent, RoomHistoryVisibilityEvent, RoomJoinRulesEvent, RoomMemberEvent, RoomNameEvent, RoomPinnedEventEvents, RoomPowerLevelsEvent, RoomTopicEvent {
+
+    default String stateKey() {
+        return "";
+    }
+}

src/main/java/io/github/hikingc/matrixsdk/api/events/SingletonStateEvent.java

@@ -0,0 +1,23 @@
+package io.github.hikingc.matrixsdk.api.events;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import java.util.Map;
+
+/// @param displayName a name which can be displayed to represent the user instead of their third-party identifier
+/// @param signed      a block of content which has been signed by the identity server, which homeservers can use to verify the event. Clients should ignore this.
+public record ThirdPartyInvite(@JsonProperty(required = true) String displayName,
+                               @JsonProperty(required = true) SignedThirdPartyInvite signed) {
+
+    /// @param mxid       the user ID that has been bound to the third-party identifier.
+    /// @param signatures the identity server signatures for this block. This is a map of identity server name to signing key identifier to base64-encoded signature.
+    /// @param token      The token generated by the identity server at the `/store_invite` endpoint.
+    ///
+    /// It matches the `state_key` of the corresponding `m.room.third_party_invite` event.
+    /// @see <a href="https://spec.matrix.org/v1.19/appendices/#signing-json">documentation about  Signing JSON</a>
+    /// @see <a href="https://spec.matrix.org/v1.19/identity-service-api/#post_matrixidentityv2store-invite">Identity Service API</a>
+    public record SignedThirdPartyInvite(@JsonProperty(required = true) String mxid,
+                                         @JsonProperty(required = true) Map<String, Map<String, String>> signatures,
+                                         @JsonProperty(required = true) String token) {
+    }
+}

src/main/java/io/github/hikingc/matrixsdk/api/events/ThirdPartyInvite.java

@@ -1,5 +1,7 @@
 package io.github.hikingc.matrixsdk.api.events.messages;
 
+import io.github.hikingc.matrixsdk.api.events.states.RoomAvatar;
+
 /// Marks event content that includes file metadata such as a MIME type
 /// and size in bytes, as described by the Matrix specification's
 /// `info` object.
@@ -8,8 +10,7 @@
 /// @see Image.ImageInfo
 /// @see File.FileInfo
 /// @see Video.VideoInfo
-public sealed interface HasInfo permits Audio.AudioInfo, File.FileInfo, Image.ImageInfo,
-        Video.VideoInfo {
+public sealed interface HasInfo permits Audio.AudioInfo, File.FileInfo, Image.ImageInfo, Video.VideoInfo, RoomAvatar.AvatarInfo {
     /// @return the mimetype of the corresponding input resource
     String mimetype();