trixnity-core/net.folivo.trixnity.core.model/Mention

Mention

sealed interface Mention

Represents a mention. A mention can refer to various entities and potentially include actions associated with them.

Inheritors

Types

Link copied to clipboard
data class Event(val roomId: RoomId? = null, val eventId: EventId, val match: String, val label: String? = null, val parameters: Parameters? = null) : Mention

Represents a mention of a generic event.

Link copied to clipboard
data class Room(val roomId: RoomId, val match: String, val parameters: Parameters? = null, val label: String? = null) : Mention

Represents a mention of a room.

Link copied to clipboard
data class RoomAlias(val roomAliasId: RoomAliasId, val match: String, val parameters: Parameters? = null, val label: String? = null) : Mention

Represents a mention of a room alias

Link copied to clipboard
data class User(val userId: UserId, val match: String, val parameters: Parameters? = null, val label: String? = null) : Mention

Represents a mention of a user.

Properties

Link copied to clipboard
abstract val label: String?

The optional display name associated with the mention, if applicable.

Link copied to clipboard
abstract val match: String

The textual representation of the mention within the message it appears. Use with care, IntRange preferred

Link copied to clipboard
abstract val parameters: Parameters?

If exists, the parameters provided in the URI