trixnity-client/de.connect2x.trixnity.client.room.message

Package-level declarations

Types

typealias ContentBuilder = suspend ContentBuilderInfo.() -> MessageEventContent?

data class ContentBuilderInfo(val relatesTo: RelatesTo?, val mentions: Mentions?, val newContentMentions: Mentions?)

class MessageBuilder(val roomId: RoomId, val roomService: RoomService, val mediaService: MediaService, val ownUserId: UserId)

RoomMessageBuilderInfo

data class RoomMessageBuilderInfo(val body: String, val format: String?, val formattedBody: String?, val relatesTo: RelatesTo?, val mentions: Mentions?)

Functions

audio

suspend fun MessageBuilder.audio(body: String, audio: ByteArrayFlow, format: String? = null, formattedBody: String? = null, fileName: String? = null, type: ContentType? = null, size: Long? = null, duration: Long? = null)

emote

fun MessageBuilder.emote(body: String, format: String? = null, formattedBody: String? = null)

file

suspend fun MessageBuilder.file(body: String, file: ByteArrayFlow, format: String? = null, formattedBody: String? = null, fileName: String? = null, type: ContentType? = null, size: Long? = null, thumbnail: ByteArrayFlow? = null, thumbnailInfo: ThumbnailInfo? = null)

image

suspend fun MessageBuilder.image(body: String, image: ByteArrayFlow, format: String? = null, formattedBody: String? = null, fileName: String? = null, type: ContentType? = null, size: Long? = null, height: Int? = null, width: Int? = null, thumbnail: ByteArrayFlow? = null, thumbnailInfo: ThumbnailInfo? = null)

mentions

fun MessageBuilder.mentions(users: Set<UserId>? = mentions?.users, room: Boolean? = mentions?.room)

Add mentions to the message. Can be called multiple times and adds new mentions each time.

mentionsRoom

fun MessageBuilder.mentionsRoom()

mentionsUser

fun MessageBuilder.mentionsUser(user: UserId)

notice

fun MessageBuilder.notice(body: String, format: String? = null, formattedBody: String? = null)

plus

operator fun Mentions.plus(other: Mentions): Mentions

react

fun MessageBuilder.react(event: TimelineEvent, key: String)

fun MessageBuilder.react(eventId: EventId, key: String)

fun MessageBuilder.react(event: ClientEvent.RoomEvent.MessageEvent<*>, key: String)

replace

fun MessageBuilder.replace(event: TimelineEvent)

fun MessageBuilder.replace(eventId: EventId)

fun MessageBuilder.replace(event: ClientEvent.RoomEvent.MessageEvent<*>)

suspend fun MessageBuilder.reply(event: TimelineEvent)

suspend fun MessageBuilder.reply(event: ClientEvent.RoomEvent.MessageEvent<*>)

suspend fun MessageBuilder.reply(eventId: EventId, eventRelatesTo: RelatesTo?)

Important: eventRelatesTo should be set from the event, that is replied. Otherwise, thread support is dropped.

roomMessageBuilder

fun MessageBuilder.roomMessageBuilder(body: String, format: String?, formattedBody: String?, builder: RoomMessageBuilderInfo.() -> RoomMessageEventContent)

text

fun MessageBuilder.text(body: String, format: String? = null, formattedBody: String? = null)

thread

fun MessageBuilder.thread(event: TimelineEvent, reply: Boolean = false)

fun MessageBuilder.thread(event: ClientEvent.RoomEvent.MessageEvent<*>, reply: Boolean = false)

event must be the last known event of a thread.

fun MessageBuilder.thread(eventId: EventId, eventRelatesTo: RelatesTo? = null, reply: Boolean = false)

eventId and eventRelatesTo must be from the last known event of a thread.

video

suspend fun MessageBuilder.video(body: String, video: ByteArrayFlow, format: String? = null, formattedBody: String? = null, fileName: String? = null, type: ContentType? = null, size: Long? = null, height: Int? = null, width: Int? = null, duration: Long? = null, thumbnail: ByteArrayFlow? = null, thumbnailInfo: ThumbnailInfo? = null)