Skip to content

富文本模型

来源文件: botpy/types/rich_text.py

相关类型: Forum 模型AuditResultThreadMessage 模型

用于论坛帖子等场景中的富文本内容。


字面量类型别名

以下 Literal 类型别名定义了固定的取值集合。由于它们是类型别名而非数据结构,此处列出各取值的含义。

AuditType

审核类型(Literal[1, 2, 3])。

取值语义说明
1帖子
2评论
3回复

RichType

富文本对象类型(Literal[1, 2, 3, 4, 5, 10, 11])。

取值语义说明
1普通文本
2@ 信息
3URL 信息
4表情
5#子频道
10视频
11图片

AtType

@ 信息类型(Literal[1, 2, 3])。

取值语义说明
1@ 特定的人
2@ 角色组所有人
3@ 频道所有人

ElemType

富文本元素类型(Literal[1, 2, 3, 4])。

取值语义说明
1文本
2图片
3视频
4URL

Alignment

段落对齐方式(Literal[0, 1, 2])。

取值语义说明
0左对齐
1居中
2右对齐

ParagraphProps

段落属性。

变量名称变量类型语义说明
alignmentAlignment段落对齐方式

URLElem

URL 元素。

变量名称变量类型语义说明
urlstr跳转 URL
descstr描述文本

ImageElem

图片元素。

变量名称变量类型语义说明
third_urlstr图片 URL
width_percentfloat图片宽度百分比

PlatImage

平台图片信息。

变量名称变量类型语义说明
urlstr图片 URL
widthint图片宽度
heightint图片高度
image_idstr图片 ID

VideoElem

视频元素。

变量名称变量类型语义说明
third_urlstr视频 URL

PlatVideo

平台视频信息。

变量名称变量类型语义说明
urlstr视频 URL
widthint视频宽度
heightint视频高度
video_idstr视频 ID
durationint视频时长
coverPlatImage封面图

TextProps

文本属性。

变量名称变量类型语义说明
font_boldbool是否加粗
italicbool是否斜体
underlinebool是否有下划线

TextElem

文本元素。

变量名称变量类型语义说明
textstr文本内容
propsTextProps文本属性

Elem

富文本元素(统一容器),根据 type 区分具体元素类型。

变量名称变量类型语义说明
textTextElem文本元素(type=1 时有效)
imageImageElem图片元素(type=2 时有效)
videoVideoElem视频元素(type=3 时有效)
urlURLElemURL 元素(type=4 时有效)
typeElemType元素类型

Paragraph

段落结构,包含一组元素。

变量名称变量类型语义说明
elemsList[Elem]元素列表
propsParagraphProps段落属性

RichText

富文本整体结构。

变量名称变量类型语义说明
paragraphsParagraph段落

ChannelInfo

子频道信息。

变量名称变量类型语义说明
channel_idint子频道 ID
channel_namestr子频道名称

EmojiInfo

表情信息。

变量名称变量类型语义说明
idstr表情 ID
typestr表情类型
namestr表情名称
urlstr表情 URL

URLInfo

URL 信息。

变量名称变量类型语义说明
urlstr跳转 URL
display_textstr展示文本

AtGuildInfo

@ 频道信息。

变量名称变量类型语义说明
guild_idstr频道 ID
guild_namestr频道名称

AtRoleInfo

@ 角色组信息。

变量名称变量类型语义说明
role_idint身份组 ID
namestr身份组名称
colorint身份组颜色

AtUserInfo

@ 用户信息。

变量名称变量类型语义说明
idstr用户 ID
nickstr用户昵称

AtInfo

@ 信息。

变量名称变量类型语义说明
typeAuditType@ 类型(1=@用户,2=@角色组,3=@所有人)
user_infoAtUserInfo@ 用户信息
role_infoAtRoleInfo@ 角色组信息
guild_infoAtGuildInfo@ 频道信息

TextInfo

文本信息。

变量名称变量类型语义说明
textstr文本内容

RichObject

富文本对象(论坛事件等场景使用)。

变量名称变量类型语义说明
typeRichType富文本类型
text_infoTextInfo文本信息
at_infoAtInfo@ 信息
url_infoURLInfoURL 信息
emoji_infoEmojiInfo表情信息
channel_infoChannelInfo子频道信息