commonMain.net.folivo.trixnity.clientserverapi.model.users.GetDisplayName.kt Maven / Gradle / Ivy

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.users

import io.ktor.resources.*
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.WithoutAuth
import net.folivo.trixnity.core.model.UserId

/**
 * @see matrix spec
 */
@Serializable
@Resource("/_matrix/client/v3/profile/{userId}/displayname")
@HttpMethod(GET)
@WithoutAuth
data class GetDisplayName(
    @SerialName("userId") val userId: UserId,
) : MatrixEndpoint {
    @Serializable
    data class Response(
        @SerialName("displayname") val displayName: String?
    )
}