commonMain.net.folivo.trixnity.clientserverapi.model.rooms.GetThreads.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of trixnity-clientserverapi-model Show documentation

Multiplatform Kotlin SDK for matrix-protocol

There is a newer version: 4.7.1

Show newest version

package net.folivo.trixnity.clientserverapi.model.rooms

import io.ktor.resources.*
import kotlinx.serialization.Contextual
import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable
import net.folivo.trixnity.core.HttpMethod
import net.folivo.trixnity.core.HttpMethodType.GET
import net.folivo.trixnity.core.MatrixEndpoint
import net.folivo.trixnity.core.model.RoomId
import net.folivo.trixnity.core.model.UserId
import net.folivo.trixnity.core.model.events.ClientEvent.RoomEvent

/**
 * @see matrix spec
 */
@Serializable
@Resource("/_matrix/client/v1/rooms/{roomId}/threads")
@HttpMethod(GET)
data class GetThreads(
    @SerialName("roomId") val roomId: RoomId,
    @SerialName("from") val from: String? = null,
    @SerialName("include") val include: Include? = null,
    @SerialName("limit") val limit: Long? = null,
    @SerialName("user_id") val asUserId: UserId? = null
) : MatrixEndpoint {

    @Serializable
    data class Response(
        @SerialName("next_batch") val end: String? = null,
        @SerialName("chunk") val chunk: List<@Contextual RoomEvent<*>>,
    )

    @Serializable
    enum class Include {
        @SerialName("all")
        ALL,

        @SerialName("participated")
        PARTICIPATED
    }
}