simbot-component-kook-api/love.forte.simbot.kook.api.channel

Package-level declarations

Types

data class ChannelInfo @ApiResultType constructor(val id: String, val name: String, val isCategory: Boolean, val userId: String, val parentId: String, val level: Int, val type: Int, val limitAmount: Int, val guildId: String = "", val topic: String = "", val slowMode: Int = 0, val permissionOverwrites: List<PermissionOverwrite> = emptyList(), val permissionSync: Int = 0, val hasPassword: Boolean = false)

Api GetChannelListApi 的响应体。

ChannelKickoutApi

class ChannelKickoutApi : KookPostApi<Unit>

踢出语音频道中的用户

ChannelMoveUserApi

class ChannelMoveUserApi : KookPostApi<Unit>

语音频道之间移动用户

ChannelView

@Serializable

data class ChannelView @ApiResultType constructor(val id: String, val guildId: String, val userId: String, val parentId: String, val name: String, val topic: String, val type: Int, val level: Int, val slowMode: Int, val hasPassword: Boolean = false, val maximumMember: Int, val isCategory: Boolean = false, val serverUrl: String, val permissionOverwrites: List<PermissionOverwrite> = emptyList(), val permissionUsers: List<String> = emptyList(), val permissionSync: Int = 0, val children: List<String>? = null)

GetChannelViewApi 的响应体。

CreateChannelApi

class CreateChannelApi : KookPostApi<ChannelView>

创建频道

DeleteChannelApi

class DeleteChannelApi : KookPostApi<Unit>

删除频道

GetChannelListApi

class GetChannelListApi : KookGetApi<ListData<ChannelInfo>>

获取频道列表

GetChannelUserListApi

class GetChannelUserListApi : KookGetApi<List<VoiceChannelUser>>

语音频道用户列表

GetChannelViewApi

class GetChannelViewApi : KookGetApi<ChannelView>

获取频道详情

LiveInfo

@Serializable

data class LiveInfo @ApiResultType constructor(val inLive: Boolean = false, val audienceCount: Int = 0, val liveThumb: String = "", val liveStartTime: Long = 0)

用户的直播信息

UpdateChannelApi

class UpdateChannelApi : KookPostApi<ChannelView>

编辑频道

VoiceChannelUser

@Serializable

data class VoiceChannelUser @ApiResultType constructor(val id: String, val username: String, val avatar: String, val identifyNum: String = username.substringAfter('#', ""), val isOnline: Boolean = false, val os: String? = null, val status: Int = 0, val vipAvatar: String? = null, val nickname: String? = null, val roles: List<Long> = emptyList(), val isVip: Boolean = false, val isAiReduceNoise: Boolean = false, val isPersonalCardBg: Boolean = false, val isBot: Boolean = false, val isMobileVerified: Boolean, val joinedAt: Long = 0, val activeTime: Long = 0, val liveInfo: LiveInfo? = null) : User

Api GetChannelUserListApi 的响应体中的用户信息。

Inherited functions

create

inline fun UpdateChannelApi.Factory.create(channelId: String, block: UpdateChannelApi.Builder.() -> Unit): UpdateChannelApi

使用 DSL 方式创建 UpdateChannelApi.

createFlow

inline fun GetChannelListApi.Factory.createFlow(crossinline block: suspend GetChannelListApi.Factory.(page: Int) -> ListData<ChannelInfo>): Flow<ListData<ChannelInfo>>

批次量的通过 GetChannelListApi 查询所有结果直至最后一次响应的 ListMeta.page>= ListMeta.pageTotal。

createItemFlow

inline fun GetChannelListApi.Factory.createItemFlow(crossinline block: suspend GetChannelListApi.Factory.(page: Int) -> ListData<ChannelInfo>): Flow<ChannelInfo>

批次量的通过 GetChannelListApi 查询所有结果直至最后一次响应的 ListMeta.page>= ListMeta.pageTotal。

slowMode

fun UpdateChannelApi.Builder.slowMode(slowMode: Duration)

慢速模式。

toChannel

fun ChannelView.toChannel(permissionUsers: List<PermissionUser> = emptyList()): Channel

将 ChannelView 转化为 Channel 类型，并可选的提供一些缺失字段的默认值。

fun ChannelInfo.toChannel(guildId: String = this.guildId, topic: String = this.topic, slowMode: Int = this.slowMode, permissionOverwrites: List<PermissionOverwrite> = this.permissionOverwrites, permissionUsers: List<PermissionUser> = emptyList(), permissionSync: Int = this.permissionSync, hasPassword: Boolean = this.hasPassword): Channel

将 ChannelInfo 转化为 Channel 类型，并可选的提供一些缺失字段的默认值。