💡 add message docstring

This commit is contained in:
yanyongyu
2020-10-03 18:18:43 +08:00
parent b80f0bf202
commit 2574ef3e7a
2 changed files with 103 additions and 3 deletions

View File

@ -233,22 +233,88 @@ Event 基类。提供上报信息的关键信息,其余信息可从原始上
基类:`abc.ABC`
消息段基类
### `type`
* 类型: `str`
* 说明: 消息段类型
### `data`
* 类型: `Dict[str, Union[str, list]]`
* 说明: 消息段数据
## _class_ `BaseMessage`
基类:`list`, `abc.ABC`
消息数组
### `__init__(message=None, *args, **kwargs)`
Initialize self. See help(type(self)) for accurate signature.
* **参数**
* `message: Union[str, dict, list, MessageSegment, Message]`: 消息内容
### `append(obj)`
Append object to the end of the list.
* **说明**
添加一个消息段到消息数组末尾
* **参数**
* `obj: Union[str, MessageSegment]`: 要添加的消息段
### `extend(obj)`
Extend list by appending elements from the iterable.
* **说明**
拼接一个消息数组或多个消息段到消息数组末尾
* **参数**
* `obj: Union[Message, Iterable[MessageSegment]]`: 要添加的消息数组
### `reduce()`
* **说明**
缩减消息数组,即拼接相邻纯文本消息段
### `extract_plain_text()`
* **说明**
提取消息内纯文本消息