Better document the various protocols and classes involved in dealing with room timelines.

This commit is contained in:
Stefan Ceriu
2025-05-23 10:29:19 +03:00
committed by Stefan Ceriu
parent 972084aaf7
commit 29cfcb0b85
4 changed files with 19 additions and 2 deletions
@@ -37,7 +37,9 @@ enum TimelineProxyError: Error {
case failedPaginatingEndReached
}
// sourcery: AutoMockable
/// Element X proxies generally wrap the counterpart RustSDK objects while providing platform specific
/// interfaces. In this case it composes methods for interacting with a room's timeline and should be used alongside
/// the ``TimelineItemProviderProtocol`` which offers a reactive interface to timeline changes.
protocol TimelineProxyProtocol {
var timelineItemProvider: TimelineItemProviderProtocol { get }
@@ -125,3 +127,6 @@ protocol TimelineProxyProtocol {
html: String?,
intentionalMentions: Mentions) -> RoomMessageEventContentWithoutRelation
}
// sourcery: AutoMockable
extension TimelineProxyProtocol { }