cn.byteforge.openqq.message

Class MessageBuilder

java.lang.Object

cn.byteforge.openqq.message.MessageBuilder

public class MessageBuilder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
MessageBuilder()

Method Summary

Modifier and Type	Method and Description
MessageBuilder	addArk(int templateId, com.google.gson.JsonArray keyValues) 发送 ark 消息
MessageBuilder	addArk(int templateId, java.util.List<?> keyValues) 发送 ark 消息
MessageBuilder	addAtText(java.lang.String userId) Deprecated. 无法解析
MessageBuilder	addBigPicArk(java.lang.String prompt, java.lang.String metaTitle, java.lang.String metaSubTitle, java.lang.String metaCover, java.lang.String metaAurl) Deprecated. 该模板不允许发送 url
MessageBuilder	addCustomMarkdown(java.lang.String content) 自定义 markdown 消息
MessageBuilder	addCustomMarkdownButton(java.lang.String rowsJson, java.lang.String appId) 发送自定义 Markdown 按钮消息
MessageBuilder	addLinkedTextListArk(java.lang.String desc, java.lang.String prompt, java.util.List<LinkedTextEntry> entryList) 发送 链接+文本列表模板 ark 消息
MessageBuilder	addMedia(java.lang.String fileInfo)
MessageBuilder	addMessage(Message message) 添加消息实体
MessageBuilder	addSmallPicArk(java.lang.String desc, java.lang.String prompt, java.lang.String title, java.lang.String metaDesc, java.lang.String img, java.lang.String link, java.lang.String subTitle) Deprecated. 该模板不允许发送 url
MessageBuilder	addTemplateMarkdown(java.lang.String templateId, com.google.gson.JsonArray keyValues) 从消息模版发送 Markdown 消息
MessageBuilder	addTemplateMarkdown(java.lang.String templateId, java.util.List<?> keyValues) 从消息模版发送 Markdown 消息
MessageBuilder	addTemplateMarkdown(java.lang.String templateId, java.lang.String keyValuesJson) 从消息模版发送 Markdown 消息
MessageBuilder	addTemplateMarkdownButton(java.lang.String templateId) Deprecated. 官方暂未支持根据模版发送 markdown 按钮消息（缺少字段）
MessageBuilder	addText(java.lang.String text) 添加文本内容
Message	build() 构建消息
MessageBuilder	setPassive(java.lang.String msgId) 设置为被动消息
MessageBuilder	setPassive(java.lang.String msgId, @Nullable java.lang.Integer msgSeq) 设置为被动消息

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MessageBuilder

public MessageBuilder()

Method Detail

addText

public MessageBuilder addText(java.lang.String text)

添加文本内容

addAtText

@Deprecated
public MessageBuilder addAtText(java.lang.String userId)

Deprecated. 无法解析

使用 @ 能力

Parameters:

userId - 用户 openId

addTemplateMarkdown

public MessageBuilder addTemplateMarkdown(java.lang.String templateId,
                                          java.lang.String keyValuesJson)

从消息模版发送 Markdown 消息

Parameters:

templateId - markdown 模版id，申请模版后获得

keyValuesJson - {key: xxx, values: xxx}，模版内变量与填充值的kv映射

addTemplateMarkdown

public MessageBuilder addTemplateMarkdown(java.lang.String templateId,
                                          com.google.gson.JsonArray keyValues)

从消息模版发送 Markdown 消息

Parameters:

templateId - markdown 模版id，申请模版后获得

keyValues - {key: xxx, values: xxx}，模版内变量与填充值的kv映射

addTemplateMarkdown

public MessageBuilder addTemplateMarkdown(java.lang.String templateId,
                                          java.util.List<?> keyValues)

从消息模版发送 Markdown 消息

Parameters:

templateId - markdown 模版id，申请模版后获得

keyValues - {key: xxx, values: xxx}，模版内变量与填充值的kv映射

