1
0
mirror of https://github.com/mamoe/mirai.git synced 2025-04-25 21:23:55 +08:00

Update docs

This commit is contained in:
Him188 2021-01-11 22:12:00 +08:00
parent e8c0ef192c
commit 78bc30ae5d

View File

@ -27,6 +27,7 @@ import net.mamoe.mirai.message.MessageSerializers
import net.mamoe.mirai.message.code.CodableMessage
import net.mamoe.mirai.message.code.MiraiCode
import net.mamoe.mirai.message.code.MiraiCode.parseMiraiCode
import net.mamoe.mirai.message.data.MessageChain.Companion.parseFromMiraiCode
import net.mamoe.mirai.message.data.MessageChain.Companion.serializeToJsonString
import net.mamoe.mirai.message.data.MessageSource.Key.quote
import net.mamoe.mirai.message.data.MessageSource.Key.recall
@ -107,7 +108,7 @@ import kotlin.streams.asSequence
* ```java
* MessageChain chain = new PlainText("Hello ").plus(new PlainText("Mirai!"))
* ```
* - [MessageChainBuilder]:
* - [MessageChainBuilder][MessageChainBuilder]:
* ```java
* MessageChainBuilder builder = MessageChainBuilder.create();
* builder.append(new PlainText("Hello "));
@ -121,7 +122,7 @@ import kotlin.streams.asSequence
*
* 当添加只允许单独存在的消息元素到一个消息链时, 已有的元素可能会被删除或替换. 详见 [AbstractPolymorphicMessageKey] [ConstrainSingle].
*
* # 操作 [MessageChain]
* # 操作消息链
*
* [MessageChain] 继承 `List<SingleMessage>`. 可以以 [List] 的方式处理 [MessageChain].
*
@ -134,6 +135,14 @@ import kotlin.streams.asSequence
*
* 相关地还可以使用 [MessageChain.contains] [MessageChain.getOrFail]
*
* ## 撤回和引用
* - [MessageSource.quote]
* - [MessageSource.recall]
* - [MessageSource.recallIn]
* - `MessageChain.quote`
* - `MessageChain.recall`
* - `MessageChain.recallIn`
*
* ## Kotlin 扩展
*
* ### 属性委托
@ -149,29 +158,20 @@ import kotlin.streams.asSequence
* - [MessageChain.contentsList]
* - [MessageChain.metadataList]
*
* # 序列化
*
* ## 序列化
*
* ### kotlinx-serialization 序列化
* ## kotlinx-serialization 序列化
*
* - 使用 [MessageChain.serializeToJsonString] [MessageChain] 序列化为 JSON [String].
* - 使用 [MessageChain.deserializeFromJsonString] JSON [String] 反序列化为 [MessageChain].
*
* ### Mirai Code 序列化
* ## Mirai Code 序列化
*
* 详见 [MiraiCode]
*
* - 使用 [MessageChain.toMiraiCode] [MessageChain] 序列化为 Mirai Code [String].
* - 使用 [MessageChain.toMiraiCode] Mirai Code [String] 反序列化为 [MessageChain].
* - 使用 [MessageChain.parseFromMiraiCode] Mirai Code [String] 反序列化为 [MessageChain].
*
*
* ## 撤回和引用
* - [MessageSource.quote]
* - [MessageSource.recall]
* - [MessageSource.recallIn]
* - `MessageChain.quote`
* - `MessageChain.recall`
* - `MessageChain.recallIn`
*/
@Serializable(MessageChain.Serializer::class)
public interface MessageChain :
@ -493,6 +493,7 @@ public fun Message.toMessageChain(): MessageChain = when (this) {
*
* val at: At by message
* val image: Image by message
* ```
*/
@JvmSynthetic
public inline operator fun <reified T : SingleMessage> MessageChain.getValue(thisRef: Any?, property: KProperty<*>): T =