simbot-component-kook-api/love.forte.simbot.kook.objects.kmd/KMarkdownBuilder

KMarkdownBuilder

class KMarkdownBuilder(val appender: Appendable = StringBuilder())(source)

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

Constructors

KMarkdownBuilder

constructor(capacity: Int)

constructor(appender: Appendable = StringBuilder())

Properties

val appender: Appendable

Functions

fun <P> append(grammar: KookMarkdownGrammar<P>, params: P): KMarkdownBuilder

通过一个 KookMarkdownGrammar 来实现自定义拼接。

fun appendRawMd(raw: String): KMarkdownBuilder

追加一个原始信息到md缓冲器中。会直接进行拼接，不做处理。

fun at(target: CharSequence): KMarkdownBuilder

fun at(target: AtTarget): KMarkdownBuilder

at

fun bold(value: CharSequence): KMarkdownBuilder

拼接一个加粗文本

fun boldItalic(value: CharSequence): KMarkdownBuilder

拼接一个加粗倾斜文本

fun build(): KMarkdown

构建一个 KMarkdown 实例。

fun buildRaw(): String

直接获取原始的markdown字符串。

fun channel(id: CharSequence): KMarkdownBuilder

提及频道

fun codeBlock(code: MdCodeBlock): KMarkdownBuilder

fun codeBlock(language: CharSequence? = null, code: CharSequence): KMarkdownBuilder

代码块

fun divider(): KMarkdownBuilder

追加一个分割线。不会自动在开头换行，但是会在结尾换行，也就是：---\n

fun emoji(id: String): KMarkdownBuilder

根据id追加一个emoji

fun hide(value: CharSequence): KMarkdownBuilder

追加隐藏内容。

fun inlineCode(code: CharSequence): KMarkdownBuilder

行内代码

fun italic(value: CharSequence): KMarkdownBuilder

拼接一个倾斜文本

fun link(link: MdLink): KMarkdownBuilder

fun link(name: String? = null, url: String): KMarkdownBuilder

拼接一个链接。

fun newLine(): KMarkdownBuilder

新的一行。

fun quote(value: CharSequence): KMarkdownBuilder

引用。如果想要结束引用内容，需要连续换行两次。

fun quoteAndEnd(value: CharSequence): KMarkdownBuilder

引用，并在结束后自动换行2次。

fun role(roleId: CharSequence): KMarkdownBuilder

role

serverEmoticons

fun serverEmoticons(value: MdServerEmoticons): KMarkdownBuilder

fun serverEmoticons(name: CharSequence, id: CharSequence): KMarkdownBuilder

服务器表情。

fun space(): KMarkdownBuilder

一个空格。

fun strikethrough(value: CharSequence): KMarkdownBuilder

拼接一个删除线

fun text(text: CharSequence): KMarkdownBuilder

拼接一个文本

fun underscore(value: CharSequence): KMarkdownBuilder

追加下划线内容。

Inherited functions

inline fun KMarkdownBuilder.aroundLine(times: Int = 1, block: KMarkdownBuilder.() -> Unit): KMarkdownBuilder

inline fun KMarkdownBuilder.postLine(times: Int = 1, block: KMarkdownBuilder.() -> Unit): KMarkdownBuilder

inline fun KMarkdownBuilder.preLine(times: Int = 1, block: KMarkdownBuilder.() -> Unit): KMarkdownBuilder