addCustomMarkdown

public MessageBuilder addCustomMarkdown(java.lang.String content)

自定义 markdown 消息

Parameters:

content - 原生 markdown 文本内容

addTemplateMarkdownButton

@Deprecated
public MessageBuilder addTemplateMarkdownButton(java.lang.String templateId)

Deprecated. 官方暂未支持根据模版发送 markdown 按钮消息（缺少字段）

从模版发送 Markdown 按钮消息

Parameters:

templateId - markdown 按钮模版id，申请按钮模版后获得

addCustomMarkdownButton

public MessageBuilder addCustomMarkdownButton(java.lang.String rowsJson,
                                              java.lang.String appId)

发送自定义 Markdown 按钮消息

Parameters:

rowsJson - 传入 rows 字段对应的值 "rows": [...]

addLinkedTextListArk

public MessageBuilder addLinkedTextListArk(java.lang.String desc,
                                           java.lang.String prompt,
                                           java.util.List<LinkedTextEntry> entryList)

发送 链接+文本列表模板 ark 消息

addSmallPicArk

public MessageBuilder addSmallPicArk(java.lang.String desc,
                                     java.lang.String prompt,
                                     java.lang.String title,
                                     java.lang.String metaDesc,
                                     java.lang.String img,
                                     java.lang.String link,
                                     java.lang.String subTitle)

Deprecated. 该模板不允许发送 url

发送 文本+缩略图模板 消息

Parameters:

desc - 描述

prompt - 提示文本

title - 标题

metaDesc - 详情描述

img - 图片链接

link - 跳转链接

subTitle - 来源

addBigPicArk

@Deprecated
public MessageBuilder addBigPicArk(java.lang.String prompt,
                                               java.lang.String metaTitle,
                                               java.lang.String metaSubTitle,
                                               java.lang.String metaCover,
                                               java.lang.String metaAurl)

Deprecated. 该模板不允许发送 url

发送 大图模板 消息

Parameters:

prompt - 提示消息

metaTitle - 标题

metaSubTitle - 子标题

metaCover - 大图，尺寸为 975*540

metaAurl - 跳转链接

addArk

public MessageBuilder addArk(int templateId,
                             com.google.gson.JsonArray keyValues)

发送 ark 消息

Parameters:

templateId - 模版 id，管理端可获得或内邀申请获得。以下默认可使用：
- 23 链接+文本列表模板 addLinkedTextListArk(String, String, List)
- 24 文本+缩略图模板
- 37 大图模板

keyValues - {key: xxx, value: xxx}，模版内变量与填充值的kv映射

addArk

public MessageBuilder addArk(int templateId,
                             java.util.List<?> keyValues)

发送 ark 消息

Parameters:

templateId - 模版 id，管理端可获得或内邀申请获得。以下默认可使用：
- 23 链接+文本列表模板 addLinkedTextListArk(String, String, List)
- 24 文本+缩略图模板
- 37 大图模板

keyValues - {key: xxx, value: xxx}，模版内变量与填充值的kv映射

addMedia

public MessageBuilder addMedia(java.lang.String fileInfo)

setPassive

public MessageBuilder setPassive(java.lang.String msgId)

设置为被动消息

Parameters:

msgId - 前置收到的用户发送过来的消息 ID，用于发送被动消息（回复）

setPassive

public MessageBuilder setPassive(java.lang.String msgId,
                                 @Nullable
                                 @Nullable java.lang.Integer msgSeq)

设置为被动消息

Parameters:

msgId - 前置收到的用户发送过来的消息 ID，用于发送被动消息（回复）

msgSeq - 回复消息的序号，与 msg_id 联合使用，避免相同消息id回复重复发送，不填默认是 1。相同的 msg_id + msg_seq 重复发送会失败。

addMessage

public MessageBuilder addMessage(Message message)

添加消息实体

build

public Message build()

构建消息