Interface IMessageApi code

命名空间: Another_Mirai_Native.Abstractions.Services

程序集: Another-Mirai-Native.Abstractions.dll

发送消息相关的接口，提供发送私聊消息、群聊消息和撤回消息的方法。

public interface IMessageApi

方法

DeleteMessage(long) code

撤回消息

bool DeleteMessage(long messageId)

参数

messageId long: 通过发送消息接口返回的消息ID

返回值

bool: 消息撤回成功与否

DeleteMessageAsync(long) code

异步撤回消息

Task<bool> DeleteMessageAsync(long messageId)

参数

messageId long: 通过发送消息接口返回的消息ID

返回值

Task<bool>: 消息撤回成功与否

GetChatHistories(long, long, int) code

检索指定来源的聊天记录历史。

List<ChatHistory> GetChatHistories(long groupId, long qq, int count)

参数

groupId long: 从中检索聊天记录的群组唯一标识符。
qq long: 要检索其聊天记录的用户唯一标识符。
count int: 要返回的聊天记录条目的最大数量。必须是正整数。

返回值

List<ChatHistory>: 表示指定群组和用户聊天记录的 ChatHistory 对象列表。如果未找到聊天记录，则列表为空。

备注

确保提供的 groupId 和 qq 对应有效的群组和用户标识符。若只是查询私聊记录，请将 groupId 设置为 0，并使用 qq 参数指定用户标识符。

GetChatHistoriesAsync(long, long, int) code

异步检索指定来源的聊天记录历史。

Task<List<ChatHistory>> GetChatHistoriesAsync(long groupId, long qq, int count)

参数

groupId long: 从中检索聊天记录的群组唯一标识符。
qq long: 要检索其聊天记录的用户唯一标识符。
count int: 要返回的聊天记录条目的最大数量。必须是正整数。

返回值

Task<List<ChatHistory>>: 表示指定群组和用户聊天记录的 ChatHistory 对象列表。如果未找到聊天记录，则列表为空。

备注

确保提供的 groupId 和 qq 对应有效的群组和用户标识符。若只是查询私聊记录，请将 groupId 设置为 0，并使用 qq 参数指定用户标识符。

GetChatHistoryById(long, bool, int) code

通过消息ID检索聊天记录历史。未找到对应记录时返回 null。

ChatHistory? GetChatHistoryById(long parentId, bool isGroup, int messageId)

参数

parentId long: 关联的来源ID，可能是群号或是QQ
isGroup bool: 指示关联来源是否为群聊。如果是群聊则设置为 true；否则为 false。
messageId int: 通过发送消息接口返回的消息ID

返回值

ChatHistory

GetChatHistoryByIdAsync(long, bool, int) code

异步通过消息ID检索聊天记录历史。未找到对应记录时返回 null。

Task<ChatHistory?> GetChatHistoryByIdAsync(long parentId, bool isGroup, int messageId)

参数

parentId long: 关联的来源ID，可能是群号或是QQ
isGroup bool: 指示关联来源是否为群聊。如果是群聊则设置为 true；否则为 false。
messageId int: 通过发送消息接口返回的消息ID

返回值

Task<ChatHistory>: 对应的聊天记录，未找到时返回 null。

SendGroupForwardMessage(long, string[]) code

发送群聊合并转发消息

int SendGroupForwardMessage(long groupId, string[] message)

参数

groupId long: 目标群聊ID
message string[]: 将要发送的消息数组

返回值

int: 若发送成功则返回消息ID（根据不同的框架实现，可能会有负数），若发送失败则返回 0

SendGroupForwardMessageAsync(long, string[]) code

异步发送群聊合并转发消息

Task<int> SendGroupForwardMessageAsync(long groupId, string[] message)

参数

groupId long: 目标群聊ID
message string[]: 将要发送的消息数组

返回值

Task<int>: 若发送成功则返回消息ID（根据不同的框架实现，可能会有负数），若发送失败则返回 0

SendGroupMessage(long, string) code

发送群聊消息

int SendGroupMessage(long groupId, string message)

参数

groupId long: 目标群聊ID
message string: 将要发送的消息

返回值

int: 若发送成功则返回消息ID（根据不同的框架实现，可能会有负数），若发送失败则返回 0

SendGroupMessageAsync(long, string) code

异步发送群聊消息

Task<int> SendGroupMessageAsync(long groupId, string message)

参数

groupId long: 目标群聊ID
message string: 将要发送的消息

返回值

Task<int>: 若发送成功则返回消息ID（根据不同的框架实现，可能会有负数），若发送失败则返回 0

SendPrivateForwardMessage(long, string[]) code

发送私聊合并转发消息

int SendPrivateForwardMessage(long userId, string[] message)

参数

userId long: 目标QQ
message string[]: 将要发送的消息数组

返回值

int: 若发送成功则返回消息ID（根据不同的框架实现，可能会有负数），若发送失败则返回 0

SendPrivateForwardMessageAsync(long, string[]) code

异步发送私聊合并转发消息

Task<int> SendPrivateForwardMessageAsync(long userId, string[] message)

参数

userId long: 目标QQ
message string[]: 将要发送的消息数组

返回值

Task<int>: 若发送成功则返回消息ID（根据不同的框架实现，可能会有负数），若发送失败则返回 0

SendPrivateMessage(long, string) code

发送私聊消息

int SendPrivateMessage(long userId, string message)

参数

userId long: 目标QQ
message string: 将要发送的消息

返回值

int: 若发送成功则返回消息ID（根据不同的框架实现，可能会有负数），若发送失败则返回 0

SendPrivateMessageAsync(long, string) code

异步发送私聊消息

Task<int> SendPrivateMessageAsync(long userId, string message)

参数

userId long: 目标QQ
message string: 将要发送的消息

返回值

Task<int>: 若发送成功则返回消息ID（根据不同的框架实现，可能会有负数），若发送失败则返回 0

TryGetImageByHash(string) code

尝试通过图片 Hash 获取图片文件路径。

(bool Success, string FilePath) TryGetImageByHash(string hash)

参数

hash string: 图片元素中的 Hash 字段

返回值

(bool Success, string FilePath): 若成功则返回 true 和绝对路径，若失败则返回 false 和空字符串。

TryGetImageByHashAsync(string) code

尝试异步通过图片 Hash 获取图片文件路径。

Task<(bool Success, string FilePath)> TryGetImageByHashAsync(string hash)

参数

hash string: 图片元素中的 Hash 字段

返回值

Task<(bool Success, string FilePath)>: 若成功则返回 true 和绝对路径，若失败则返回 false 和空字符串。