cn.evole.onebot.sdk.util

类 MsgUtils

java.lang.Object

cn.evole.onebot.sdk.util.MsgUtils

public class MsgUtils
extends java.lang.Object

Description: Author: cnlimiter Date: 2022/9/14 13:48 Version: 1.0

构造器概要

构造器

构造器和说明
MsgUtils()

方法概要

限定符和类型	方法和说明
MsgUtils	at(long userId) at 某人
MsgUtils	atAll() at 全体成员
java.lang.String	build() 构建消息链
static MsgUtils	builder() 消息构建
MsgUtils	cardImage(java.lang.String file) 一种 xml 的图片消息 xml 接口的消息都存在风控风险, 请自行兼容发送失败后的处理 ( 可以失败后走普通图片模式 )
MsgUtils	cardImage(java.lang.String file, long minWidth, long minHeight, long maxWidth, long maxHeight, java.lang.String source, java.lang.String icon) 一种 xml 的图片消息 xml 接口的消息都存在风控风险, 请自行兼容发送失败后的处理 ( 可以失败后走普通图片模式 )
MsgUtils	customMusic(java.lang.String url, java.lang.String audio, java.lang.String title) 音乐自定义分享
MsgUtils	customMusic(java.lang.String url, java.lang.String audio, java.lang.String title, java.lang.String content, java.lang.String image) 音乐自定义分享
MsgUtils	face(int id) QQ 表情 对照表
MsgUtils	flashImg(java.lang.String img) 闪照
MsgUtils	gift(long userId, int giftId) 礼物 仅支持免费礼物, 发送群礼物消息 无法撤回, 返回的 message id 恒定为 0
MsgUtils	img(OneBotMedia img) 图片
MsgUtils	img(java.lang.String url) 图片
MsgUtils	json(java.lang.String data) JSON 消息
MsgUtils	json(java.lang.String data, int resId) JSON 消息
MsgUtils	music(java.lang.String type, long id) 音乐分享
MsgUtils	poke(long userId) 戳一戳
MsgUtils	record(java.lang.String record) 语音
MsgUtils	reply(int msgId) 回复
MsgUtils	reply(java.lang.String msgId) 回复-频道
MsgUtils	rps(int value) 发送猜拳消息
MsgUtils	text(java.lang.String text) 文本内容
MsgUtils	tts(java.lang.String text) 文本转语音 通过腾讯的 TTS 接口, 采用的音源与登录账号的性别有关
MsgUtils	video(java.lang.String video, java.lang.String cover) 短视频
MsgUtils	xml(java.lang.String data) XML 消息
MsgUtils	xml(java.lang.String data, int resId) XML 消息

从类继承的方法 java.lang.Object

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

构造器详细资料

MsgUtils

public MsgUtils()

方法详细资料

builder

public static MsgUtils builder()

消息构建

返回:

MsgUtils

text

public MsgUtils text(java.lang.String text)

文本内容

参数:

text - 内容

返回:

String

img

public MsgUtils img(java.lang.String url)

图片

参数:

url - 图片 URL

返回:

String

img

public MsgUtils img(OneBotMedia img)

图片

参数:

img - OneBotMedia

返回:

String

video

public MsgUtils video(java.lang.String video,
                      java.lang.String cover)

短视频

参数:

video - 视频地址, 支持 http 和 file 发送

cover - 视频封面, 支持 http, file 和 base64 发送, 格式必须为 jpg

返回:

String

flashImg

public MsgUtils flashImg(java.lang.String img)

闪照

参数:

img - 图片

返回:

String

face

public MsgUtils face(int id)

QQ 表情 对照表

参数:

id - QQ 表情 ID

返回:

String

record

public MsgUtils record(java.lang.String record)

语音

参数:

record - 语音文件名

返回:

String

at

public MsgUtils at(long userId)

at 某人

参数:

userId - at 的 QQ 号, all 表示全体成员

