Package top.mrxiaom.overflow
Interface OverflowAPI
-
- All Implemented Interfaces:
public interface OverflowAPI
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classOverflowAPI.Companion
-
Method Summary
Modifier and Type Method Description abstract ImageimageFromFile(String file)以 Onebot 格式新建图片消息另请参见 Onebot file 参数说明 abstract AudioaudioFromFile(String file)以 Onebot 格式新建语音消息另请参见 Onebot file 参数说明 abstract ShortVideovideoFromFile(String file)以 Onebot 格式新建短视频消息另请参见 Onebot file 参数说明 StringserializeMessage(Message message)序列化 mirai 格式消息为 Onebot 格式 json 消息段 abstract StringserializeMessage(RemoteBot bot, Message message)序列化 mirai 格式消息为 Onebot 格式 json 消息段 abstract StringserializeJsonToCQCode(String messageJson)序列化 Onebot 格式 json 消息段为 CQ 码 abstract StringserializeCQCodeToJson(String messageCQCode)序列化 Onebot 格式 CQ 码 为 json 消息段 abstract MessageChaindeserializeMessage(Bot bot, String message)反序列化 Onebot 格式 json 消息段或 CQ 码,反序列化为 mirai 格式消息 abstract MessageChaindeserializeMessageFromJson(Bot bot, String message)反序列化 json 消息段为 mirai 格式消息 abstract MessageChaindeserializeMessageFromCQCode(Bot bot, String message)反序列化 CQ 码 为 mirai 格式消息 abstract UnitconfigureMessageCache(Boolean enabled, File saveDir, Duration keepDuration)配置消息自动缓存选项,传入 null 的值不会被修改 abstract StringgetVersion()Overflow 版本号 abstract IBotStartergetBotStarter()-
-
Method Detail
-
imageFromFile
abstract Image imageFromFile(String file)
以 Onebot 格式新建图片消息
另请参见 Onebot file 参数说明
-
audioFromFile
abstract Audio audioFromFile(String file)
以 Onebot 格式新建语音消息
另请参见 Onebot file 参数说明
-
videoFromFile
abstract ShortVideo videoFromFile(String file)
以 Onebot 格式新建短视频消息
另请参见 Onebot file 参数说明
-
serializeMessage
@Deprecated(message = "Please use serializeMessage(bot, message)", replaceWith = @ReplaceWith(imports = {}, expression = "serializeMessage(bot, message)")) String serializeMessage(Message message)
序列化 mirai 格式消息为 Onebot 格式 json 消息段
-
serializeMessage
abstract String serializeMessage(RemoteBot bot, Message message)
序列化 mirai 格式消息为 Onebot 格式 json 消息段
-
serializeJsonToCQCode
abstract String serializeJsonToCQCode(String messageJson)
序列化 Onebot 格式 json 消息段为 CQ 码
-
serializeCQCodeToJson
abstract String serializeCQCodeToJson(String messageCQCode)
序列化 Onebot 格式 CQ 码 为 json 消息段
-
deserializeMessage
abstract MessageChain deserializeMessage(Bot bot, String message)
反序列化 Onebot 格式 json 消息段或 CQ 码,反序列化为 mirai 格式消息
-
deserializeMessageFromJson
abstract MessageChain deserializeMessageFromJson(Bot bot, String message)
反序列化 json 消息段为 mirai 格式消息
-
deserializeMessageFromCQCode
abstract MessageChain deserializeMessageFromCQCode(Bot bot, String message)
反序列化 CQ 码 为 mirai 格式消息
-
configureMessageCache
abstract Unit configureMessageCache(Boolean enabled, File saveDir, Duration keepDuration)
配置消息自动缓存选项,传入 null 的值不会被修改
- Parameters:
enabled- 是否启用媒体消息(图片、语音、视频)缓存。saveDir- 缓存文件夹路径。keepDuration- 缓存文件保存时间。在收到消息时,文件将会自动清理。
-
getVersion
abstract String getVersion()
Overflow 版本号
-
getBotStarter
abstract IBotStarter getBotStarter()
-
-
-
-