Package-level declarations

Types

Link copied to clipboard
Link copied to clipboard
sealed class AtTarget : CharSequence

可用于 At 的目标类型,分为指定用户全体在线

Link copied to clipboard

提供一个简单的 KookMarkdownGrammar 抽象类, 并将 grammarSource 提取至构造中。

Link copied to clipboard
data class Card @JvmOverloads constructor(val theme: Theme = Theme.PRIMARY, val color: String? = null, val size: Size = Size.Default, val modules: List<CardModule>)
Link copied to clipboard
annotation class CardBuildDsl
Link copied to clipboard
class CardBuilder @JvmOverloads constructor(collect: MutableCollection<CardModule> = mutableListOf())

针对 Card 的构建器。

Link copied to clipboard
sealed class CardElement
Link copied to clipboard
data class CardMessage(cards: List<Card>) : List<Card>
Link copied to clipboard
class CardMessageBuilder @JvmOverloads constructor(collect: MutableCollection<Card> = mutableListOf())

用于构建 CardMessage 的构建器。

Link copied to clipboard
sealed class CardModule
Link copied to clipboard
annotation class CardModuleBuildDsl
Link copied to clipboard
class CardModulesBuilder @JvmOverloads constructor(collect: MutableCollection<CardModule> = mutableListOf())

针对 CardModule 的集合的构建器。

Link copied to clipboard
annotation class CardMsgBuildDsl
Link copied to clipboard
interface Channel : KookObjects, ChannelInfo

Kook objects - 频道Channel

Link copied to clipboard

针对角色在该频道的权限覆写规则组成的列表.

Link copied to clipboard
interface Guild : KookObjects, GuildInfo

Kook objects - 服务器Guild

Link copied to clipboard
@ExperimentalSimbotApi
interface KMarkdown

Kook 的 KMarkdown. 此接口中定义的三个属性主要用于 接收消息 用。

Link copied to clipboard
@ExperimentalSimbotApi
class KMarkdownBuilder(val appender: Appendable = StringBuilder())

KMarkdown 的构建器。 可以通过自定义 appender 来提供自定义的字符串拼接器,默认使用 StringBuilder.

Link copied to clipboard

Kook KMarkdown 语法封装.

Link copied to clipboard
interface KookObjects

Kook 文档中所定义的部分标准object规则的父接口。

Link copied to clipboard
data class MdCodeBlock @JvmOverloads constructor(val language: CharSequence? = null, val value: CharSequence)

代码块参数

Link copied to clipboard
data class MdLink @JvmOverloads constructor(val name: CharSequence? = null, val url: CharSequence)

用于 超链接语法 的参数

Link copied to clipboard
data class MdServerEmoticons(val name: CharSequence, val id: ID)

用于 服务器表情 的参数

Link copied to clipboard
data class MentionPart @ApiResultType constructor(val id: CharSequenceID, val username: String, val fullName: String, val avatar: String)

Mention part info.

Link copied to clipboard
data class MentionRolePart(val id: CharSequenceID, val name: String)

提及角色权限组时候使用的 mention_role_part 字段值。

Link copied to clipboard

不需要参数的语法,例如一个删除线,它不需要任何内容,也不应该有任何内容。

Link copied to clipboard
value class Permissions(val perm: UInt)

权限是一个unsigned int值,由比特位代表是否拥有对应的权限。 权限值与对应比特位进行按位与操作,判断是否拥有该权限。

Link copied to clipboard

权限bitValue类型枚举.

Link copied to clipboard
Link copied to clipboard
@ExperimentalSimbotApi
data class RawValueKMarkdown(val rawContent: String, val mentionPart: List<MentionPart> = emptyList(), val mentionRolePart: List<MentionRolePart> = emptyList()) : KMarkdown

原始信息 KMarkdown.

Link copied to clipboard
data class ReactionEmoji(val id: String, val name: String)

用于标识用户 reaction 时候的Emoji信息。

Link copied to clipboard

Kook objects - 角色Role

Link copied to clipboard
enum Size : Enum<Size>

大小。可选值为:xs, sm, md, lg, 一般默认为 lg

Link copied to clipboard

前后追加元素对称的 Grammar. 例如:Hello World ->**Hello World** 这种,向前后追加相同元素的内容的,即认为为对称Grammar。

Link copied to clipboard
object SystemUser : User

id == 1 的时候,用户代表为 系统用户

Link copied to clipboard
enum Theme : Enum<Theme>

主题。 可选的值为:primary, success, danger, warning, info, secondary, none. 默认为 primary, 为 none 时不显示侧边框。

Link copied to clipboard
interface User : KookObjects, UserInfo

Kook objects - 用户User

Link copied to clipboard

NoParamKookMarkdownGrammar 的子集,直接拼接一个固定的元素.

Functions

Link copied to clipboard
@ExperimentalSimbotApi
inline fun KMarkdownBuilder.aroundLine(times: Int = 1, block: KMarkdownBuilder.() -> Unit): KMarkdownBuilder
Link copied to clipboard

通过一个单独的 语法 构建一个单独的 String 结果。

Link copied to clipboard

通过 CardMessageBuilder 以 DSL 的方式构建一个 CardMessage.

Link copied to clipboard
@ExperimentalSimbotApi
inline fun buildKMarkdown(block: KMarkdownBuilder.() -> Unit): KMarkdown

Build KMarkdown instance.

Link copied to clipboard
@ExperimentalSimbotApi
inline fun buildRawKMarkdown(block: KMarkdownBuilder.() -> Unit): String

Build kmarkdown for raw string.

Link copied to clipboard

合并多个权限值

Link copied to clipboard
operator fun PermissionType.plus(other: PermissionType): UInt

合并两个权限值

Link copied to clipboard
@ExperimentalSimbotApi
inline fun KMarkdownBuilder.postLine(times: Int = 1, block: KMarkdownBuilder.() -> Unit): KMarkdownBuilder
Link copied to clipboard
@ExperimentalSimbotApi
inline fun KMarkdownBuilder.preLine(times: Int = 1, block: KMarkdownBuilder.() -> Unit): KMarkdownBuilder

Properties

Link copied to clipboard

判断频道类型是否为 Channel.Type.GROUP.

Link copied to clipboard

判断频道类型是否为 Channel.Type.PERSON.

Link copied to clipboard

判断频道类型是否为 Channel.Type.PERSON.