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

fun Event( @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

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>

getSenderKey

fun getSenderKey(): String?

hashCode

open override fun hashCode(): Int

isEncrypted

fun isEncrypted(): 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.

isStateEvent

fun isStateEvent(): Boolean

Check if event is a state event.

isUserMentioned

fun isUserMentioned(userId: String): Boolean

Determines whether or not current event has mentioned the user.

resolvedPrevContent

fun resolvedPrevContent(): Content?

sendStateError

fun sendStateError(): MatrixError?

toClearContentStringWithIndent

fun toClearContentStringWithIndent(): String?

toContentStringWithIndent

fun toContentStringWithIndent(): String

Properties

ageLocalTs

@Transient

var ageLocalTs: Long? = null

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