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

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.

Constructors

Event

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

Functions

asMessageAudioEvent

fun Event.asMessageAudioEvent(): MessageAudioEvent?

Map a EventType.MESSAGE event to a MessageAudioEvent.

copyAll

fun copyAll(type: String? = this.type, eventId: String? = this.eventId, content: Content? = this.content, prevContent: Content? = this.prevContent, originServerTs: Long? = this.originServerTs, senderId: String? = this.senderId, stateKey: String? = this.stateKey, roomId: String? = this.roomId, unsignedData: UnsignedData? = this.unsignedData, redacts: String? = this.redacts, mxDecryptionResult: OlmDecryptionResult? = this.mxDecryptionResult, verificationStateIsDirty: Boolean? = this.verificationStateIsDirty, mCryptoError: MXCryptoError.ErrorType? = this.mCryptoError, mCryptoErrorReason: String? = this.mCryptoErrorReason, sendState: SendState = this.sendState, ageLocalTs: Long? = this.ageLocalTs, threadDetails: ThreadDetails? = this.threadDetails): Event

Copy all fields, including transient fields.

equals

open operator override fun equals(other: Any?): Boolean

getClearContent

fun getClearContent(): Content?

getClearType

fun getClearType(): String

getDecryptedContent

fun getDecryptedContent(): Content?

getDecryptedTextSummary

fun getDecryptedTextSummary(): String?

Returns a user friendly content depending on the message type. It can be used especially for message summaries. It will return a decrypted text message or an empty string otherwise.

getDecryptedType

fun getDecryptedType(): String?

getKeysClaimed

fun getKeysClaimed(): Map<String, String>

getMsgType

fun Event.getMsgType(): String?

Return the value of "content.msgtype", if the Event type is "m.room.message" and if the content has it, and if it is a String.

getPollContent

fun Event.getPollContent(): MessagePollContent?

getPollQuestion

fun Event.getPollQuestion(): String?

Returns the poll question or null otherwise.

getRelationContent

fun Event.getRelationContent(): RelationDefaultContent?

getRelationContentForType

fun Event.getRelationContentForType(type: String): RelationDefaultContent?

Returns the relation content for a specific type or null otherwise.

getRootThreadEventId

fun Event.getRootThreadEventId(): String?

getSenderKey

fun getSenderKey(): String?

hashCode

open override fun hashCode(): Int

isAttachmentMessage

fun Event.isAttachmentMessage(): Boolean

isAudioMessage

fun Event.isAudioMessage(): Boolean

isContentReportable

fun Event.isContentReportable(): Boolean

isEdition

fun Event.isEdition(): Boolean

isEncrypted

fun isEncrypted(): Boolean

isFileMessage

fun Event.isFileMessage(): Boolean

isImageMessage

fun Event.isImageMessage(): Boolean

isInvitation

fun Event.isInvitation(): Boolean

isLiveLocation

fun Event.isLiveLocation(): Boolean

isLocationMessage

fun Event.isLocationMessage(): Boolean

isPoll

fun Event.isPoll(): Boolean

isPollEnd

fun Event.isPollEnd(): Boolean

isPollResponse

fun Event.isPollResponse(): Boolean

isPollStart

fun Event.isPollStart(): Boolean

isRedacted

fun isRedacted(): Boolean

Tells if the event is redacted.

isRedactedBySameUser

fun isRedactedBySameUser(): Boolean

Tells if the event is redacted by the user himself.

isReply

fun Event.isReply(): Boolean

isReplyRenderedInThread

fun Event.isReplyRenderedInThread(): Boolean

isStateEvent

fun isStateEvent(): Boolean

Check if event is a state event.

isSticker

fun Event.isSticker(): Boolean

isTextMessage

fun Event.isTextMessage(): Boolean

isThread

fun Event.isThread(): Boolean

isUserMentioned

fun isUserMentioned(userId: String): Boolean

Determines whether or not current event has mentioned the user.

isVideoMessage

fun Event.isVideoMessage(): Boolean

isVoiceMessage

fun Event.isVoiceMessage(): Boolean

resolvedPrevContent

fun resolvedPrevContent(): Content?

sendStateError

fun sendStateError(): MatrixError?

supportsNotification

fun Event.supportsNotification(): Boolean

toClearContentStringWithIndent

fun toClearContentStringWithIndent(): String?

toContentStringWithIndent

fun toContentStringWithIndent(): String

toDeviceTracingId

fun Event.toDeviceTracingId(): String?

toValidDecryptedEvent

fun Event.toValidDecryptedEvent(): ValidDecryptedEvent?

Properties

ageLocalTs

@Transient

var ageLocalTs: Long?

The age value transcoded in a timestamp based on the device clock when the SDK received the event from the homeserver. Unlike age, this value is static.

content

val content: Content? = null

eventId

val eventId: String? = null

mCryptoError

@Transient

var mCryptoError: MXCryptoError.ErrorType?

mCryptoErrorReason

@Transient

var mCryptoErrorReason: String?

mxDecryptionResult

@Transient