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

Package-level declarations

KMarkdown 解析与构建。

Types

sealed class AtTarget : CharSequence

可用于 At 的目标类型，分为指定用户、全体和在线。

BaseCustomKookMarkdownGrammar

abstract class BaseCustomKookMarkdownGrammar<P>(source: KookMarkdownGrammar.Source.Custom) : BaseKookMarkdownGrammar<P>

BaseKaiheilaCustomKookMarkdownGrammar

abstract class BaseKaiheilaCustomKookMarkdownGrammar<P> : BaseKookMarkdownGrammar<P>

BaseKaiheilaEmojiKookMarkdownGrammar

abstract class BaseKaiheilaEmojiKookMarkdownGrammar<P> : BaseKookMarkdownGrammar<P>

BaseKookMarkdownGrammar

abstract class BaseKookMarkdownGrammar<P>(val grammarSource: KookMarkdownGrammar.Source) : KookMarkdownGrammar<P>

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

BaseMarkdownKookMarkdownGrammar

abstract class BaseMarkdownKookMarkdownGrammar<P> : BaseKookMarkdownGrammar<P>

interface KMarkdown

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

KMarkdownBuilder

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

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

KookMarkdownBuilderDsl

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY])

annotation class KookMarkdownBuilderDsl

KookMarkdownBuilderTopDsl

@Target(allowedTargets = [AnnotationTarget.TYPE, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY])

annotation class ~~KookMarkdownBuilderTopDsl~~

KookMarkdownGrammar

interface KookMarkdownGrammar<P>

Kook KMarkdown 语法封装.

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

代码块参数

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

用于超链接语法的参数

MdServerEmoticons

data class MdServerEmoticons(val name: CharSequence, val id: CharSequence)

用于服务器表情的参数

NoParamCustomKookMarkdownGrammar

abstract class NoParamCustomKookMarkdownGrammar(source: KookMarkdownGrammar.Source.Custom) : NoParamKookMarkdownGrammar

NoParamKookCustomKookMarkdownGrammar

abstract class NoParamKookCustomKookMarkdownGrammar : NoParamKookMarkdownGrammar

NoParamKookEmojiKookMarkdownGrammar

abstract class NoParamKookEmojiKookMarkdownGrammar : NoParamKookMarkdownGrammar

NoParamKookMarkdownGrammar

abstract class NoParamKookMarkdownGrammar(grammarSource: KookMarkdownGrammar.Source) : BaseKookMarkdownGrammar<Nothing?>

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

NoParamMarkdownKookMarkdownGrammar

abstract class NoParamMarkdownKookMarkdownGrammar : NoParamKookMarkdownGrammar

RawValueKMarkdown

@SerialName(value = "raw.kmd")

data class RawValueKMarkdown(val rawContent: String, val mentionPart: List<MentionPart> = emptyList(), val mentionRolePart: List<MentionRolePart> = emptyList()) : KMarkdown

原始信息 KMarkdown.

SymmetricalCustomKookMarkdownGrammar

abstract class SymmetricalCustomKookMarkdownGrammar(wing: CharSequence, source: KookMarkdownGrammar.Source.Custom) : SymmetricalKookMarkdownGrammar

SymmetricalKookCustomKookMarkdownGrammar

abstract class SymmetricalKookCustomKookMarkdownGrammar(wing: CharSequence) : SymmetricalKookMarkdownGrammar

SymmetricalKookEmojiKookMarkdownGrammar

abstract class SymmetricalKookEmojiKookMarkdownGrammar(wing: CharSequence) : SymmetricalKookMarkdownGrammar

SymmetricalKookMarkdownGrammar

abstract class SymmetricalKookMarkdownGrammar(wing: CharSequence, grammarSource: KookMarkdownGrammar.Source) : BaseKookMarkdownGrammar<CharSequence>

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

SymmetricalMarkdownKookMarkdownGrammar

abstract class SymmetricalMarkdownKookMarkdownGrammar(wing: CharSequence) : SymmetricalKookMarkdownGrammar

ValueAppenderCustomKookMarkdownGrammar

abstract class ValueAppenderCustomKookMarkdownGrammar<V : CharSequence>(value: V, source: KookMarkdownGrammar.Source.Custom) : ValueAppenderKookMarkdownGrammar<V>

ValueAppenderKookCustomKookMarkdownGrammar

abstract class ValueAppenderKookCustomKookMarkdownGrammar<V : CharSequence>(value: V) : ValueAppenderKookMarkdownGrammar<V>

ValueAppenderKookEmojiKookMarkdownGrammar

abstract class ValueAppenderKookEmojiKookMarkdownGrammar<V : CharSequence>(value: V) : ValueAppenderKookMarkdownGrammar<V>

ValueAppenderKookMarkdownGrammar

abstract class ValueAppenderKookMarkdownGrammar<V : CharSequence>(value: V, grammarSource: KookMarkdownGrammar.Source) : NoParamKookMarkdownGrammar

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

ValueAppenderMarkdownKookMarkdownGrammar

abstract class ValueAppenderMarkdownKookMarkdownGrammar<V : CharSequence>(value: V) : ValueAppenderKookMarkdownGrammar<V>

Functions

inline fun buildKMarkdown(block: KMarkdownBuilder.() -> Unit): KMarkdown

Build KMarkdown instance.

buildRawKMarkdown

inline fun buildRawKMarkdown(block: KMarkdownBuilder.() -> Unit): String

Build kmarkdown for raw string.

Inherited functions

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

fun <P> KookMarkdownGrammar<P>.build(param: P): String

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

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

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