matrix-sdk-android/org.matrix.android.sdk.api.session.room.timeline/TimelineEvent

TimelineEvent

data class TimelineEvent( val root: Event, val localId: Long, val eventId: String, val displayIndex: Int, val ownedByThreadChunk: Boolean = false, val senderInfo: SenderInfo, val annotations: EventAnnotationsSummary? = null, val readReceipts: List<ReadReceipt> = emptyList())

This data class is a wrapper around an Event. It allows to get useful data in the context of a timeline. This class is used by TimelineService Users can also enrich it with metadata.

Constructors

fun TimelineEvent( root: Event, localId: Long, eventId: String, displayIndex: Int, ownedByThreadChunk: Boolean = false, senderInfo: SenderInfo, annotations: EventAnnotationsSummary? = null, readReceipts: List<ReadReceipt> = emptyList())

Functions

fun enrichWith(key: String?, data: Any?)

The method to enrich this timeline event. If you provides multiple data with the same key, only first one will be kept.

inline fun <T> getMetadata(key: String): T?

Get the metadata associated with a key.

fun isEncrypted(): Boolean

Properties

val annotations: EventAnnotationsSummary? = null

val displayIndex: Int

This display index is the position in the current chunk. It's not unique on the timeline as it's reset on each chunk.

val eventId: String

val localId: Long

Uniquely identify an event, computed locally by the sdk.

val metadata: HashMap<String, Any>

ownedByThreadChunk

val ownedByThreadChunk: Boolean = false

val readReceipts: List<ReadReceipt>

val roomId: String

val root: Event

val senderInfo: SenderInfo

Extensions

getEditedEventId

fun TimelineEvent.getEditedEventId(): String?

Get the eventId which was edited by this event if any.

getLastEditNewContent

fun TimelineEvent.getLastEditNewContent(): Content?

getLastMessageContent

fun TimelineEvent.getLastMessageContent(): MessageContent?

Get last MessageContent, after a possible edition.

getLatestEventId

fun TimelineEvent.getLatestEventId(): String

Get the latest known eventId for an edited event, or the eventId for an Event which has not been edited.

getRelationContent

fun TimelineEvent.getRelationContent(): RelationDefaultContent?

Get the relation content if any.

getTextEditableContent

fun TimelineEvent.getTextEditableContent(formatted: Boolean): String

Get the latest message body, after a possible edition, stripping the reply prefix if necessary.

fun TimelineEvent.hasBeenEdited(): Boolean

Tells if the event has been edited.

fun TimelineEvent.isEdition(): Boolean

fun TimelineEvent.isLiveLocation(): Boolean

fun TimelineEvent.isPoll(): Boolean

fun TimelineEvent.isReply(): Boolean

Returns true if it's a reply.

fun TimelineEvent.isRootThread(): Boolean

Returns whether or not the event is a root thread event.

fun TimelineEvent.isSticker(): Boolean