返回:

String

atAll

public MsgUtils atAll()

at 全体成员

返回:

String

poke

public MsgUtils poke(long userId)

戳一戳

参数:

userId - 需要戳的成员

返回:

String

reply

public MsgUtils reply(int msgId)

回复

参数:

msgId - 回复时所引用的消息 id, 必须为本群消息.

返回:

String

reply

public MsgUtils reply(java.lang.String msgId)

回复-频道

参数:

msgId - 回复时所引用的消息 id, 必须为本频道消息.

返回:

String

gift

public MsgUtils gift(long userId,
                     int giftId)

礼物 仅支持免费礼物, 发送群礼物消息 无法撤回, 返回的 message id 恒定为 0

参数:

userId - 接收礼物的成员

giftId - 礼物的类型

返回:

String

tts

public MsgUtils tts(java.lang.String text)

文本转语音 通过腾讯的 TTS 接口, 采用的音源与登录账号的性别有关

参数:

text - 内容

返回:

String

xml

public MsgUtils xml(java.lang.String data)

XML 消息

参数:

data - xml内容, xml 中的 value 部分, 记得实体化处理

返回:

String

xml

public MsgUtils xml(java.lang.String data,
                    int resId)

XML 消息

参数:

data - xml 内容, xml 中的 value部分, 记得实体化处理

resId - 可以不填

返回:

String

json

public MsgUtils json(java.lang.String data)

JSON 消息

参数:

data - json 内容, json 的所有字符串记得实体化处理

返回:

String

json

public MsgUtils json(java.lang.String data,
                     int resId)

JSON 消息

参数:

data - json 内容, json 的所有字符串记得实体化处理

resId - 默认不填为 0, 走小程序通道, 填了走富文本通道发送

返回:

String

cardImage

public MsgUtils cardImage(java.lang.String file)

一种 xml 的图片消息 xml 接口的消息都存在风控风险, 请自行兼容发送失败后的处理 ( 可以失败后走普通图片模式 )

参数:

file - 和 image 的 file 字段对齐, 支持也是一样的

返回:

String

cardImage

public MsgUtils cardImage(java.lang.String file,
                          long minWidth,
                          long minHeight,
                          long maxWidth,
                          long maxHeight,
                          java.lang.String source,
                          java.lang.String icon)

一种 xml 的图片消息 xml 接口的消息都存在风控风险, 请自行兼容发送失败后的处理 ( 可以失败后走普通图片模式 )

参数:

file - 和 image 的 file 字段对齐, 支持也是一样的

minWidth - 默认不填为 400, 最小 width

minHeight - 默认不填为 400, 最小 height

maxWidth - 默认不填为 500, 最大 width

maxHeight - 默认不填为 1000, 最大 height

source - 分享来源的名称, 可以留空

icon - 分享来源的 icon 图标 url, 可以留空

返回:

String

music

public MsgUtils music(java.lang.String type,
                      long id)

音乐分享

参数:

type - qq 163 xm (分别表示使用 QQ 音乐、网易云音乐、虾米音乐)

id - 歌曲 ID

返回:

String

customMusic

public MsgUtils customMusic(java.lang.String url,
                            java.lang.String audio,
                            java.lang.String title,
                            java.lang.String content,
                            java.lang.String image)

音乐自定义分享

参数:

url - 点击后跳转目标 URL

audio - 音乐 URL

title - 标题

content - 发送时可选，内容描述

image - 发送时可选，图片 URL

返回:

String

customMusic

public MsgUtils customMusic(java.lang.String url,
                            java.lang.String audio,
                            java.lang.String title)

音乐自定义分享

参数:

url - 点击后跳转目标 URL

audio - 音乐 URL

title - 标题

返回:

String

rps

public MsgUtils rps(int value)

发送猜拳消息

参数:

value - 0石头 1剪刀 2布

返回:

String

build

public java.lang.String build()

构建消息链

返回:

String