matrix-sdk-android/org.matrix.android.sdk.api.session.events.model

Package-level declarations

Types

@JsonClass(generateAdapter = true)

data class AggregatedAnnotation(val limited: Boolean? = false, val count: Int? = 0, val chunk: List<RelationChunkInfo>? = null) : UnsignedRelationInfo


    {
      "chunk": [
           {
               "type": "m.reaction",
               "key": "👍",
               "count": 3
           }
          ],
          "limited": false,
          "count": 1
    },

AggregatedRelations

@JsonClass(generateAdapter = true)

data class AggregatedRelations(@Json(name = "m.annotation") val annotations: AggregatedAnnotation? = null, @Json(name = "m.reference") val references: DefaultUnsignedRelationInfo? = null, @Json(name = "m.replace") val replaces: AggregatedReplace? = null, @Json(name = "m.thread") val latestThread: LatestThreadUnsignedRelation? = null)

Server side relation aggregation.

AggregatedReplace

@JsonClass(generateAdapter = true)

data class AggregatedReplace(@Json(name = "event_id") val eventId: String? = null, @Json(name = "origin_server_ts") val originServerTs: Long? = null, @Json(name = "sender") val senderId: String? = null)

Note that there can be multiple events with an m.replace relationship to a given event (for example, if an event is edited multiple times). These should be aggregated by the homeserver. https://spec.matrix.org/v1.4/client-server-api/#server-side-aggregation-of-mreplace-relationships

Content

typealias Content = JsonDict

DefaultUnsignedRelationInfo

@JsonClass(generateAdapter = true)

data class DefaultUnsignedRelationInfo(val limited: Boolean? = false, val count: Int? = 0, val chunk: List<Map<String, Any>>? = null) : UnsignedRelationInfo

Event

@JsonClass(generateAdapter = true)

data class Event(@Json(name = "type") val type: String? = null, @Json(name = "event_id") val eventId: String? = null, @Json(name = "content") val content: Content? = null, @Json(name = "prev_content") val prevContent: Content? = null, @Json(name = "origin_server_ts") val originServerTs: Long? = null, @Json(name = "sender") val senderId: String? = null, @Json(name = "state_key") val stateKey: String? = null, @Json(name = "room_id") val roomId: String? = null, @Json(name = "unsigned") val unsignedData: UnsignedData? = null, @Json(name = "redacts") val redacts: String? = null)

Generic event class with all possible fields for events. The content and prevContent json fields can easily be mapped to a model with toModel method.

EventType

object EventType

Constants defining known event types from Matrix specifications.

LatestThreadUnsignedRelation

@JsonClass(generateAdapter = true)

data class LatestThreadUnsignedRelation(val limited: Boolean? = false, val count: Int? = 0, @Json(name = "latest_event") val event: Event? = null, @Json(name = "current_user_participated") val isUserParticipating: Boolean? = false) : UnsignedRelationInfo

LocalEcho

object LocalEcho

RelationChunkInfo

@JsonClass(generateAdapter = true)

data class RelationChunkInfo(val type: String, val key: String, val count: Int)


    {
        "type": "m.reaction",
        "key": "👍",
        "count": 3
    }

RelationType

object RelationType

Constants defining known event relation types from Matrix specifications.

StableUnstableId

data class StableUnstableId(val stable: String, val unstable: String)

UnsignedData

@JsonClass(generateAdapter = true)

data class UnsignedData(@Json(name = "age") val age: Long?, @Json(name = "redacted_because") val redactedEvent: Event? = null, @Json(name = "transaction_id") val transactionId: String? = null, @Json(name = "prev_content") val prevContent: Map<String, Any>? = null, @Json(name = "m.relations") val relations: AggregatedRelations? = null, @Json(name = "replaces_state") val replacesState: String? = null)

UnsignedRelationInfo

interface UnsignedRelationInfo

ValidDecryptedEvent

data class ValidDecryptedEvent(val type: String, val eventId: String, val clearContent: Content, val prevContent: Content? = null, val originServerTs: Long, val cryptoSenderKey: String, val roomId: String, val unsignedData: UnsignedData? = null, val redacts: String? = null, val algorithm: String)